mirror of
https://github.com/paperclipai/paperclip
synced 2026-05-15 03:17:09 +02:00
7f893ac4ec
## Thinking Path > - Paperclip orchestrates AI agents for zero-human companies > - Reliable execution depends on heartbeat routing, issue lifecycle semantics, telemetry, and a fast enough local verification loop to keep regressions visible > - The remaining commits on this branch were mostly server/runtime correctness fixes plus test and documentation follow-ups in that area > - Those changes are logically separate from the UI-focused issue-detail and workspace/navigation branches even when they touch overlapping issue APIs > - This pull request groups the execution reliability, heartbeat, telemetry, and tooling changes into one standalone branch > - The benefit is a focused review of the control-plane correctness work, including the follow-up fix that restored the implicit comment-reopen helpers after branch splitting ## What Changed - Hardened issue/heartbeat execution behavior, including self-review stage skipping, deferred mention wakes during active execution, stranded execution recovery, active-run scoping, assignee resolution, and blocked-to-todo wake resumption - Reduced noisy polling/logging overhead by trimming issue run payloads, compacting persisted run logs, silencing high-volume request logs, and capping heartbeat-run queries in dashboard/inbox surfaces - Expanded telemetry and status semantics with adapter/model fields on task completion plus clearer status guidance in docs/onboarding material - Updated test infrastructure and verification defaults with faster route-test module isolation, cheaper default `pnpm test`, e2e isolation from local state, and repo verification follow-ups - Included docs/release housekeeping from the branch and added a small follow-up commit restoring the implicit comment-reopen helpers that were dropped during branch reconstruction ## Verification - `pnpm vitest run server/src/__tests__/issue-comment-reopen-routes.test.ts server/src/__tests__/issue-telemetry-routes.test.ts` - `pnpm vitest run server/src/__tests__/http-log-policy.test.ts server/src/__tests__/heartbeat-run-log.test.ts server/src/__tests__/health.test.ts` - `server/src/__tests__/activity-service.test.ts`, `server/src/__tests__/heartbeat-comment-wake-batching.test.ts`, and `server/src/__tests__/heartbeat-process-recovery.test.ts` were attempted on this host but the embedded Postgres harness reported init-script/data-dir problems and skipped or failed to start, so they are noted as environment-limited ## Risks - Medium: this branch changes core issue/heartbeat routing and reopen/wakeup behavior, so regressions would affect agent execution flow rather than isolated UI polish - Because it also updates verification infrastructure, reviewers should pay attention to whether the new tests are asserting the right failure modes and not just reshaping harness behavior ## Model Used - OpenAI Codex coding agent (GPT-5-class runtime in Codex CLI; exact deployed model ID is not exposed in this environment), reasoning enabled, tool use and local code execution enabled ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [ ] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [ ] If this change affects the UI, I have included before/after screenshots - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
148 lines
2.7 KiB
Markdown
148 lines
2.7 KiB
Markdown
---
|
|
title: Agents
|
|
summary: Agent lifecycle, configuration, keys, and heartbeat invocation
|
|
---
|
|
|
|
Manage AI agents (employees) within a company.
|
|
|
|
## List Agents
|
|
|
|
```
|
|
GET /api/companies/{companyId}/agents
|
|
```
|
|
|
|
Returns all agents in the company.
|
|
|
|
This route does not accept query filters. Unsupported query parameters return `400`.
|
|
|
|
## Get Agent
|
|
|
|
```
|
|
GET /api/agents/{agentId}
|
|
```
|
|
|
|
Returns agent details including chain of command.
|
|
|
|
## Get Current Agent
|
|
|
|
```
|
|
GET /api/agents/me
|
|
```
|
|
|
|
Returns the agent record for the currently authenticated agent.
|
|
|
|
**Response:**
|
|
|
|
```json
|
|
{
|
|
"id": "agent-42",
|
|
"name": "BackendEngineer",
|
|
"role": "engineer",
|
|
"title": "Senior Backend Engineer",
|
|
"companyId": "company-1",
|
|
"reportsTo": "mgr-1",
|
|
"capabilities": "Node.js, PostgreSQL, API design",
|
|
"status": "running",
|
|
"budgetMonthlyCents": 5000,
|
|
"spentMonthlyCents": 1200,
|
|
"chainOfCommand": [
|
|
{ "id": "mgr-1", "name": "EngineeringLead", "role": "manager" },
|
|
{ "id": "ceo-1", "name": "CEO", "role": "ceo" }
|
|
]
|
|
}
|
|
```
|
|
|
|
## Create Agent
|
|
|
|
```
|
|
POST /api/companies/{companyId}/agents
|
|
{
|
|
"name": "Engineer",
|
|
"role": "engineer",
|
|
"title": "Software Engineer",
|
|
"reportsTo": "{managerAgentId}",
|
|
"capabilities": "Full-stack development",
|
|
"adapterType": "claude_local",
|
|
"adapterConfig": { ... }
|
|
}
|
|
```
|
|
|
|
## Update Agent
|
|
|
|
```
|
|
PATCH /api/agents/{agentId}
|
|
{
|
|
"adapterConfig": { ... },
|
|
"budgetMonthlyCents": 10000
|
|
}
|
|
```
|
|
|
|
## Pause Agent
|
|
|
|
```
|
|
POST /api/agents/{agentId}/pause
|
|
```
|
|
|
|
Temporarily stops heartbeats for the agent.
|
|
|
|
## Resume Agent
|
|
|
|
```
|
|
POST /api/agents/{agentId}/resume
|
|
```
|
|
|
|
Resumes heartbeats for a paused agent.
|
|
|
|
## Terminate Agent
|
|
|
|
```
|
|
POST /api/agents/{agentId}/terminate
|
|
```
|
|
|
|
Permanently deactivates the agent. **Irreversible.**
|
|
|
|
## Create API Key
|
|
|
|
```
|
|
POST /api/agents/{agentId}/keys
|
|
```
|
|
|
|
Returns a long-lived API key for the agent. Store it securely — the full value is only shown once.
|
|
|
|
## Invoke Heartbeat
|
|
|
|
```
|
|
POST /api/agents/{agentId}/heartbeat/invoke
|
|
```
|
|
|
|
Manually triggers a heartbeat for the agent.
|
|
|
|
## Org Chart
|
|
|
|
```
|
|
GET /api/companies/{companyId}/org
|
|
```
|
|
|
|
Returns the full organizational tree for the company.
|
|
|
|
## List Adapter Models
|
|
|
|
```
|
|
GET /api/companies/{companyId}/adapters/{adapterType}/models
|
|
```
|
|
|
|
Returns selectable models for an adapter type.
|
|
|
|
- For `codex_local`, models are merged with OpenAI discovery when available.
|
|
- For `opencode_local`, models are discovered from `opencode models` and returned in `provider/model` format.
|
|
- `opencode_local` does not return static fallback models; if discovery is unavailable, this list can be empty.
|
|
|
|
## Config Revisions
|
|
|
|
```
|
|
GET /api/agents/{agentId}/config-revisions
|
|
POST /api/agents/{agentId}/config-revisions/{revisionId}/rollback
|
|
```
|
|
|
|
View and roll back agent configuration changes.
|