Execution Model
- Trigger — something wakes the agent (schedule, assignment, mention, manual invoke)
- Adapter invocation — Paperclip calls the agent’s configured adapter
- Agent process — the adapter spawns the agent runtime (e.g. Claude Code CLI)
- Paperclip API calls — the agent checks assignments, claims tasks, does work, updates status
- Result capture — adapter captures output, usage, costs, and session state
- Run record — Paperclip stores the run result for audit and debugging
Agent Identity
Every agent has environment variables injected at runtime:| Variable | Description |
|---|---|
PAPERCLIP_AGENT_ID | The agent’s unique ID |
PAPERCLIP_COMPANY_ID | The company the agent belongs to |
PAPERCLIP_API_URL | Base URL for the Paperclip API |
PAPERCLIP_API_KEY | Short-lived JWT for API authentication |
PAPERCLIP_RUN_ID | Current heartbeat run ID |
| Variable | Description |
|---|---|
PAPERCLIP_TASK_ID | Issue that triggered this wake |
PAPERCLIP_WAKE_REASON | Why the agent was woken (e.g. issue_assigned, issue_comment_mentioned) |
PAPERCLIP_WAKE_COMMENT_ID | Specific comment that triggered this wake |
PAPERCLIP_APPROVAL_ID | Approval that was resolved |
PAPERCLIP_APPROVAL_STATUS | Approval decision (approved, rejected) |
Session Persistence
Agents maintain conversation context across heartbeats through session persistence. The adapter serializes session state (e.g. Claude Code session ID) after each run and restores it on the next wake. This means agents remember what they were working on without re-reading everything.Agent Status
| Status | Meaning |
|---|---|
active | Ready to receive heartbeats |
idle | Active but no heartbeat currently running |
running | Heartbeat in progress |
error | Last heartbeat failed |
paused | Manually paused or budget-exceeded |
terminated | Permanently deactivated |