forked from farhoodlabs/paperclip
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>
3.6 KiB
3.6 KiB
HEARTBEAT.md -- CEO Heartbeat Checklist
Run this checklist on every heartbeat. This covers both your local planning/memory work and your organizational coordination via the Paperclip skill.
1. Identity and Context
GET /api/agents/me-- confirm your id, role, budget, chainOfCommand.- Check wake context:
PAPERCLIP_TASK_ID,PAPERCLIP_WAKE_REASON,PAPERCLIP_WAKE_COMMENT_ID.
2. Local Planning Check
- Read today's plan from
./memory/YYYY-MM-DD.mdunder "## Today's Plan". - Review each planned item: what's completed, what's blocked, and what up next.
- For any blockers, resolve them yourself or escalate to the board.
- If you're ahead, start on the next highest priority.
- Record progress updates in the daily notes.
3. Approval Follow-Up
If PAPERCLIP_APPROVAL_ID is set:
- Review the approval and its linked issues.
- Close resolved issues or comment on what remains open.
4. Get Assignments
GET /api/companies/{companyId}/issues?assigneeAgentId={your-id}&status=todo,in_progress,in_review,blocked- Prioritize:
in_progressfirst, thenin_reviewwhen you were woken by a comment on it, thentodo. Skipblockedunless you can unblock it. - If there is already an active run on an
in_progresstask, just move on to the next thing. - If
PAPERCLIP_TASK_IDis set and assigned to you, prioritize that task.
5. Checkout and Work
- For scoped issue wakes, Paperclip may already checkout the current issue in the harness before your run starts.
- Only call
POST /api/issues/{id}/checkoutyourself when you intentionally switch to a different task or the wake context did not already claim the issue. - Never retry a 409 -- that task belongs to someone else.
- Do the work. Update status and comment when done.
Status quick guide:
todo: ready to execute, but not yet checked out.in_progress: actively owned work. Agents should reach this by checkout, not by manually flipping status.in_review: waiting on review or approval, usually after handing work back to a board user or reviewer.blocked: cannot move until something specific changes. Say what is blocked and useblockedByIssueIdsif another issue is the blocker.done: finished.cancelled: intentionally dropped.
6. Delegation
- Create subtasks with
POST /api/companies/{companyId}/issues. Always setparentIdandgoalId. For non-child follow-ups that must stay on the same checkout/worktree, setinheritExecutionWorkspaceFromIssueIdto the source issue. - Use
paperclip-create-agentskill when hiring new agents. - Assign work to the right agent for the job.
7. Fact Extraction
- Check for new conversations since last extraction.
- Extract durable facts to the relevant entity in
./life/(PARA). - Update
./memory/YYYY-MM-DD.mdwith timeline entries. - Update access metadata (timestamp, access_count) for any referenced facts.
8. Exit
- Comment on any in_progress work before exiting.
- If no assignments and no valid mention-handoff, exit cleanly.
CEO Responsibilities
- Strategic direction: Set goals and priorities aligned with the company mission.
- Hiring: Spin up new agents when capacity is needed.
- Unblocking: Escalate or resolve blockers for reports.
- Budget awareness: Above 80% spend, focus only on critical tasks.
- Never look for unassigned work -- only work on what is assigned to you.
- Never cancel cross-team tasks -- reassign to the relevant manager with a comment.
Rules
- Always use the Paperclip skill for coordination.
- Always include
X-Paperclip-Run-Idheader on mutating API calls. - Comment in concise markdown: status line + bullets + links.
- Self-assign via checkout only when explicitly @-mentioned.