packages/adapters/hermes/README.md
A Paperclip adapter package that lets you run Hermes Agent as a managed employee in a Paperclip company.
Hermes Agent is a full-featured AI agent by Nous Research with 30+ native tools, persistent memory, session persistence, 80+ skills, MCP support, and multi-provider model access.
This package owns both built-in Hermes adapter types:
hermes_local runs the local Hermes CLI as a child process. The package root exports remain compatible with the original local adapter.hermes_gateway calls an already-running Hermes API server over HTTP/SSE. Gateway entrypoints live under the ./gateway export namespace.Choose hermes_local when Paperclip and Hermes run on the same trusted host
and Paperclip should start hermes chat for each heartbeat. Choose
hermes_gateway when Hermes is already running as an API server, often on
another host, in Docker, or behind a private-network/TLS endpoint. The adapter
type keys did not change during package consolidation.
This adapter provides:
~/.hermes/skills/), with sync/list/resolve APIsTranscriptEntry objects so Paperclip renders proper tool cards with status icons and expand/collapse+--+ table borders into clean GFM markdown~/.hermes/config.yaml to pre-populate the UI with the user's configured modeltool source so they don't clutter the user's interactive history--checkpoints for rollback safety--reasoning-effort for thinking/reasoning models| Feature | Claude Code | Codex | Hermes Agent |
|---|---|---|---|
| Persistent memory | ❌ | ❌ | ✅ Remembers across sessions |
| Native tools | ~5 | ~5 | 30+ (terminal, file, web, browser, vision, git, etc.) |
| Skills system | ❌ | ❌ | ✅ 80+ loadable skills |
| Session search | ❌ | ❌ | ✅ FTS5 search over past conversations |
| Sub-agent delegation | ❌ | ❌ | ✅ Parallel sub-tasks |
| Context compression | ❌ | ❌ | ✅ Auto-compresses long conversations |
| MCP client | ❌ | ❌ | ✅ Connect to any MCP server |
| Multi-provider | Anthropic only | OpenAI only | ✅ 8 providers out of the box |
This package ships with Paperclip core as the built-in hermes_local and
hermes_gateway adapters. No Adapter manager installation is required for
normal Paperclip use.
pip install hermes-agent)For local adapter development, install the package from a local path in Adapter
manager, or add an entry to ~/.paperclip/adapter-plugins.json and restart
Paperclip. The external package can override either built-in Hermes adapter
while it is enabled:
[
{
"packageName": "@paperclipai/hermes-paperclip-adapter",
"localPath": "/absolute/path/to/paperclip/packages/adapters/hermes",
"type": "hermes_local",
"installedAt": "2026-06-23T00:00:00.000Z"
}
]
Use "type": "hermes_gateway" with the same package when testing a gateway
override.
The package root exports createServerAdapter() for the local server adapter,
a declarative config schema for the generic agent form, and ./ui-parser for
local run transcript parsing. Gateway entrypoints are exported from ./gateway,
./gateway/server, ./gateway/ui, ./gateway/cli, and ./gateway/ui-parser.
Paperclip core imports these same package entrypoints for built-in adapter
registration.
In the Paperclip UI or via API, create an agent with adapter type hermes_local:
{
"name": "Hermes Engineer",
"adapterType": "hermes_local",
"adapterConfig": {
"model": "anthropic/claude-sonnet-4",
"maxIterations": 50,
"timeoutSec": 300,
"persistSession": true,
"enabledToolsets": ["terminal", "file", "web"]
}
}
This mode shells out to the local hermes CLI. Paperclip injects runtime
environment variables and captures stdout/stderr from the child process.
Start Hermes with its API server enabled first:
API_SERVER_ENABLED=true \
API_SERVER_KEY=<generated-secret> \
hermes gateway run --replace --accept-hooks
Then create an agent with adapter type hermes_gateway:
{
"name": "Hermes Gateway Engineer",
"adapterType": "hermes_gateway",
"adapterConfig": {
"apiBaseUrl": "http://127.0.0.1:8642",
"apiKey": "<same-value-as-API_SERVER_KEY>",
"paperclipApiUrl": "http://127.0.0.1:3100",
"sessionKeyStrategy": "issue",
"timeoutSec": 600
}
}
If the URL you have is the default Hermes dashboard at
http://127.0.0.1:9119 or the default chat URL at
http://127.0.0.1:9119/chat, Paperclip maps it to
http://127.0.0.1:9119/api before calling Hermes API routes. /chat and the
dashboard root are browser UI routes; Paperclip tests /api/health and starts
runs with /api/v1/runs after mapping them to the API base.
This mode does not start Hermes. It creates runs with POST /v1/runs, streams
Hermes events with SSE, polls run status as a fallback, and stops timed-out runs
with POST /v1/runs/{run_id}/stop.
@paperclipai/adapter-hermes-gateway remains as a deprecated compatibility shim
for one release. It re-exports the gateway entrypoints from
@paperclipai/hermes-paperclip-adapter/gateway and preserves the legacy exports
for existing plugin installs. New installs and built-in Paperclip registrations
should use @paperclipai/hermes-paperclip-adapter; the adapter type remains
hermes_gateway.
Hermes receives Paperclip runtime identity through environment variables:
PAPERCLIP_API_URLPAPERCLIP_API_KEYPAPERCLIP_RUN_IDPrompts should reference those variables directly. Command output may redact
secret values, so do not copy printed tokens into comments or config. Use
Authorization: Bearer $PAPERCLIP_API_KEY on Paperclip API requests and
X-Paperclip-Run-Id: $PAPERCLIP_RUN_ID on mutating issue requests. For
multiline comments or status updates, preserve newlines with a heredoc plus
jq --arg.
The package includes a Hermes skill/helper for the reverse direction: a user
starts in Hermes and asks Hermes to create or update Paperclip work. This is not
the same as Paperclip waking Hermes through hermes_local or hermes_gateway.
Configure Paperclip access in Hermes env/profile secrets, not prompt text:
PAPERCLIP_API_URL=http://127.0.0.1:3100/api
PAPERCLIP_BRIDGE_API_KEY=<task-bridge-scoped-agent-api-key>
Optional env values:
PAPERCLIP_COMPANY_IDPAPERCLIP_AGENT_IDPAPERCLIP_RUN_IDThe bundled paperclip-task-bridge skill provides deterministic helper
commands:
node ./paperclip-task.mjs list-assigned
node ./paperclip-task.mjs create-task --parent-id "<approved-parent-issue-id>" --title "Investigate checkout failures" --description "Capture failing request and root cause."
node ./paperclip-task.mjs comment --issue PAP-123 --body "Found the failing request path."
node ./paperclip-task.mjs update-status --issue PAP-123 --status in_review --comment "Ready for review."
The helper reads credentials from environment variables and prints only JSON
summaries. It supports create-task, comment, update-status, and
list-assigned.
Create the bridge key with scope.kind = "task_bridge" plus a parentIssueId
or projectId boundary. Do not use a normal claimed agent API key for
internet-facing Hermes chat/webhook task-bridge operations.
Create issues in Paperclip and assign them to your Hermes agent. On each heartbeat, Hermes will:
| Field | Type | Default | Description |
|---|---|---|---|
model | string | anthropic/claude-sonnet-4 | Model in provider/model format |
provider | string | (auto-detected) | API provider: auto, openrouter, nous, openai-codex, zai, kimi-coding, minimax, minimax-cn |
timeoutSec | number | 300 | Execution timeout in seconds |
graceSec | number | 10 | Grace period before SIGKILL |
| Field | Type | Default | Description |
|---|---|---|---|
toolsets | string | (all) | Comma-separated toolsets to enable (e.g. "terminal,file,web") |
Available toolsets: terminal, file, web, browser, code_execution, vision, mcp, creative, productivity
| Field | Type | Default | Description |
|---|---|---|---|
persistSession | boolean | true | Resume sessions across heartbeats |
worktreeMode | boolean | false | Git worktree isolation |
checkpoints | boolean | false | Enable filesystem checkpoints for rollback |
| Field | Type | Default | Description |
|---|---|---|---|
hermesCommand | string | hermes | Custom CLI binary path |
verbose | boolean | false | Enable verbose output |
quiet | boolean | true | Quiet mode (clean output, no banner/spinner) |
extraArgs | string[] | [] | Additional CLI arguments |
env | object | {} | Extra environment variables |
promptTemplate | string | (built-in) | Custom prompt template |
paperclipApiUrl | string | http://127.0.0.1:3100/api | Paperclip API base URL |
Use {{variable}} syntax in promptTemplate:
| Variable | Description |
|---|---|
{{agentId}} | Paperclip agent ID |
{{agentName}} | Agent display name |
{{companyId}} | Company ID |
{{companyName}} | Company name |
{{runId}} | Current heartbeat run ID |
{{taskId}} | Assigned task/issue ID |
{{taskTitle}} | Task title |
{{taskBody}} | Task instructions |
{{projectName}} | Project name |
{{paperclipApiUrl}} | Paperclip API base URL |
{{commentId}} | Comment ID (when woken by a comment) |
{{wakeReason}} | Reason this run was triggered |
Conditional sections:
{{#taskId}}...{{/taskId}} — included only when a task is assigned{{#noTask}}...{{/noTask}} — included only when no task (heartbeat check){{#commentId}}...{{/commentId}} — included only when woken by a commentPaperclip Hermes Agent
┌──────────────────┐ ┌──────────────────┐
│ Heartbeat │ │ │
│ Scheduler │───execute()──▶│ hermes chat -q │
│ │ │ │
│ Issue System │ │ 30+ Tools │
│ Comment Wakes │◀──results─────│ Memory System │
│ │ │ Session DB │
│ Cost Tracking │ │ Skills │
│ │ │ MCP Client │
│ Skill Sync │◀──snapshot────│ ~/.hermes/skills│
│ Org Chart │ │ │
└──────────────────┘ └──────────────────┘
The adapter spawns Hermes Agent's CLI in single-query mode (-q). Hermes
processes the task using its full tool suite, then exits. The adapter:
TranscriptEntry objects (tool cards with status icons)tool source to keep them separate from interactive usageSession persistence works via Hermes's --resume flag — each run picks
up where the last one left off, maintaining conversation context,
memories, and tool state across heartbeats. The sessionCodec validates
and migrates session state between runs.
The adapter scans two skill sources and merges them:
~/.hermes/skills/, read-only, always loadedThe listSkills / syncSkills APIs expose a unified snapshot so the
Paperclip UI can display both managed and native skills in one view.
git clone https://github.com/paperclipai/paperclip
cd paperclip/packages/adapters/hermes
pnpm install
pnpm build
MIT — see LICENSE