mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-24 10:13:11 +02:00
## 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>
194 lines
4.8 KiB
JavaScript
194 lines
4.8 KiB
JavaScript
"use strict";
|
|
|
|
const TOOL_OUTPUT_PREFIX = "\u250a";
|
|
|
|
function stripKaomoji(text) {
|
|
return text.replace(/[(][^()]{2,20}[)]\s*/gu, "").trim();
|
|
}
|
|
|
|
function isAssistantToolLine(stripped) {
|
|
return /^\u250a\s*\u{1f4ac}/u.test(stripped);
|
|
}
|
|
|
|
function extractAssistantText(line) {
|
|
return line.replace(/^[\s\u250a]*\u{1f4ac}\s*/u, "").trim();
|
|
}
|
|
|
|
function parseToolCompletionLine(line) {
|
|
let cleaned = line.trim().replace(/^\[done\]\s*/, "");
|
|
if (!cleaned.startsWith(TOOL_OUTPUT_PREFIX)) return null;
|
|
|
|
cleaned = cleaned.slice(TOOL_OUTPUT_PREFIX.length);
|
|
cleaned = stripKaomoji(cleaned).trim();
|
|
|
|
const durationMatch = cleaned.match(/([\d.]+s)\s*(?:\([\d.]+s\))?\s*$/);
|
|
const duration = durationMatch ? durationMatch[1] : "";
|
|
const verbAndDetail = durationMatch
|
|
? cleaned.slice(0, cleaned.lastIndexOf(durationMatch[0])).trim()
|
|
: cleaned;
|
|
const detailWithoutEmoji = verbAndDetail.replace(/^\p{Emoji_Presentation}\s*/u, "");
|
|
|
|
const hasError = /\[(?:exit \d+|error|full)\]/.test(detailWithoutEmoji) ||
|
|
/\[error\]\s*$/.test(cleaned);
|
|
|
|
const parts = detailWithoutEmoji.match(/^(\S+)\s+(.*)/);
|
|
if (!parts) {
|
|
return { name: "tool", detail: detailWithoutEmoji, duration, hasError };
|
|
}
|
|
|
|
const verb = parts[1];
|
|
const detail = parts[2].trim();
|
|
const nameMap = {
|
|
"$": "shell",
|
|
exec: "shell",
|
|
terminal: "shell",
|
|
search: "search",
|
|
fetch: "fetch",
|
|
crawl: "crawl",
|
|
navigate: "browser",
|
|
snapshot: "browser",
|
|
click: "browser",
|
|
type: "browser",
|
|
scroll: "browser",
|
|
back: "browser",
|
|
press: "browser",
|
|
close: "browser",
|
|
images: "browser",
|
|
vision: "browser",
|
|
read: "read",
|
|
write: "write",
|
|
patch: "patch",
|
|
grep: "search",
|
|
find: "search",
|
|
plan: "plan",
|
|
recall: "recall",
|
|
proc: "process",
|
|
delegate: "delegate",
|
|
todo: "todo",
|
|
memory: "memory",
|
|
clarify: "clarify",
|
|
session_search: "recall",
|
|
code: "execute",
|
|
execute: "execute",
|
|
web_search: "search",
|
|
web_extract: "fetch",
|
|
browser_navigate: "browser",
|
|
browser_click: "browser",
|
|
browser_type: "browser",
|
|
browser_snapshot: "browser",
|
|
browser_vision: "browser",
|
|
browser_scroll: "browser",
|
|
browser_press: "browser",
|
|
browser_back: "browser",
|
|
browser_close: "browser",
|
|
browser_get_images: "browser",
|
|
read_file: "read",
|
|
write_file: "write_file",
|
|
search_files: "search",
|
|
patch_file: "patch",
|
|
execute_code: "execute",
|
|
};
|
|
|
|
return {
|
|
name: nameMap[verb.toLowerCase()] || verb,
|
|
detail,
|
|
duration,
|
|
hasError,
|
|
};
|
|
}
|
|
|
|
let toolCallCounter = 0;
|
|
|
|
function syntheticToolUseId() {
|
|
toolCallCounter += 1;
|
|
return `hermes-tool-${toolCallCounter}`;
|
|
}
|
|
|
|
function isThinkingLine(line) {
|
|
return (
|
|
line.includes("\u{1f4ad}") ||
|
|
line.startsWith("<thinking>") ||
|
|
line.startsWith("</thinking>") ||
|
|
line.startsWith("Thinking:")
|
|
);
|
|
}
|
|
|
|
function parseStdoutLine(line, ts) {
|
|
const trimmed = line.trim();
|
|
if (!trimmed) return [];
|
|
|
|
if (trimmed.startsWith("[hermes]") || trimmed.startsWith("[paperclip]")) {
|
|
return [{ kind: "system", ts, text: trimmed }];
|
|
}
|
|
|
|
if (trimmed.startsWith("[tool]")) {
|
|
return [];
|
|
}
|
|
|
|
if (/^\[\d{4}-\d{2}-\d{2}T/.test(trimmed)) {
|
|
return [{ kind: "stderr", ts, text: trimmed }];
|
|
}
|
|
|
|
if (/^\p{Emoji_Presentation}\s*(Completed|Running|Error)?\s*$/u.test(trimmed)) {
|
|
return [];
|
|
}
|
|
|
|
if (trimmed.startsWith("session_id:")) {
|
|
return [{ kind: "system", ts, text: trimmed }];
|
|
}
|
|
|
|
if (trimmed.includes(TOOL_OUTPUT_PREFIX)) {
|
|
if (isAssistantToolLine(trimmed)) {
|
|
return [{ kind: "assistant", ts, text: extractAssistantText(trimmed) }];
|
|
}
|
|
|
|
const toolInfo = parseToolCompletionLine(trimmed);
|
|
if (toolInfo) {
|
|
const id = syntheticToolUseId();
|
|
const detailText = toolInfo.duration
|
|
? `${toolInfo.detail} ${toolInfo.duration}`
|
|
: toolInfo.detail;
|
|
|
|
return [
|
|
{
|
|
kind: "tool_call",
|
|
ts,
|
|
name: toolInfo.name,
|
|
input: { detail: toolInfo.detail },
|
|
toolUseId: id,
|
|
},
|
|
{
|
|
kind: "tool_result",
|
|
ts,
|
|
toolUseId: id,
|
|
content: detailText,
|
|
isError: toolInfo.hasError,
|
|
},
|
|
];
|
|
}
|
|
|
|
const escapedPrefix = TOOL_OUTPUT_PREFIX.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
|
|
const stripped = trimmed
|
|
.replace(/^\[done\]\s*/, "")
|
|
.replace(new RegExp(`^${escapedPrefix}\\s*`), "")
|
|
.trim();
|
|
return [{ kind: "stdout", ts, text: stripped }];
|
|
}
|
|
|
|
if (isThinkingLine(trimmed)) {
|
|
return [{ kind: "thinking", ts, text: trimmed.replace(/^\u{1f4ad}\s*/u, "") }];
|
|
}
|
|
|
|
if (
|
|
trimmed.startsWith("Error:") ||
|
|
trimmed.startsWith("ERROR:") ||
|
|
trimmed.startsWith("Traceback")
|
|
) {
|
|
return [{ kind: "stderr", ts, text: trimmed }];
|
|
}
|
|
|
|
return [{ kind: "assistant", ts, text: trimmed }];
|
|
}
|
|
|
|
module.exports = { parseStdoutLine };
|