paperclip/packages/adapters/hermes
Dotta ab15aff390
feat: add experimental persistent agent chat (#13284)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work.
> - Conversations must use the same tasks, controls, and execution
history.
> - Users need an ongoing chat with an agent without managing task
properties.
> - Agents should clarify and plan work, then hand execution to assigned
project tasks.
> - This pull request combines the reviewed Agent Chat stack for one
squash merge.
> - The benefit is persistent conversation with normal task governance
and shared UI.

## Linked Issues or Issue Description

**Subsystem affected**

Task lifecycle, agent runtime tools, shared task UI, and browser/paid
runner tests.

**Problem or motivation**

Users need one persistent conversation with each agent. A separate chat
store or renderer would duplicate task behavior and bypass existing
controls.

**Proposed solution**

Use a task-backed chat per company, user, and agent. Reuse the task
composer and transcript. Clarify and plan in chat, then create assigned
project tasks with the relevant plan. Keep Agent Chat behind its own
disabled-by-default experimental setting.

**Roadmap alignment**

This implements the task-backed direction in [CEO
Chat](https://github.com/paperclipai/paperclip/blob/master/ROADMAP.md#-ceo-chat).
Related proposals: #2504 and #9693. Related request: #7981. The
maintainer requested one squash merge of the complete stack.

Consolidates the reviewed runtime
[#13281](https://github.com/paperclipai/paperclip/pull/13281), backend
[#13282](https://github.com/paperclipai/paperclip/pull/13282), and UI
[#13283](https://github.com/paperclipai/paperclip/pull/13283) layers
with this PR's E2E coverage. All four layers passed CI and received
Greptile 5/5 before consolidation. This PR targets master and includes
the complete feature.

## What Changed

- Add personal canonical chat tasks with ordinary company visibility,
immutable identity, idempotent first sends, and an idle waiting state.
- Process `/new` in queue order. Preserve history, release a chat pause,
and fence old provider context and delayed writes.
- Keep chat lifecycle rules across recovery, finalization, assignment,
task lists, and rollups.
- Support research and plan revision in chat. Hand plans to ordinary
assigned project tasks before execution starts. Reject new chat
subtasks.
- Add repository-aware project creation and discovery tools, including
multiple repository IDs and GitHub URLs, authorization, idempotency, and
durable project-created cards.
- Reuse task UI components for chat, with starred/recent agent
navigation and a separate `enableAgentChat` experimental flag.
- Add deterministic browser tests and 24 paid chat cells across four
Codex/Claude profiles, with validated reports and screenshots.
- Integrate current master recovery, controller lease, queued-message,
and task UI changes. Gate chat interruption and deferred promotion on
ownership/feature policy. Guarantee lease renewal and active controls
are stopped even if teardown fails.
- Preserve master's migration 0273 and generate chat migration 0274 with
idempotent replay for development databases.

## Verification

- Prior exact heads of all four PRs passed Linux CI, including build,
typecheck, general/serialized tests, and browser E2E. Each had Greptile
5/5 and no unresolved findings.
- Integrated local verification passed: full repository typecheck and
production build, Storybook build, token gates, 340 focused UI tests,
all 20 deterministic chat browser tests, two migration replay tests, 88
focused chat/queue/native/controller tests, and provider/session
regressions including real lease expiry. These include the three
lifecycle regressions for the final admission/teardown fixes; server
typecheck also passes. Current head
`1268eda16cc2af892055917e7292f068820be135` has Greptile 5/5 with no
unresolved findings and passing security scans. All final-head CI gates
passed: build, full Runner verification, typecheck/release registry,
canary, all general/serialized test shards, and all browser E2E shards
([CI
run](https://github.com/paperclipai/paperclip/actions/runs/34696739927)).
Local PostgreSQL startup contention required serialized retries; skipped
fixtures do not count as passing coverage.
- The earlier paid campaign passed all 24 chat cells and retained 32
screenshots:
[report](https://d1p6rlowie26tp.cloudfront.net/runner-e2e/campaigns/gha-34648511170-1/index.html?report=agent-chat#suite-agent-chat).
It tested `abacbdfd2f660709ec37312cdb758284c8399d04`; it is prior
evidence, not a paid run of this integrated head.
- Manual check: enable Agent Chat in Experimental settings, open an
agent, clarify and revise a plan, then hand off to an assigned project
task. Stop a reply, send `/new`, and verify fresh context with retained
history. Disable the setting and verify agent shortcuts/new chat turns
are blocked.

## Risks

- Queue/session integration can affect retries and delayed writes. Tests
cover ownership, cancellation, reset boundaries, idle recovery, and
ordinary task behavior.
- Migration 0274 adds conversation fields and constraints. Replay is
idempotent and preserves existing development chat history.
- This combines the previously reviewed stack at the maintainer's
request. Agent Chat remains off by default and is separate from
Conference Room.

## Model Used

OpenAI Codex, GPT-6 Astra (`gpt-6-astra`), with reasoning, code
execution, browser tools, and parallel review. The exact context-window
size is not exposed in this session. Codex and Claude also ran as test
subjects in the linked paid campaign.

## 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 (e.g. `docs/...`, `fix/...`)
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-12 08:56:04 -05:00
..
scripts
skills/paperclip-task-bridge
src
LICENSE
README.md
gateway-ui-parser.cjs
package.json
tsconfig.json
ui-parser.cjs
vitest.config.ts

README.md

Paperclip Adapters for Hermes Agent

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.

Key Features

This adapter provides:

  • 8 inference providers — Anthropic, OpenRouter, OpenAI, Nous, OpenAI Codex, ZAI, Kimi Coding, MiniMax
  • Skills integration — Scans both Paperclip-managed and Hermes-native skills (~/.hermes/skills/), with sync/list/resolve APIs
  • Structured transcript parsing — Raw Hermes stdout is parsed into typed TranscriptEntry objects so Paperclip renders proper tool cards with status icons and expand/collapse
  • Rich post-processing — Converts Hermes ASCII banners, setext headings, and +--+ table borders into clean GFM markdown
  • Comment-driven wakes — Agents wake to respond to issue comments, not just task assignments
  • Auto model detection — Reads ~/.hermes/config.yaml to pre-populate the UI with the user's configured model
  • Session codec — Structured validation and migration of session state across heartbeats
  • Benign stderr reclassification — MCP init messages and structured logs are reclassified so they don't appear as errors in the UI
  • Session source tagging — Sessions are tagged as tool source so they don't clutter the user's interactive history
  • Filesystem checkpoints — Optional --checkpoints for rollback safety
  • Thinking effort control — Passes --reasoning-effort for thinking/reasoning models

Hermes Agent Capabilities

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

Installation

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.

Prerequisites

  • Hermes Agent installed (pip install hermes-agent)
  • Python 3.10+
  • At least one LLM API key (Anthropic, OpenRouter, or OpenAI)

Quick Start

1. Optional: override the built-in for adapter development

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.

2. Create a local Hermes agent in Paperclip

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.

3. Create a Hermes gateway agent in Paperclip

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.

Compatibility with the old gateway package

@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.

Runtime API guidance

Hermes receives Paperclip runtime identity through environment variables:

  • PAPERCLIP_API_URL
  • PAPERCLIP_API_KEY
  • PAPERCLIP_RUN_ID

Prompts 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.

Hermes-originated Paperclip tasks

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_ID
  • PAPERCLIP_AGENT_ID
  • PAPERCLIP_RUN_ID

The 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.

4. Assign work

Create issues in Paperclip and assign them to your Hermes agent. On each heartbeat, Hermes will:

  1. Receive the task instructions
  2. Use its full tool suite to complete the work
  3. Report results back to Paperclip
  4. Persist session state for continuity

Configuration Reference

Core

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

Tools

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

Session & Workspace

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

Advanced

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

Prompt Template Variables

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 comment

Architecture

Paperclip                          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:

  1. Captures stdout/stderr and parses token usage, session IDs, and cost
  2. Parses raw output into structured TranscriptEntry objects (tool cards with status icons)
  3. Post-processes Hermes ASCII formatting (banners, setext headings, table borders) into clean GFM markdown
  4. Reclassifies benign stderr (MCP init, structured logs) so they don't show as errors
  5. Tags sessions as tool source to keep them separate from interactive usage
  6. Reports results back to Paperclip with cost, usage, and session state

Session 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.

Skills Integration

The adapter scans two skill sources and merges them:

  • Paperclip-managed skills — bundled with the adapter, togglable from the UI
  • Hermes-native skills — from ~/.hermes/skills/, read-only, always loaded

The listSkills / syncSkills APIs expose a unified snapshot so the Paperclip UI can display both managed and native skills in one view.

Development

git clone https://github.com/paperclipai/paperclip
cd paperclip/packages/adapters/hermes
pnpm install
pnpm build

License

MIT — see LICENSE