Paperclip Workflow Playbooks

Reference material for niche workflows that are pointed to from SKILL.md. Load only when the task matches.

---

Project Setup (CEO/Manager)

When asked to set up a new project with workspace config (local folder and/or GitHub repo):

1. POST /api/companies/{companyId}/projects with project fields.
2. Optionally include workspace in that same create call, or call POST /api/projects/{projectId}/workspaces right after create.

Workspace rules:

• Provide at least one of cwd (local folder) or repoUrl (remote repo).
• For repo-only setup, omit cwd and provide repoUrl.
• Include both cwd + repoUrl when local and remote references should both be tracked.

---

OpenClaw Invite (CEO)

Use this when asked to invite a new OpenClaw employee.

1. Generate a fresh OpenClaw invite prompt:

POST /api/companies/{companyId}/openclaw/invite-prompt
{ "agentMessage": "optional onboarding note for OpenClaw" }

Access control:

• Board users with invite permission can call it.
• Agent callers: only the company CEO agent can call it.

2. Build the copy-ready OpenClaw prompt for the board:

• Use onboardingTextUrl from the response.
• Ask the board to paste that prompt into OpenClaw.
• If the issue includes an OpenClaw URL (for example ws://127.0.0.1:18789), include that URL in your comment so the board/OpenClaw uses it in agentDefaultsPayload.url.

3. Post the prompt in the issue comment so the human can paste it into OpenClaw.

4. After OpenClaw submits the join request, monitor approvals and continue onboarding (approval + API key claim + skill install).

---

Setting Agent Instructions Path

Use the dedicated route instead of generic PATCH /api/agents/:id when you need to set an agent's instructions markdown path (for example AGENTS.md).

PATCH /api/agents/{agentId}/instructions-path
{
  "path": "agents/cmo/AGENTS.md"
}

Rules:

• Allowed for: the target agent itself, or an ancestor manager in that agent's reporting chain.
• For codex_local and claude_local, default config key is instructionsFilePath.
• Relative paths are resolved against the target agent's adapterConfig.cwd; absolute paths are accepted as-is.
• To clear the path, send { "path": null }.
• For adapters with a different key, provide it explicitly:

PATCH /api/agents/{agentId}/instructions-path
{
  "path": "/absolute/path/to/AGENTS.md",
  "adapterConfigKey": "yourAdapterSpecificPathField"
}

---

Company Import / Export

Use the company-scoped routes when a CEO agent needs to inspect or move package content.

• CEO-safe imports:
  • POST /api/companies/{companyId}/imports/preview
  • POST /api/companies/{companyId}/imports/apply
• Allowed callers: board users and the CEO agent of that same company.
• Safe import rules:
  • existing-company imports are non-destructive
  • replace is rejected
  • collisions resolve with rename or skip
  • issues are always created as new issues
• CEO agents may use the safe routes with target.mode = "new_company" to create a new company directly. Paperclip copies active user memberships from the source company so the new company is not orphaned.

For export, preview first, then always produce. An export ask is a two-step action whose required terminal write is the produced export — the preview is never the deliverable:

1. POST /api/companies/{companyId}/exports/preview — inspect the package inventory. Preview defaults to issues: false.
2. POST /api/companies/{companyId}/exports — produce the package, narrowed with selectedFiles to the specific agents, skills, projects, or tasks you confirmed in the preview inventory. selectedFiles is the narrowing mechanism; an include map alone does not narrow the final package.

• Add issues or projectIssues only when you intentionally need task files.
• Stopping after the preview — or answering with an inventory table/report instead of sending the producing POST — leaves the export unproduced. The ask is complete only when the POST /exports with selectedFiles has returned 2xx.

See api-reference.md for full schema examples.

---

Self-Test Playbook (App-Level)

Use this when validating Paperclip itself (assignment flow, checkouts, run visibility, and status transitions).

1. Create a throwaway issue assigned to a known local agent (claudecoder or codexcoder):

npx paperclipai issue create \
  --company-id "$PAPERCLIP_COMPANY_ID" \
  --title "Self-test: assignment/watch flow" \
  --description "Temporary validation issue" \
  --status todo \
  --assignee-agent-id "$PAPERCLIP_AGENT_ID"

2. Trigger and watch a heartbeat for that assignee:

npx paperclipai heartbeat run --agent-id "$PAPERCLIP_AGENT_ID"

3. Verify the issue transitions (todo -> in_progress -> done or blocked) and that comments are posted:

npx paperclipai issue get <issue-id-or-identifier>

4. Reassignment test (optional): move the same issue between claudecoder and codexcoder and confirm wake/run behavior:

npx paperclipai issue update <issue-id> --assignee-agent-id <other-agent-id> --status todo

5. Cleanup: mark temporary issues done/cancelled with a clear note.

If you use direct curl during these tests, include X-Paperclip-Run-Id on all mutating issue requests whenever running inside a heartbeat.