09d2ef1a37
- Restored docs/ directory that was accidentally deleted by `git add -A` in the v0.2.3 release script - Replaced generic "P" favicon with actual paperclip icon using brand primary color (#2563EB) - Added light/dark logo SVGs for Mintlify navbar (paperclip icon + wordmark) - Updated docs.json with logo configuration for dark/light mode - Fixed release.sh to stage only release-related files instead of `git add -A` to prevent sweeping unrelated changes into release commits Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2.1 KiB
2.1 KiB
title, summary
| title | summary |
|---|---|
| Adapters Overview | What adapters are and how they connect agents to Paperclip |
Adapters are the bridge between Paperclip's orchestration layer and agent runtimes. Each adapter knows how to invoke a specific type of AI agent and capture its results.
How Adapters Work
When a heartbeat fires, Paperclip:
- Looks up the agent's
adapterTypeandadapterConfig - Calls the adapter's
execute()function with the execution context - The adapter spawns or calls the agent runtime
- The adapter captures stdout, parses usage/cost data, and returns a structured result
Built-in Adapters
| Adapter | Type Key | Description |
|---|---|---|
| Claude Local | claude_local |
Runs Claude Code CLI locally |
| Codex Local | codex_local |
Runs OpenAI Codex CLI locally |
| Process | process |
Executes arbitrary shell commands |
| HTTP | http |
Sends webhooks to external agents |
Adapter Architecture
Each adapter is a package with three modules:
packages/adapters/<name>/
src/
index.ts # Shared metadata (type, label, models)
server/
execute.ts # Core execution logic
parse.ts # Output parsing
test.ts # Environment diagnostics
ui/
parse-stdout.ts # Stdout -> transcript entries for run viewer
build-config.ts # Form values -> adapterConfig JSON
cli/
format-event.ts # Terminal output for `paperclipai run --watch`
Three registries consume these modules:
| Registry | What it does |
|---|---|
| Server | Executes agents, captures results |
| UI | Renders run transcripts, provides config forms |
| CLI | Formats terminal output for live watching |
Choosing an Adapter
- Need a coding agent? Use
claude_localorcodex_local - Need to run a script or command? Use
process - Need to call an external service? Use
http - Need something custom? Create your own adapter