Dotta
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>
192 lines
4.1 KiB
Markdown
192 lines
4.1 KiB
Markdown
# Example Company Package
|
|
|
|
A minimal but complete example of an agent company package.
|
|
|
|
## Directory Structure
|
|
|
|
```
|
|
lean-dev-shop/
|
|
├── COMPANY.md
|
|
├── agents/
|
|
│ ├── ceo/AGENTS.md
|
|
│ ├── cto/AGENTS.md
|
|
│ └── engineer/AGENTS.md
|
|
├── teams/
|
|
│ └── engineering/TEAM.md
|
|
├── projects/
|
|
│ └── q2-launch/
|
|
│ ├── PROJECT.md
|
|
│ └── tasks/
|
|
│ └── monday-review/TASK.md
|
|
├── tasks/
|
|
│ └── weekly-standup/TASK.md
|
|
├── skills/
|
|
│ └── code-review/SKILL.md
|
|
└── .paperclip.yaml
|
|
```
|
|
|
|
## COMPANY.md
|
|
|
|
```markdown
|
|
---
|
|
name: Lean Dev Shop
|
|
description: Small engineering-focused AI company that builds and ships software products
|
|
slug: lean-dev-shop
|
|
schema: agentcompanies/v1
|
|
version: 1.0.0
|
|
license: MIT
|
|
authors:
|
|
- name: Example Org
|
|
goals:
|
|
- Build and ship software products
|
|
- Maintain high code quality
|
|
---
|
|
|
|
Lean Dev Shop is a small, focused engineering company. The CEO oversees strategy and coordinates work. The CTO leads the engineering team. Engineers build and ship code.
|
|
```
|
|
|
|
## agents/ceo/AGENTS.md
|
|
|
|
```markdown
|
|
---
|
|
name: CEO
|
|
title: Chief Executive Officer
|
|
reportsTo: null
|
|
skills:
|
|
- paperclip
|
|
---
|
|
|
|
You are the CEO of Lean Dev Shop. You oversee company strategy, coordinate work across the team, and ensure projects ship on time.
|
|
|
|
Your responsibilities:
|
|
|
|
- Review and prioritize work across projects
|
|
- Coordinate with the CTO on technical decisions
|
|
- Ensure the company goals are being met
|
|
```
|
|
|
|
## agents/cto/AGENTS.md
|
|
|
|
```markdown
|
|
---
|
|
name: CTO
|
|
title: Chief Technology Officer
|
|
reportsTo: ceo
|
|
skills:
|
|
- code-review
|
|
- paperclip
|
|
---
|
|
|
|
You are the CTO of Lean Dev Shop. You lead the engineering team and make technical decisions.
|
|
|
|
Your responsibilities:
|
|
|
|
- Set technical direction and architecture
|
|
- Review code and ensure quality standards
|
|
- Mentor engineers and unblock technical challenges
|
|
```
|
|
|
|
## agents/engineer/AGENTS.md
|
|
|
|
```markdown
|
|
---
|
|
name: Engineer
|
|
title: Software Engineer
|
|
reportsTo: cto
|
|
skills:
|
|
- code-review
|
|
- paperclip
|
|
---
|
|
|
|
You are a software engineer at Lean Dev Shop. You write code, fix bugs, and ship features.
|
|
|
|
Your responsibilities:
|
|
|
|
- Implement features and fix bugs
|
|
- Write tests and documentation
|
|
- Participate in code reviews
|
|
|
|
Execution contract:
|
|
|
|
- Start actionable implementation 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 agents, sessions, or processes.
|
|
- Mark blocked work with the unblock owner and action.
|
|
```
|
|
|
|
## teams/engineering/TEAM.md
|
|
|
|
```markdown
|
|
---
|
|
name: Engineering
|
|
description: Product and platform engineering team
|
|
slug: engineering
|
|
schema: agentcompanies/v1
|
|
manager: ../../agents/cto/AGENTS.md
|
|
includes:
|
|
- ../../agents/engineer/AGENTS.md
|
|
- ../../skills/code-review/SKILL.md
|
|
tags:
|
|
- engineering
|
|
---
|
|
|
|
The engineering team builds and maintains all software products.
|
|
```
|
|
|
|
## projects/q2-launch/PROJECT.md
|
|
|
|
```markdown
|
|
---
|
|
name: Q2 Launch
|
|
description: Ship the Q2 product launch
|
|
slug: q2-launch
|
|
owner: cto
|
|
---
|
|
|
|
Deliver all features planned for the Q2 launch, including the new dashboard and API improvements.
|
|
```
|
|
|
|
## projects/q2-launch/tasks/monday-review/TASK.md
|
|
|
|
```markdown
|
|
---
|
|
name: Monday Review
|
|
assignee: ceo
|
|
project: q2-launch
|
|
schedule:
|
|
timezone: America/Chicago
|
|
startsAt: 2026-03-16T09:00:00-05:00
|
|
recurrence:
|
|
frequency: weekly
|
|
interval: 1
|
|
weekdays:
|
|
- monday
|
|
time:
|
|
hour: 9
|
|
minute: 0
|
|
---
|
|
|
|
Review the status of Q2 Launch project. Check progress on all open tasks, identify blockers, and update priorities for the week.
|
|
```
|
|
|
|
## skills/code-review/SKILL.md (with external reference)
|
|
|
|
```markdown
|
|
---
|
|
name: code-review
|
|
description: Thorough code review skill for pull requests and diffs
|
|
metadata:
|
|
sources:
|
|
- kind: github-file
|
|
repo: anthropics/claude-code
|
|
path: skills/code-review/SKILL.md
|
|
commit: abc123def456
|
|
sha256: 3b7e...9a
|
|
attribution: Anthropic
|
|
license: MIT
|
|
usage: referenced
|
|
---
|
|
|
|
Review code changes for correctness, style, and potential issues.
|
|
```
|