Files
PaperClipAI/doc/SPEC.md
T
DottaandPaperclip 96bf004a79 fix: use persisted state for lifecycle continuation and retry budgets (#13888)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work.
> - Its control plane decides when a task can continue, wait, stop, or
complete.
> - Legacy continuation could change when an agent changed its wording
without changing task state.
> - Shared attempt counts also let repair and infrastructure retries
affect each other's limits.
> - This pull request uses persisted state and separate, bounded
allowances for these decisions.
> - If automatic repair stops, the task explains what happened and
offers a guarded retry.
> - Paired tests and real-provider evaluations verify that Stop,
approvals, ownership, and spending limits remain authoritative.

## Linked Issues or Issue Description

Related work: Refs #13761, Refs #11126, Refs #13610. These cover
obsolete continuation dispatch and retry storms. Open and closed issues
and PRs were searched for related lifecycle, continuation, and retry
work.

**What happened?**
Legacy continuation depended on English wording and progress heuristics.
Repair, failure retry, and productive continuation could consume shared
counts. When bounded repair stopped, the task showed a technical
recovery message without a clear next action.

**Expected behavior**
Persisted disposition and owned execution paths determine the next
action. Missing disposition prompts bounded agent repair. Explicit work
mode determines planning mode. Narrative changes and raw activity counts
cannot replenish allowances. An exhausted repair shows a readable
notice. An explicit retry checks current controls and preserves the
assigned agent.

**Steps to reproduce**
Run `pnpm test:lifecycle-baseline`. The paired probes keep structured
state constant while varying completion, planning, blocker, and progress
prose. Run the explicit `lifecycle-baseline` and
`continuation-accounting` Product E2E suites for real-provider coverage.
In Storybook, open **Design previews / Recovery notice** to inspect the
production component's normal, pending, acknowledged, unavailable,
failure, and mobile states.

## What Changed

- Hide the image attachment button, icon, and drop/paste hint in answer
composers. Image paste and drop support remains available.
- Merge current master and retain both browser regression sets. Use a
production-stamped service worker in the offline recovery browser
fixture.
- Share one state-based legacy continuation decision across immediate,
delayed, and recovered dispatch. Bind bounded repairs to their source
run and episode.
- Remove title and description wording from work-mode authority. Agents
can still write requested plans in execution mode.
- Persist separate failure-retry and productive-continuation counters.
Disposition repair and resource waits cannot consume or reset those
allowances.
- Validate delayed repair identity, then recheck current gates before
provider dispatch. Fence native startup cancellation.
- Show **Agent needs attention**, a plain-language explanation, **Retry
agent**, and expandable details in both task interfaces. Report request
progress, acknowledgement, and errors inline.
- Store typed recovery notice metadata. Recognize older active notices
only through exact stored action and run IDs. Notice text never grants
retry authority.
- Use the existing recovery-action endpoint for retry. Recheck current
action, status, owner, agent availability, dependencies, active runs,
pending questions and confirmations, approvals, pause controls, and
budget. Duplicate requests do not wake twice.
- Add component, page, route, database, contract, and Storybook
coverage. Keep the scenario inventory and executable evals here.
Historical reports and snapshots live in the [commit-pinned
paperclip-evals
archive](https://github.com/paperclipai/paperclip-evals/blob/ce3e5afcd4a1184650f586a2b5b8be5874c66c8b/experiments/2026-09-lifecycle-authority/README.md).
- Preserve unsaved project fields while the same project URL changes to
its canonical alias. Do not reuse data across projects or companies.
This separate fix addresses the repeated repository-editor browser
failure without changing the browser test.
- Keep the development service worker from intercepting Vite module
reloads. Update the connection-intent browser fixture to record progress
and completion through the agent API.

## Verification

Merge preparation on September 25, commit
`c1e8e4b7ddd9fbc4913ed55ce21b8e12906c2f97`:

- Merged master `bd2030932` and resolved the browser test-list conflict
by keeping both sets of regressions.
- Deterministic lifecycle baseline: 1,090/1,090 assertions passed; no
failures, skips, or missing selected evidence. Unit 423, runner 184,
database integration 397, grading 86.
- Browser support: 17/17 passed. The offline recovery test first failed
with an unstamped development worker, then passed with the production
stamp. Its assertions are unchanged.
- Focused interaction UI and offline fallback tests: 19/19 passed.
Verified the custom-answer composer in Storybook: no attachment controls
or hint; entering an answer enables Next.
- Recursive typecheck, production build, token gates, and diff checks
passed. The worktree is clean. No new real-provider campaign was run.
- Current CI and review: [Current PR CI
passed](https://github.com/paperclipai/paperclip/actions/runs/36166011243):
55 successful checks and two optional Storybook skips. Greptile scored
this exact commit 5/5. Hiding the question attachment controls is an
intentional UI change; paste/drop remains available.

Earlier recovery UI verification, commit
`21be0fec0e90e86b6d662b8ee4831847cd041cdb`:

- Recursive typecheck, production build, token gates, and diff checks
passed.
- Focused UI coverage: 338 tests passed across six suites (336 before
the interaction guard, with the two affected suites rerun at 149 passed
after it). Covers both task interfaces, the real page mutation,
pending/error acknowledgement, stale state, and unavailable controls.
- Recovery database integration: 352 tests passed before the interaction
guard. The complete recovery-action and mutation-route suites passed 181
tests after it. The two new pending question/confirmation regressions
failed before the fix and passed afterward, including
resolved-interaction controls. Shared validator suite: 31 passed. E2E
catalog suites: 34 passed.
- Browser inspection passed for light/dark themes, mobile layout,
expandable details, pending retry, acknowledgement, failure, and
disabled retry. Storybook renders the production component; its request
is simulated.
- The broad local run hit two chat callback-order wait failures and was
stopped after all CI unit/database/runner shards passed. Both local
failures passed when rerun without the competing full-suite process.
- CI exposed a repeated project-repository draft-loss race during
canonical redirects. A new unit regression failed before the fix; all
nine project-page tests now pass, including controls for other projects
and companies. Both unchanged repository browser tests passed against a
fresh local server. UI typecheck, production UI build, and token gates
passed after this fix.
- [Earlier PR CI
passed](https://github.com/paperclipai/paperclip/actions/runs/36072486798)
on `21be0fec0e90e86b6d662b8ee4831847cd041cdb`: 55 successful checks, two
optional Storybook skips, and no failed or pending checks. The
repository browser shard passed with the production fix. Greptile is 5/5
on this exact commit with no unresolved review threads. The PR is
mergeable.

Historical, source-qualified lifecycle evidence:

- Lifecycle baseline: 1,074 assertions. Native session coverage: 447
tests. Product E2E support: 515 tests. Browser support: 11 tests. Full
earlier verification is retained in the archive.
- [Real-provider campaign: 8/8 passed, zero
retries](https://d1p6rlowie26tp.cloudfront.net/runner-e2e/campaigns/gha-35881382080-1/index.html),
source `e88d210417280140b44a36449027290adcb1aeaa`. Evidence and cleanup
checks passed. This includes deliberately exhausted repair cases that
correctly remain blocked; it does not mean every task finished Done.
This campaign predates the recovery UI change.
- Archive migration verified all 16 original JSON files byte-for-byte
and all 24 checksum entries. App tests do not need private archive
access. [Archive PR
#27](https://github.com/paperclipai/paperclip-evals/pull/27) is merged.

## Risks

- Agents that omit durable disposition receive at most two repair
attempts by default. Prose-only completion exposes missing state rather
than silently changing scheduling.
- A retry is an explicit board action. The server rechecks current
controls. A successful response confirms the task returned to To do; it
does not claim that the provider has already started.
- Existing notice metadata remains valid. Only older active notices with
matching structured evidence receive the new UI. Historical notices
without that evidence keep their existing rendering. No schema migration
is required.
- Old run records require conservative retry accounting. Tests cover old
counters, alternating retry lanes, restarts, and exhausted repairs.
- Historical snapshots require private `paperclip-evals` access. The app
index retains public campaign links. Live campaigns qualify specific
sources and scenarios; no new real-provider campaign has run for the
recovery UI commit.

> This fixes existing lifecycle and recovery behavior and does not
duplicate planned core work.

## Model Used

OpenAI GPT-6 through Codex assisted implementation, reasoning, code
execution, and review. The exact serving model ID and context window are
not exposed in this task. Historical real-provider evaluations used
Codex model `gpt-5.6-sol`, separately from the implementation assistant.

## 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 searched GitHub for duplicate or related PRs and linked
them above
- [x] I have either (a) linked existing issues with `Fixes: #` / `Closes
#` / `Refs #` OR (b) described the issue in-PR following the relevant
issue template
- [x] I have not referenced internal/instance-local Paperclip issues or
links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip`
URLs)
- [x] My branch name describes the change and contains no internal
Paperclip ticket id or instance-derived details
- [x] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [x] All Paperclip CI gates are green
- [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge

---------

Co-authored-by: Paperclip <noreply@paperclip.ing>
2026-09-25 15:28:11 -07:00

33 KiB

Paperclip Specification

Target specification for the Paperclip control plane. Living document — updated incrementally during spec interviews.


1. Company Model [DRAFT]

A Company is a first-order object. One Paperclip instance runs multiple Companies. A Company does not have a standalone "goal" field — its direction is defined by its set of Initiatives (see Task Hierarchy Mapping).

Fields (Draft)

Field Type Notes
id uuid Primary key
name string Company name
createdAt timestamp
updatedAt timestamp

Board Governance [DRAFT]

Every Company has a Board that governs high-impact decisions. The Board is the human oversight layer.

V1: Single human Board. One human operator.

Board Approval Gates (V1)

  • New Agent hires (creating new Agents)
  • CEO's initial strategic breakdown (CEO proposes, Board approves before execution begins)
  • [TBD: other governance-gated actions — goal changes, firing Agents?]

Connection tool reviews also appear in task history, with a composer takeover for human approval, decline, or scoped remembered permission. Connections and task views resolve the same review, and the agent continues with the server-recorded outcome. See the implementation contract.

Board Powers (Always Available)

The Board has unrestricted access to the entire system at all times:

  • Set and modify Company budgets — the Board sets top-level token/LLM cost budgets
  • Pause/resume any Agent — stop an Agent's heartbeat immediately
  • Pause/resume any work item — pause a task, project, subtask tree, milestone. Paused items are not picked up by Agents.
  • Full project management access — create, edit, comment on, modify, delete, reassign any task/project/milestone through the UI
  • Override any Agent decision — reassign tasks, change priorities, modify descriptions
  • Manually change any budget at any level

The Board is not just an approval gate — it's a live control surface. The human can intervene at any level at any time.

Budget Delegation

The Board sets Company-level budgets. The CEO can set budgets for Agents below them, and every manager Agent can do the same for their reports. How this cascading budget delegation works in practice is TBD, but the permission structure supports it. The Board can manually override any budget at any level.

Future governance models (not V1):

  • Hiring budgets (auto-approve hires within $X/month)
  • Multi-member boards
  • Delegated authority (CEO can hire within limits)

Open Questions

  • External revenue/expense tracking — future plugin. Token/LLM cost budgeting is core.
  • Company-level settings and configuration?
  • Company lifecycle (pause, archive, delete)?
  • What governance-gated actions exist beyond hiring and CEO strategy approval?

2. Agent Model [DRAFT]

Every employee is an agent. Agents are the workforce.

Agent Identity (Adapter-Level)

Concepts like SOUL.md (identity/mission) and HEARTBEAT.md (loop definition) are not part of the Paperclip protocol. They are adapter-specific configurations. For example, an OpenClaw adapter might use SOUL.md and HEARTBEAT.md files. A Claude Code adapter might use CLAUDE.md. A bare Python script might use command-line args.

Paperclip doesn't prescribe how an agent defines its identity or behavior. It provides the control plane; the adapter defines the agent's inner workings.

Agent Configuration [DRAFT]

Each agent has an adapter type and an adapter-specific configuration blob. The adapter defines what config fields exist.

Paperclip Protocol (What Paperclip Knows)

At the protocol level, Paperclip tracks:

  • Agent identity (id, name, role, title)
  • Org position (who they report to, who reports to them)
  • Adapter type + adapter config
  • Status (active, paused, terminated)
  • Cost tracking data (if the agent reports it)

Adapter Configuration (Agent-Specific)

Each adapter type defines its own config schema. Examples:

  • OpenClaw adapter: SOUL.md content, HEARTBEAT.md content, OpenClaw-specific settings
  • Process adapter: command to run, environment variables, working directory
  • HTTP adapter: endpoint URL, auth headers, payload template

Exportable Org Configs

A key goal: the entire org's agent configurations are exportable. You can export a company's complete agent setup — every agent, their adapter configs, org structure — as a portable artifact. This enables:

  • Sharing company templates ("here's a pre-built marketing agency org")
  • Version controlling your company configuration
  • Duplicating/forking companies

Context Delivery

Configurable per agent. Two ends of the spectrum:

  • Fat payload — Paperclip bundles relevant context (current tasks, messages, company state, metrics) into the heartbeat invocation. Suited for simple/stateless agents that can't call back to Paperclip.
  • Thin ping — Heartbeat is just a wake-up signal. Agent calls Paperclip's API to fetch whatever context it needs. Suited for sophisticated agents that manage their own state.

Minimum Contract

The minimum requirement to be a Paperclip agent: be callable. That's it. Paperclip can invoke you via command or webhook. No requirement to report back — Paperclip infers basic status from process liveness when it can.

Integration Levels

Beyond the minimum, Paperclip provides progressively richer integration:

  1. Callable (minimum) — Paperclip can start you. That's the only contract.
  2. Status reporting — Agent reports back success/failure/in-progress after execution.
  3. Fully instrumented — Agent reports status, cost/token usage, task updates, and logs. Bidirectional integration with the control plane.

Paperclip ships default agents that demonstrate full integration: progress tracking, cost instrumentation, and a Paperclip skill (a Claude Code skill for interacting with the Paperclip API) for task management. These serve as both useful defaults and reference implementations for adapter authors.

Export Formats

Two export modes:

  1. Template export (default) — structure only: agent definitions, org chart, adapter configs, role descriptions. Optionally includes a few seed tasks to help get started. This is the blueprint for spinning up a new company.
  2. Snapshot export — full state: structure + current tasks, progress, agent status. A complete picture you could restore or fork.

The usual workflow: export a template, create a new company from it, add a couple initial tasks, go.


3. Org Structure [DRAFT]

Hierarchical reporting structure. CEO at top, reports cascade down.

Agent Visibility

Full visibility across the org. Every agent can see the entire org chart, all tasks, all agents. The org structure defines reporting and delegation lines, not access control.

Visibility settings on an agent profile (where supported) do not alter company-level visibility for tasks, projects, issues, comments, costs, or activity. Those work-object privacy controls are not a V1 feature until centralized scoped authorization is in place.

Each agent publishes a short description of their responsibilities and capabilities — almost like skills ("when I'm relevant"). This lets other agents discover who can help with what.

Cross-Team Work

Agents can create tasks and assign them to agents outside their reporting line. This is the mechanism for cross-team collaboration. These rules are primarily encoded in the Paperclip SKILL.md which is recommended for all agents. Paperclip the app enforces the tooling and some light governance, but the cross-team rules below are mainly implemented by agent decisions.

Task Acceptance Rules

When an agent receives a task from outside their team:

  1. Agrees it's appropriate + can do it → complete it directly
  2. Agrees it's appropriate + can't do it → mark as blocked
  3. Questions whether it's worth doing → cannot cancel it themselves. Must reassign to their own manager, explain the situation. Manager decides whether to accept, reassign, or escalate.

Manager Escalation Protocol

It's any manager's responsibility to understand why their subordinates are blocked and resolve it:

  1. Decide — as a manager, is this work worth doing?
  2. Delegate down — ask someone under them to help unblock
  3. Escalate up — ask the manager above them for help

Request Depth Tracking

When a task originates from a cross-team request, track the depth as an integer — how many delegation hops from the original requester. This provides visibility into how far work cascades through the org.

Billing Codes

Task detail keeps hierarchy separate from creation provenance: the Tasks tab shows all subtasks and, independently, work created from the current task grouped by project or No project. A created subtask may appear in both sections. Creation provenance follows the originating run equally for legacy and native runners.

Tasks carry a billing code so that token spend during execution can be attributed upstream to the requesting task/agent. When Agent A asks Agent B to do work, the cost of B's work is tracked against A's request. This enables cost attribution across the org.

Open Questions

  • Is this a strict tree or can agents report to multiple managers?
  • Can org structure change at runtime? (agents reassigned, teams restructured)
  • Do agents inherit any configuration from their manager?
  • Billing code format — simple string? Hierarchical?

4. Heartbeat System [DRAFT]

The heartbeat is a protocol, not a runtime. Paperclip defines how to initiate an agent's cycle. What the agent does with that cycle — how long it runs, whether it's task-scoped or continuous — is entirely up to the agent.

Execution Adapters

Agent configuration includes an adapter that defines how Paperclip invokes the agent. Built-in adapters include:

Adapter Mechanism Example
process Execute a child process python run_agent.py --agent-id {id}
http Send an HTTP request POST https://openclaw.example.com/hook/{id}
claude_local Local Claude Code process Claude Code heartbeat worker
codex_local Local Codex process Codex CLI heartbeat worker
opencode_local Local OpenCode process OpenCode heartbeat worker
pi_local Local Pi process Pi CLI heartbeat worker
cursor Cursor API/CLI bridge Cursor-integrated heartbeat worker
openclaw_gateway OpenClaw gateway API Managed OpenClaw agent via gateway
hermes_local Local Hermes process Hermes agent heartbeat worker

The process and http adapters ship as generic defaults. Additional built-in adapters cover common local coding runtimes (see list above), and new adapter types can be registered via the plugin system (see Plugin / Extension Architecture).

An adapter's selected execution engine is part of its permission and session contract. Missing prerequisites or engine failures must be surfaced without silently launching a different engine. A default local engine must support normal task work and control-plane coordination; explicit operator restrictions remain authoritative.

Adapter Interface

Every adapter implements three methods:

invoke(agentConfig, context?) → void     // Start the agent's cycle
status(agentConfig) → AgentStatus        // Is it running? finished? errored?
cancel(agentConfig) → void               // Graceful stop signal (for pause/resume)

This is the full adapter contract. invoke starts the agent, status lets Paperclip check on it, cancel enables the board's pause functionality. Everything else (cost reporting, task updates) is optional and flows through the Paperclip REST API.

What Paperclip Controls

  • When to fire the heartbeat (schedule/frequency, per-agent)
  • How to fire it (adapter selection + config)
  • What context to include (thin ping vs. fat payload, per-agent)

What Paperclip Does NOT Control

  • How long the agent runs
  • What the agent does during its cycle
  • Whether the agent is task-scoped, time-windowed, or continuous

Pause Behavior

When the board (or system) pauses an agent:

  1. Signal the current execution — send a graceful termination signal to the running process/session
  2. Grace period — give the agent time to wrap up, save state, report final status
  3. Force-kill after timeout — if the agent doesn't stop within the grace period, terminate
  4. Stop future heartbeats — no new heartbeat cycles will fire until the agent is resumed

This is "graceful signal + stop future heartbeats." The current run gets a chance to land cleanly.

Open Questions

  • Heartbeat frequency — who controls it? Fixed? Per-agent? Cron-like?
  • What happens when a heartbeat invocation fails? (process crashes, HTTP 500)
  • Health monitoring — how does Paperclip distinguish "stuck" from "working on a long task"?
  • Can agents self-trigger their next heartbeat? ("I'm done, wake me again in 5 min")
  • Grace period duration — fixed? configurable per agent?

5. Inter-Agent Communication [DRAFT]

All agent communication flows through the task system.

Model: Tasks + Comments

  • Delegation = creating a task and assigning it to another agent
  • Coordination = commenting on tasks
  • Status updates = updating task status and fields

There is no separate messaging or chat system. Tasks are the communication channel. This keeps all context attached to the work it relates to and creates a natural audit trail.

Experimental Agent Chat presents one persistent task per person and agent as a simplified conversation. It retains the task composer, transcript, tools, attachments, documents, and existing Subtasks panel, with ordinary company visibility. New execution tasks are ordinary project tasks, not children of the conversation. Idle conversations wait for a message without entering execution-task work queues. Agents clarify goals here and create assigned tasks for substantial execution. /new resets provider context at an ordered session boundary within the same task while preserving visible history. enableAgentChat is disabled by default; the V1 lifecycle and rollout contract is specified in SPEC-implementation.md.

Implications

  • An agent's "inbox" is: tasks assigned to them + comments on tasks they're involved in
  • The CEO delegates by creating tasks assigned to the CTO
  • The CTO breaks those down into sub-tasks assigned to engineers
  • Discussion happens in task comments, not a side channel
  • If an agent needs to escalate, they comment on the parent task or reassign

Task Hierarchy Mapping

Full hierarchy: Initiative (company goal) → Projects → Milestones → Issues → Sub-issues. Everything traces back to an initiative, and the "company goal" is just the first/primary initiative.


6. Cost Tracking [DRAFT]

Token/LLM cost budgeting is a core part of Paperclip. External revenue and expense tracking is a future plugin.

Cost Reporting

Fully-instrumented Agents report token/API usage back to Paperclip. Costs are tracked at every level:

  • Per Agent — how much is this employee costing?
  • Per task — how much did this unit of work cost?
  • Per project — how much is this deliverable costing?
  • Per Company — total burn rate

Costs should be denominated in both tokens and dollars.

Billing codes on tasks (see Org Structure) enable cost attribution across teams — when Agent A requests work from Agent B, B's costs roll up to A's request.

Budget Controls

Three tiers:

  1. Visibility — dashboards showing spend at every level (Agent, task, project, Company)
  2. Soft alerts — configurable thresholds (e.g. warn at 80% of budget)
  3. Hard ceiling — auto-pause the Agent when budget is hit. Board notified. Board can override/raise the limit.

Budgets can be set to unlimited (no ceiling).

Open Questions

  • Cost reporting API — what's the schema for an agent to report costs?
  • Dashboard design — what metrics matter most at each level?
  • Budget period — per-day? per-week? per-month? rolling?

7. Default Agents & Bootstrap Flow [DRAFT]

Bootstrap Sequence

How a Company goes from "created" to "running":

  1. Human creates a Company and its initial Initiatives
  2. Human defines initial top-level tasks
  3. Human creates the CEO Agent (using the default CEO template or custom)
  4. CEO's first heartbeat: reviews the Initiatives and tasks, proposes a strategic breakdown (org structure, sub-tasks, hiring plan)
  5. Board approves the CEO's strategic plan
  6. CEO begins execution — creating tasks, proposing hires (Board-approved), delegating

Default Agents

Paperclip ships default Agent templates:

  • Default Agent — a basic Claude Code or Codex loop. Knows the Paperclip Skill (SKILL.md) so it can interact with the task system, read Company context, report status.
  • Default CEO — extends the Default Agent with CEO-specific behavior: strategic planning, delegation to reports, progress review, Board communication.

These are starting points. Users can customize or replace them entirely.

Default Agent Behavior

The default agent's loop is config-driven. The adapter config contains the instructions that define what the agent does on each heartbeat cycle. There is no hardcoded standard loop — each agent's config determines its behavior.

This means the default CEO config tells the CEO to review strategy, check on reports, etc. The default engineer config tells the engineer to check assigned tasks, pick the highest priority, and work it. But these are config choices, not protocol requirements.

Paperclip Skill (SKILL.md)

A skill definition that teaches agents how to interact with Paperclip. Provides:

  • Task CRUD (create, read, update, complete tasks)
  • Status reporting (check in, report progress)
  • Company context (read goal, org chart, current state)
  • Cost reporting (log token/API usage)
  • Inter-agent communication rules

This skill is adapter-agnostic — it can be loaded into Claude Code, injected into prompts, or used as API documentation for custom agents.


8. Architecture & Deployment [DRAFT]

Deployment Model

Single-tenant, self-hostable. Not a SaaS. One instance = one operator's companies.

Development Path (Progressive Deployment)

  1. Local dev — One command to install and run. Embedded Postgres. Everything on your machine. Agents run locally.
  2. Hosted — Deploy to Vercel/Supabase/AWS/anywhere. Remote agents connect to your server with a shared database. The UI is accessible via the web.
  3. Open company — Optionally make parts public (e.g. a job board visible to the public for open companies).

The key constraint: it must be trivial to go from "I'm trying this on my machine" to "my agents are running on remote servers talking to my Paperclip instance."

Agent Authentication

When a user creates an Agent, Paperclip generates a connection string containing: the server URL, an API key, and instructions for how to authenticate. The Agent is assumed to be capable of figuring out how to call the API with its token/key from there.

Flow:

  1. Human creates an Agent in the UI
  2. Paperclip generates a connection string (URL + key + instructions)
  3. Human provides this string to the Agent (e.g. in its adapter config, environment, etc.)
  4. Agent uses the key to authenticate API calls to the control plane

Tech Stack

Layer Technology
Frontend React + Vite
Backend TypeScript + Express (REST API, not tRPC — need non-TS clients)
Database PostgreSQL (see doc/DATABASE.md for details — PGlite embedded for dev, Docker or hosted Supabase for production)
Auth Better Auth

Concurrency Model: Atomic Task Checkout

Tasks use single assignment (one agent per task) with atomic checkout:

  1. Agent attempts to set a task to in_progress (claiming it)
  2. The API/database enforces this atomically — if another agent already claimed it, the request fails with an error identifying which agent has it
  3. If the task is already assigned to the requesting agent from a previous session, they can resume

No optimistic locking or CRDTs needed. The single-assignment model + atomic checkout prevents conflicts at the design level.

Human in the Loop

Agents can create tasks assigned to humans. The board member (or any human with access) can complete these tasks through the UI.

When a human completes a task, if the requesting agent's adapter supports pingbacks (e.g. OpenClaw hooks), Paperclip sends a notification to wake that agent. This keeps humans rare but possible participants in the workflow.

The agents are discouraged from assigning tasks to humans in the Paperclip SKILL, but sometimes it's unavoidable.

API Design

Single unified REST API. The same API serves both the frontend UI and agents. Authentication determines permissions — board auth has full access, agent API keys have scoped access (their own tasks, cost reporting, company context).

No separate "agent API" vs. "board API." Same endpoints, different authorization levels.

Work Artifacts

Paperclip manages task-linked work artifacts: issue documents (rich-text plans, specs, notes attached to issues) and file attachments. Agents read and write these through the API as part of normal task execution. Full delivery infrastructure (code repos, deployments, production runtime) remains the agent's domain — Paperclip orchestrates the work, not the build pipeline.

Task work mode is explicit persisted state. Requesting a plan in a title or description does not switch the task into planning mode. Standard execution may produce a plan as its requested deliverable; explicit planning mode separately governs plan-only execution and its approval transition.

Open Questions

  • Real-time updates to the UI — WebSocket? SSE? Polling?
  • Agent API key scoping — what exactly can an Agent access? Only their own tasks? Their team's? The whole Company?

Crash Recovery: Manual, Not Automatic

When an agent crashes or disappears mid-task, Paperclip does not auto-reassign or auto-release the task. Instead:

  • Paperclip surfaces stale tasks (tasks in in_progress with no recent activity) through dashboards and reporting
  • Paperclip may perform bounded continuity repair with the same assigned agent; when that is exhausted or unsafe, it opens a board-owned recovery action without waking a substitute agent
  • Paperclip does not fail silently — the auditing and visibility tools make problems obvious
  • Recovery is handled by humans or by emergent processes (e.g. a project manager agent whose job is to monitor for stale work and surface it)

Principle: Paperclip reports problems, it doesn't silently fix them. Automatic recovery hides failures. Good visibility lets the right entity (human or agent) decide what to do.

Plugin / Extension Architecture

The core Paperclip system must be extensible. Features like knowledge bases, external revenue tracking, and new Agent Adapters should be addable as plugins without modifying core. This means:

  • Well-defined API boundaries that plugins can hook into
  • Event system or hooks for reacting to task/Agent lifecycle events
  • Agent Adapter plugins — new Adapter types can be registered via the plugin system
  • Plugin-registrable UI components (future)

The plugin framework has shipped. Plugins can register new adapter types, hook into lifecycle events, and contribute UI components (e.g. global toolbar buttons). A plugin SDK and CLI commands (paperclipai plugin) are available for authoring and installing plugins.


9. Frontend / UI [DRAFT]

Primary Views

Each is a distinct page/route:

  1. Org Chart — the org tree with live status indicators (running/idle/paused/error) per agent. Real-time activity feed of what agents are doing.
  2. Task Board — Task management. Kanban and list views. Filter by team, agent, project, status.
  3. Dashboard — high-level metrics: agent count, active tasks, costs, goal progress, burn rate. The "glance" view from GOAL.md.
  4. Agent Detail — deep dive on a single agent: their tasks, activity, costs, configuration, status history.
  5. Project/Initiative Views — progress tracking against milestones and goals.
  6. Cost Dashboard — spend visualization at every level (agent, task, project, company).

Board Controls (Available Everywhere)

  • Pause/resume agents (any view)
  • Pause/resume tasks/projects (any view)
  • Approve/reject pending actions (hiring, strategy proposals)
  • Direct task creation, editing, commenting

10. V1 Scope (MVP) [DRAFT]

Full loop with one adapter. V1 must demonstrate the complete Paperclip cycle end-to-end, even if narrow.

Must Have (V1)

  • Company CRUD — create a Company with Initiatives
  • Agent CRUD — create/edit/pause/resume Agents with Adapter config
  • Org chart — define reporting structure, visualize it
  • Process adapter — invoke(), status(), cancel() for local child processes
  • Task management — full lifecycle with hierarchy (tasks trace to company goal)
  • Atomic task checkout — single assignment, in_progress locking
  • Board governance — human approves hires, pauses Agents, sets budgets, full PM access
  • Cost tracking — Agents report token usage, per-Agent/task/Company visibility
  • Budget controls — soft alerts + hard ceiling with auto-pause
  • Default agent — basic Claude Code/Codex loop with Paperclip skill
  • Default CEO — strategic planning, delegation, board communication
  • Paperclip skill (SKILL.md) — teaches agents to interact with the API
  • REST API — full API for agent interaction (Express)
  • Web UI — React/Vite: org chart, task board, dashboard, cost views
  • Agent auth — connection string generation with URL + key + instructions
  • One-command dev setup — embedded PGlite, everything local
  • Multiple Adapter types (HTTP, OpenClaw gateway, and local coding adapters)

Not V1

  • Knowledge base - a future plugin
  • Advanced governance models (hiring budgets, multi-member boards)
  • Revenue/expense tracking beyond token costs - a future plugin
  • Public job board / open company features

11. Knowledge Base

Anti-goal for core. The knowledge base is not part of the Paperclip core — it will be a plugin. The task system + comments + agent descriptions provide sufficient shared context.

The architecture must support adding a knowledge base plugin later (clean API boundaries, hookable lifecycle events) but the core system explicitly does not include one.


12. Anti-Requirements

Things Paperclip explicitly does not do:

  • Not an Agent runtime — Paperclip orchestrates, Agents run elsewhere
  • Not a knowledge base — core has no wiki/docs/vector-DB (plugin territory)
  • Not a SaaS — single-tenant, self-hosted
  • Not opinionated about Agent implementation — any language, any framework, any runtime
  • Not automatically self-healing — surfaces problems, doesn't silently fix them
  • Does not manage delivery infrastructure — no repo management, no deployment, no file systems (but does manage task-linked documents and attachments)
  • Does not auto-reassign work — stale tasks are surfaced, not silently redistributed
  • Does not track external revenue/expenses — that's a future plugin. Token/LLM cost budgeting is core.

13. Principles (Consolidated)

  1. Unopinionated about how you run your Agents. Any language, any framework, any runtime. Paperclip is the control plane, not the execution plane.
  2. Company is the unit of organization. Everything lives under a Company.
  3. Tasks are the communication channel. All Agent communication flows through tasks + comments. No side channels.
  4. All work traces to the goal. Hierarchical task management — nothing exists in isolation.
  5. Board governs. Humans retain control through the Board. Conservative defaults (human approval required).
  6. Surface problems, don't hide them. Good auditing and visibility. No silent auto-recovery.
  7. Atomic ownership. Single assignee per task. Atomic checkout prevents conflicts.
  8. Progressive deployment. Trivial to start local, straightforward to scale to hosted.
  9. Extensible core. Clean boundaries so plugins can add capabilities (Adapters, knowledge base, revenue tracking) without modifying core.

Agent visual identity

Agent appearances are stable, versioned ClipLab end-cap personas, separate from behavioral instructions. Compact surfaces use on-demand cached PNG URLs; larger placements may use a lazy live character. See agent-personas.md for persistence, migration, rendering, and integration contracts.

Agent chat project handoff (2026-09-11)

Chat supports research and full plan drafting/revision in its existing plan document. On handoff, each ordinary assigned task receives the relevant plan in its own plan document, committed with task creation before execution is scheduled. The source plan remains in the conversation. Plan acceptance hands off execution; it never switches the conversation into implementation.

Chat instructions require selecting a suitable project, reusing an existing one where appropriate. The project requirement is prompt-only; ordinary projectless tasks remain supported. New parent relationships beneath conversation tasks are rejected by task services, including direct API creation and reparenting. Existing children remain readable/editable and can be moved elsewhere. The Subtasks panel is unchanged.

The create_project runtime tool uses the normal project API with durable idempotency. list_projects and list_project_repositories support selection. Multiple repositoryIds select authorized catalog entries; multiple HTTPS GitHub repositoryUrls register existing repositories absent from the catalog. IDs and URLs may be combined, but cannot accompany an explicit workspace. URLs do not create repositories on GitHub or grant credentials. Execution uses normal repository access rules. Repository IDs are revalidated against the authenticated run's responsible user and connection grants. Agents should consider proper available repositories, clarify material ambiguity, and use repository-free projects when appropriate for non-code work.

Confirmed project creation appears as a durable card in the shared task transcript, including selected repository links. Tasks are linked inline. Failed creation never produces a success card. Tool evals cover planning/handoff, project/repository selection, retries, permission and mode denials, and ordinary delegation regressions using the production chat directive.

Paused task messages

A paused task takes over the composer with an amber notice and a Resume action. Operators must release the effective task or ancestor pause before sending a new message. The draft stays intact. This applies to both task interfaces and to board comment API requests; an agent may still report interrupted work.

Experimental iMessage Photon channel

A Photon Cloud project can represent one agent through the existing experimental channel subsystem. DMs and explicitly enabled groups create or continue task-bound conversations. Linked sender identity is the default; telephone numbers, email addresses, names, and group membership do not grant Paperclip authority. Photos/files and ordinary questions/confirmations use the existing attachment, interaction, continuation, and publication contracts. Pause and Disconnect govern runtime behavior independently of the UI gate. Local Mac access, unsolicited conversations, and SMS/RCS fallback are excluded. Live qualification is required before release readiness. Pro shared allocation supports DMs only, with sender enrollment in Photon and separate identity linking in Paperclip. Shared channels reserve one project, not a pool phone number; group admission and publication are disabled. Dedicated allocation retains one selected number and individually enabled groups.

See iMessage Photon for the implementation contract, setup, recovery, boundaries, and qualification status.

Task search relevance

Task discovery uses PostgreSQL and the existing search indexes, with no external search service or background indexing job. The task-list quick search and full company search share lexical matching and ranking. Known identifiers and direct title matches lead; current conversation and document content supplies supporting evidence. See Task search relevance for the evaluation rubric, matching contract and reproducible quality tests.