236d11d36f
## Thinking Path > - Paperclip orchestrates AI agents for zero-human companies. > - Heartbeat runs are the control-plane record of each agent execution window. > - Long-running local agents can exhaust context or stop while still holding useful next-step state. > - Operators need that stop reason, next action, and continuation path to be durable and visible. > - This pull request adds run liveness metadata, continuation summaries, and UI surfaces for issue run ledgers. > - The benefit is that interrupted or long-running work can resume with clearer context instead of losing the agent's last useful handoff. ## What Changed - Added heartbeat-run liveness fields, continuation attempt tracking, and an idempotent `0058` migration. - Added server services and tests for run liveness, continuation summaries, stop metadata, and activity backfill. - Wired local and HTTP adapters to surface continuation/liveness context through shared adapter utilities. - Added shared constants, validators, and heartbeat types for liveness continuation state. - Added issue-detail UI surfaces for continuation handoffs and the run ledger, with component tests. - Updated agent runtime docs, heartbeat protocol docs, prompt guidance, onboarding assets, and skills instructions to explain continuation behavior. - Addressed Greptile feedback by scoping document evidence by run, excluding system continuation-summary documents from liveness evidence, importing shared liveness types, surfacing hidden ledger run counts, documenting bounded retry behavior, and moving run-ledger liveness backfill off the request path. ## Verification - `pnpm exec vitest run packages/adapter-utils/src/server-utils.test.ts server/src/__tests__/run-continuations.test.ts server/src/__tests__/run-liveness.test.ts server/src/__tests__/activity-service.test.ts server/src/__tests__/documents-service.test.ts server/src/__tests__/issue-continuation-summary.test.ts server/src/services/heartbeat-stop-metadata.test.ts ui/src/components/IssueRunLedger.test.tsx ui/src/components/IssueContinuationHandoff.test.tsx ui/src/components/IssueDocumentsSection.test.tsx` - `pnpm --filter @paperclipai/db build` - `pnpm exec vitest run server/src/__tests__/activity-service.test.ts ui/src/components/IssueRunLedger.test.tsx` - `pnpm --filter @paperclipai/ui typecheck` - `pnpm --filter @paperclipai/server typecheck` - `pnpm exec vitest run server/src/__tests__/activity-service.test.ts server/src/__tests__/run-continuations.test.ts ui/src/components/IssueRunLedger.test.tsx` - `pnpm exec vitest run server/src/__tests__/heartbeat-process-recovery.test.ts -t "treats a plan document update"` - `pnpm exec vitest run server/src/__tests__/activity-service.test.ts server/src/__tests__/heartbeat-process-recovery.test.ts -t "activity service|treats a plan document update"` - Remote PR checks on head `e53b1a1d`: `verify`, `e2e`, `policy`, and Snyk all passed. - Confirmed `public-gh/master` is an ancestor of this branch after fetching `public-gh master`. - Confirmed `pnpm-lock.yaml` is not included in the branch diff. - Confirmed migration `0058_wealthy_starbolt.sql` is ordered after `0057` and uses `IF NOT EXISTS` guards for repeat application. - Greptile inline review threads are resolved. ## Risks - Medium risk: this touches heartbeat execution, liveness recovery, activity rendering, issue routes, shared contracts, docs, and UI. - Migration risk is mitigated by additive columns/indexes and idempotent guards. - Run-ledger liveness backfill is now asynchronous, so the first ledger response can briefly show historical missing liveness until the background backfill completes. - UI screenshot coverage is not included in this packaging pass; validation is currently through focused component tests. > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected — check the roadmap first. See `CONTRIBUTING.md`. ## Model Used - OpenAI Codex, GPT-5.4, local tool-use coding agent with terminal, git, GitHub connector, GitHub CLI, and Paperclip API access. ## 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) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [x] 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 Screenshot note: no before/after screenshots were captured in this PR packaging pass; the UI changes are covered by focused component tests listed above. --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
145 lines
5.6 KiB
Markdown
145 lines
5.6 KiB
Markdown
---
|
|
name: paperclip-create-agent
|
|
description: >
|
|
Create new agents in Paperclip with governance-aware hiring. Use when you need
|
|
to inspect adapter configuration options, compare existing agent configs,
|
|
draft a new agent prompt/config, and submit a hire request.
|
|
---
|
|
|
|
# Paperclip Create Agent Skill
|
|
|
|
Use this skill when you are asked to hire/create an agent.
|
|
|
|
## Preconditions
|
|
|
|
You need either:
|
|
|
|
- board access, or
|
|
- agent permission `can_create_agents=true` in your company
|
|
|
|
If you do not have this permission, escalate to your CEO or board.
|
|
|
|
## Workflow
|
|
|
|
1. Confirm identity and company context.
|
|
|
|
```sh
|
|
curl -sS "$PAPERCLIP_API_URL/api/agents/me" \
|
|
-H "Authorization: Bearer $PAPERCLIP_API_KEY"
|
|
```
|
|
|
|
2. Discover available adapter configuration docs for this Paperclip instance.
|
|
|
|
```sh
|
|
curl -sS "$PAPERCLIP_API_URL/llms/agent-configuration.txt" \
|
|
-H "Authorization: Bearer $PAPERCLIP_API_KEY"
|
|
```
|
|
|
|
3. Read adapter-specific docs (example: `claude_local`).
|
|
|
|
```sh
|
|
curl -sS "$PAPERCLIP_API_URL/llms/agent-configuration/claude_local.txt" \
|
|
-H "Authorization: Bearer $PAPERCLIP_API_KEY"
|
|
```
|
|
|
|
4. Compare existing agent configurations in your company.
|
|
|
|
```sh
|
|
curl -sS "$PAPERCLIP_API_URL/api/companies/$PAPERCLIP_COMPANY_ID/agent-configurations" \
|
|
-H "Authorization: Bearer $PAPERCLIP_API_KEY"
|
|
```
|
|
|
|
5. Discover allowed agent icons and pick one that matches the role.
|
|
|
|
```sh
|
|
curl -sS "$PAPERCLIP_API_URL/llms/agent-icons.txt" \
|
|
-H "Authorization: Bearer $PAPERCLIP_API_KEY"
|
|
```
|
|
|
|
6. Draft the new hire config:
|
|
- role/title/name
|
|
- icon (required in practice; use one from `/llms/agent-icons.txt`)
|
|
- reporting line (`reportsTo`)
|
|
- adapter type
|
|
- optional `desiredSkills` from the company skill library when this role needs installed skills on day one
|
|
- adapter and runtime config aligned to this environment
|
|
- leave timer heartbeats off by default; only set `runtimeConfig.heartbeat.enabled=true` with an `intervalSec` when the role genuinely needs scheduled recurring work or the user explicitly asked for it
|
|
- capabilities
|
|
- run prompt in adapter config (`promptTemplate` where applicable). For coding or execution agents, include the Paperclip execution contract: start actionable work in the same heartbeat; do not stop at a plan unless planning was requested; leave durable progress with a clear next action; use child issues for long or parallel delegated work instead of polling; mark blocked work with owner/action; respect budget, pause/cancel, approval gates, and company boundaries.
|
|
- source issue linkage (`sourceIssueId` or `sourceIssueIds`) when this hire came from an issue
|
|
|
|
7. Submit hire request.
|
|
|
|
```sh
|
|
curl -sS -X POST "$PAPERCLIP_API_URL/api/companies/$PAPERCLIP_COMPANY_ID/agent-hires" \
|
|
-H "Authorization: Bearer $PAPERCLIP_API_KEY" \
|
|
-H "Content-Type: application/json" \
|
|
-d '{
|
|
"name": "CTO",
|
|
"role": "cto",
|
|
"title": "Chief Technology Officer",
|
|
"icon": "crown",
|
|
"reportsTo": "<ceo-agent-id>",
|
|
"capabilities": "Owns technical roadmap, architecture, staffing, execution",
|
|
"desiredSkills": ["vercel-labs/agent-browser/agent-browser"],
|
|
"adapterType": "codex_local",
|
|
"adapterConfig": {"cwd": "/abs/path/to/repo", "model": "o4-mini"},
|
|
"runtimeConfig": {"heartbeat": {"enabled": false, "wakeOnDemand": true}},
|
|
"sourceIssueId": "<issue-id>"
|
|
}'
|
|
```
|
|
|
|
8. Handle governance state:
|
|
- if response has `approval`, hire is `pending_approval`
|
|
- monitor and discuss on approval thread
|
|
- when the board approves, you will be woken with `PAPERCLIP_APPROVAL_ID`; read linked issues and close/comment follow-up
|
|
|
|
```sh
|
|
curl -sS "$PAPERCLIP_API_URL/api/approvals/<approval-id>" \
|
|
-H "Authorization: Bearer $PAPERCLIP_API_KEY"
|
|
|
|
curl -sS -X POST "$PAPERCLIP_API_URL/api/approvals/<approval-id>/comments" \
|
|
-H "Authorization: Bearer $PAPERCLIP_API_KEY" \
|
|
-H "Content-Type: application/json" \
|
|
-d '{"body":"## CTO hire request submitted\n\n- Approval: [<approval-id>](/approvals/<approval-id>)\n- Pending agent: [<agent-ref>](/agents/<agent-url-key-or-id>)\n- Source issue: [<issue-ref>](/issues/<issue-identifier-or-id>)\n\nUpdated prompt and adapter config per board feedback."}'
|
|
```
|
|
|
|
If the approval already exists and needs manual linking to the issue:
|
|
|
|
```sh
|
|
curl -sS -X POST "$PAPERCLIP_API_URL/api/issues/<issue-id>/approvals" \
|
|
-H "Authorization: Bearer $PAPERCLIP_API_KEY" \
|
|
-H "Content-Type: application/json" \
|
|
-d '{"approvalId":"<approval-id>"}'
|
|
```
|
|
|
|
After approval is granted, run this follow-up loop:
|
|
|
|
```sh
|
|
curl -sS "$PAPERCLIP_API_URL/api/approvals/$PAPERCLIP_APPROVAL_ID" \
|
|
-H "Authorization: Bearer $PAPERCLIP_API_KEY"
|
|
|
|
curl -sS "$PAPERCLIP_API_URL/api/approvals/$PAPERCLIP_APPROVAL_ID/issues" \
|
|
-H "Authorization: Bearer $PAPERCLIP_API_KEY"
|
|
```
|
|
|
|
For each linked issue, either:
|
|
- close it if approval resolved the request, or
|
|
- comment in markdown with links to the approval and next actions.
|
|
|
|
## Quality Bar
|
|
|
|
Before sending a hire request:
|
|
|
|
- if the role needs skills, make sure they already exist in the company library or install them first using the Paperclip company-skills workflow
|
|
- Reuse proven config patterns from related agents where possible.
|
|
- Set a concrete `icon` from `/llms/agent-icons.txt` so the new hire is identifiable in org and task views.
|
|
- Avoid secrets in plain text unless required by adapter behavior.
|
|
- Ensure reporting line is correct and in-company.
|
|
- Ensure prompt is role-specific and operationally scoped.
|
|
- Keep timer heartbeats opt-in. Most hires should rely on assignment/on-demand wakeups unless the job explicitly needs a schedule.
|
|
- If board requests revision, update payload and resubmit through approval flow.
|
|
|
|
For endpoint payload shapes and full examples, read:
|
|
`skills/paperclip-create-agent/references/api-reference.md`
|