mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-10 20:50:08 +02:00
DottaandPaperclip
fd2f82ac5b
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Agent adapters are the boundary between the control plane and the runtimes that actually do work. > - Hermes support needs to be available as first-class local and gateway adapters while still preserving the adapter-manager override path for external packages. > - The adapter work touches runtime execution, UI adapter metadata, onboarding prompts, scoped credentials, release packaging, and smoke coverage, so the handoff needs concrete verification rather than only unit tests. > - This pull request adds built-in Hermes local and Hermes gateway support, keeps external adapter overrides compatible, and documents/tests the gateway flow end to end. > - The benefit is that operators can hire Hermes-backed agents without a manual plugin install, while self-hosted installs can still override/shadow the built-ins through Adapter manager packages. ## Linked Issues or Issue Description No public GitHub issue exists for this exact Hermes built-in adapter, gateway onboarding, and release-source work. Problem description: - Hermes local and gateway adapters need a public, reviewable source path in the monorepo so package artifacts and built-in adapter behavior match the application source. - Operators need built-in `hermes_local` and `hermes_gateway` adapter choices without losing the ability to install external Hermes packages as overrides. - Gateway onboarding needs secure defaults for API server URLs, API keys, and generated agent setup text. - Hermes-originated task bridge credentials need narrower API-key scope configuration. - Related public PRs found during duplicate search include #3027, #2363, #7544, #7950, #8095, and #8543. ## What Changed - Added the unified Hermes adapter package with local and gateway server/UI/CLI exports, config schemas, transcript parsing, model detection, and package metadata. - Registered `hermes_local` and `hermes_gateway` as built-in adapters across shared constants, server registries, CLI packaging, and UI adapter registries. - Kept the external adapter override path compatible so installed Hermes packages can shadow built-ins and restore the built-in parser when disabled. - Added Hermes gateway onboarding docs, board-operator docs, Docker smoke assets, and shell smoke harnesses for join/e2e validation. - Added scoped task-bridge API-key support, authorization checks, issue-origin handling, and tests for Hermes-created Paperclip tasks. - Hardened gateway transport and redaction behavior for API keys, headers, session data, and smoke diagnostics. - Updated release packaging/bootstrap checks for the Hermes packages while leaving `pnpm-lock.yaml` out of the PR per repository policy. ## Verification Targeted local verification recorded before PR handoff: - `pnpm --filter @paperclipai/hermes-paperclip-adapter exec vitest run src/gateway/server/execute.test.ts` — 14/14 passed. - `pnpm test:hermes-gateway-smoke` — 6/6 passed. - Hermes package typecheck/build checks passed. - Focused server/UI adapter tests passed — 31/31. - Release helper Node tests passed — 18/18. - `git diff --check origin/master..HEAD` passed. Fresh Docker E2E smoke evidence: - Ran `pnpm smoke:hermes-gateway-e2e` on 2026-06-26 with a fresh state directory and fresh Docker container against a live Paperclip dev server. - Hermes direct execution reached `completed`. - Hermes stop/cancel path reached `cancelled`. - Hermes gateway created a Paperclip task, Paperclip ran the Hermes agent, and the task reached `done` with the expected marker response. - Temporary board auth keys, token files, smoke state, and Docker containers were cleaned up after the run. PR checks on head `b5eae40ce`: - GitHub Actions passed: `policy`, `review`, `Typecheck + Release Registry`, all general test shards, all serialized server shards, `Build`, `Canary Dry Run`, `e2e`, and aggregate `verify`. - External checks passed: Snyk and Socket Project Report. - External Socket Pull Request Alerts remained pending after the first-party CI matrix completed. ## Risks - Medium risk: this spans adapter registration, package publishing, gateway execution, onboarding docs, API-key scoping, and UI adapter metadata. - Migration risk is low: the scope-config migration adds a nullable column and does not rewrite existing keys. - Gateway execution depends on operator-provided Hermes API configuration; the smoke covers the Docker gateway path but real deployments may differ by network/auth setup. - Direct Greptile review on the latest expanded diff is file-count limited, although the commitperclip review gate passed. > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected — check the roadmap first. See `CONTRIBUTING.md`. ## Model Used OpenAI Codex, GPT-5 coding agent, tool use enabled in a local repository workspace. Context window size is not exposed in this environment. ## 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] Commitperclip review gate is green; direct Greptile review is file-count limited on the latest expanded diff - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
105 lines
2.8 KiB
TypeScript
105 lines
2.8 KiB
TypeScript
/**
|
|
* Shared constants for the Hermes Agent adapter.
|
|
*/
|
|
|
|
/** Adapter type identifier registered with Paperclip. */
|
|
export const ADAPTER_TYPE = "hermes_local";
|
|
|
|
/** Human-readable label shown in the Paperclip UI. */
|
|
export const ADAPTER_LABEL = "Hermes Agent";
|
|
|
|
/** Default CLI binary name. */
|
|
export const HERMES_CLI = "hermes";
|
|
|
|
/** Default timeout for a single execution run (seconds). */
|
|
export const DEFAULT_TIMEOUT_SEC = 1800;
|
|
|
|
/** Grace period after SIGTERM before SIGKILL (seconds). */
|
|
export const DEFAULT_GRACE_SEC = 10;
|
|
|
|
/**
|
|
* Default model to use if none specified.
|
|
*
|
|
* Use "auto" so that Hermes resolves the model from the user's local
|
|
* ~/.hermes/config.yaml — preventing the adapter from overriding a
|
|
* user's configured default (e.g. MiniMax, OpenRouter, etc.) with a
|
|
* hardcoded Anthropic model during Paperclip onboarding.
|
|
*/
|
|
export const DEFAULT_MODEL = "auto";
|
|
|
|
/**
|
|
* Valid --provider choices for the hermes CLI.
|
|
* Must stay in sync with `hermes chat --help`.
|
|
*/
|
|
export const VALID_PROVIDERS = [
|
|
"auto",
|
|
"openrouter",
|
|
"nous",
|
|
"openai-codex",
|
|
"copilot",
|
|
"copilot-acp",
|
|
"anthropic",
|
|
"huggingface",
|
|
"zai",
|
|
"kimi-coding",
|
|
"minimax",
|
|
"minimax-cn",
|
|
"kilocode",
|
|
] as const;
|
|
|
|
/**
|
|
* Model-name prefix → provider hint mapping.
|
|
* Used when no explicit provider is configured and we need to infer
|
|
* the correct provider from the model string alone.
|
|
*
|
|
* Keys are lowercased prefix patterns; values must be valid provider names.
|
|
* Longer prefixes are matched first (order matters).
|
|
*/
|
|
export const MODEL_PREFIX_PROVIDER_HINTS: [string, string][] = [
|
|
// OpenAI-native models
|
|
["gpt-4", "openai-codex"],
|
|
["gpt-5", "copilot"],
|
|
["o1-", "openai-codex"],
|
|
["o3-", "openai-codex"],
|
|
["o4-", "openai-codex"],
|
|
// Anthropic models
|
|
["claude", "anthropic"],
|
|
// Google models (via openrouter or direct)
|
|
["gemini", "auto"],
|
|
// Nous models
|
|
["hermes-", "nous"],
|
|
// Z.AI / GLM models
|
|
["glm-", "zai"],
|
|
// Kimi / Moonshot
|
|
["moonshot", "kimi-coding"],
|
|
["kimi", "kimi-coding"],
|
|
// MiniMax
|
|
["minimax", "minimax"],
|
|
// DeepSeek
|
|
["deepseek", "auto"],
|
|
// Meta Llama
|
|
["llama", "auto"],
|
|
// Qwen
|
|
["qwen", "auto"],
|
|
// Mistral
|
|
["mistral", "auto"],
|
|
// HuggingFace models (org/model format)
|
|
["huggingface/", "huggingface"],
|
|
];
|
|
|
|
/** Regex to extract session ID from Hermes CLI output. */
|
|
export const SESSION_ID_REGEX = /session[_ ](?:id|saved)[:\s]+([a-zA-Z0-9_-]+)/i;
|
|
|
|
/** Regex to extract token usage from Hermes output. */
|
|
export const TOKEN_USAGE_REGEX =
|
|
/tokens?[:\s]+(\d+)\s*(?:input|in)\b.*?(\d+)\s*(?:output|out)\b/i;
|
|
|
|
/** Regex to extract cost from Hermes output. */
|
|
export const COST_REGEX = /(?:cost|spent)[:\s]*\$?([\d.]+)/i;
|
|
|
|
/** Prefix used by Hermes for tool output lines. */
|
|
export const TOOL_OUTPUT_PREFIX = "┊";
|
|
|
|
/** Prefix for Hermes thinking blocks. */
|
|
export const THINKING_PREFIX = "💭";
|