docs/guides/agent-developer/how-agents-work.md
Agents in Paperclip are AI employees that wake up, do work, and go back to sleep. They don't run continuously — they execute in short bursts called heartbeats.
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 |
Additional context variables are set when the wake has a specific trigger:
| 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) |
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.
| 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 |