mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-10 20:50:08 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Adapter packages are the bridge between the control plane and local agent harnesses such as Claude Code, Codex, and Gemini CLI. > - ACP support was concentrated in a separate `acpx_local` adapter, which made ACP feel like a separate agent choice instead of an execution capability of the harness adapters. > - Claude, Codex, and Gemini now have ACP-capable harnesses, so the native adapter should own ACP selection, fallback, config, transcript parsing, and environment diagnostics. > - The standalone ACPX adapter still needs a compatibility path for existing rows, but it should not be offered as an active adapter for new agents. > - This pull request moves the shared ACP runtime into `@paperclipai/acpx-engine`, wires Claude/Codex/Gemini local adapters to prefer ACP when prerequisites are available, and retires `acpx_local` to a tombstone. > - The benefit is one adapter per harness, richer ACP transcripts by default where possible, and a migration path for existing Claude/Codex ACPX agents. ## Linked Issues or Issue Description Closes #5932 — the broken default `acpx_local` Claude path is replaced by native `claude_local` ACP support, existing Claude/Codex ACPX rows migrate to native adapters, and new agents no longer choose the standalone ACPX adapter. Refs #4893 — original merged ACPX local adapter runtime that this PR replaces with native per-harness ACP engines. Refs #6590 — prior ACPX-Claude seamlessness work folded into the new native Claude ACP path. Refs #197 — related open generic ACP/Kiro adapter work; this PR does not close it because Kiro/custom generic ACP remains a separate adapter decision. Refs #7018 — related Kimi-specific `acpx_local` shell failure; this PR retires the built-in standalone adapter but does not add a native Kimi adapter. Refs #8864 — related ACPX prompt/API guidance PR; this PR moves runtime guidance into the shared/native ACP engine path instead of the old standalone adapter. Refs #8881 — related `acpx_local` POSIX shell failure from the old `acpx` pin; this PR updates ACP dependencies but does not claim custom/OMP ACP support as a first-class native adapter. Refs #8964 — related open `acpx_local` stderr cleanup PR; this PR makes the old runtime path obsolete for new agents but keeps it as a non-closing reference. Problem description: - The standalone `acpx_local` adapter duplicates Claude/Codex agent choices that already have first-class local adapters. - ACP should be an execution engine capability of each harness adapter when the underlying harness supports ACP. - Existing `acpx_local` agents should either migrate to native harness adapters or fail with an explicit retirement message instead of silently falling back to the process adapter. ## What Changed - Added `@paperclipai/acpx-engine` as the shared ACP execution, session-codec, CLI formatter, and UI parser package. - Wired `claude_local`, `codex_local`, and `gemini_local` to auto-select ACP by default when prerequisites pass, with `engine=cli` opt-out and `engine=acp` strict mode. - Added ACP config schema/UI fields, environment checks, session-codec preservation, transcript parsing, and adapter capability metadata for the native adapters. - Retired `acpx_local` to a server tombstone, removed its UI/package/runtime image surface, and added a migration for existing Claude/Codex ACPX agents. - Updated package manifests, lockfile, release tooling, docs, Kubernetes sandbox defaults, and tests. ## Verification - `corepack pnpm --filter @paperclipai/acpx-engine typecheck` - `corepack pnpm --filter @paperclipai/adapter-claude-local typecheck` - `corepack pnpm --filter @paperclipai/adapter-codex-local typecheck` - `corepack pnpm --filter @paperclipai/adapter-gemini-local typecheck` - `corepack pnpm --filter @paperclipai/acpx-engine exec vitest run` - `corepack pnpm --filter @paperclipai/adapter-claude-local exec vitest run src/server/acp.test.ts src/server/execute.acp-fallback.test.ts src/ui/build-config.test.ts` - `corepack pnpm --filter @paperclipai/adapter-codex-local exec vitest run src/server/acp.test.ts src/ui/build-config.test.ts` - `corepack pnpm --filter @paperclipai/adapter-gemini-local exec vitest run src/server/acp.test.ts src/ui/build-config.test.ts src/ui/parse-stdout.test.ts` - `corepack pnpm --filter @paperclipai/plugin-sdk ensure-build-deps && corepack pnpm --filter @paperclipai/server exec tsc --noEmit` - `corepack pnpm --filter @paperclipai/server exec vitest run src/__tests__/adapter-routes.test.ts src/__tests__/adapter-session-codecs.test.ts src/__tests__/adapter-models.test.ts` - `corepack pnpm --filter @paperclipai/ui typecheck` - `corepack pnpm --filter @paperclipai/ui exec vitest run src/adapters/metadata.test.ts src/adapters/adapter-display-registry.test.ts src/components/AgentConfigForm.test.ts src/components/AgentConfigForm.render.test.tsx src/components/transcript/RunTranscriptView.test.tsx` - `node --test scripts/bootstrap-npm-package.test.mjs scripts/release-package-map.test.mjs scripts/verify-release-registry-state.test.mjs` Note: the server typecheck script calls `pnpm` internally; this dev shell exposes pnpm through Corepack only, so I ran the two script steps manually with `corepack pnpm`. ## Risks - Migration changes existing `acpx_local` Claude/Codex agents to native adapter types and clears old ACPX task sessions/runtime state. - Custom ACP commands remain on the retired tombstone and will need a separate future adapter/plugin path. - ACP auto-selection depends on local Node and ACP server command prerequisites; remote and unsupported environments fall back to CLI unless `engine=acp` is explicit. - `@paperclipai/acpx-engine` is a new public package and needs npm trusted-publishing bootstrap before release automation can publish it. > 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 GPT-5 via Codex coding agent. Exact hosted model build and context-window size are not exposed in this runtime. Tool use included shell execution, repository editing, GitHub CLI operations, and local test/typecheck execution. ## 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>
122 lines
4.0 KiB
TypeScript
122 lines
4.0 KiB
TypeScript
import pc from "picocolors";
|
|
|
|
function parseJson(line: string): Record<string, unknown> | null {
|
|
try {
|
|
const parsed = JSON.parse(line);
|
|
if (typeof parsed !== "object" || parsed === null || Array.isArray(parsed)) return null;
|
|
return parsed as Record<string, unknown>;
|
|
} catch {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
function asString(value: unknown, fallback = ""): string {
|
|
return typeof value === "string" ? value : fallback;
|
|
}
|
|
|
|
function asNumber(value: unknown, fallback = 0): number {
|
|
return typeof value === "number" && Number.isFinite(value) ? value : fallback;
|
|
}
|
|
|
|
function stringify(value: unknown): string {
|
|
if (typeof value === "string") return value;
|
|
if (value === null || value === undefined) return "";
|
|
try {
|
|
return JSON.stringify(value, null, 2);
|
|
} catch {
|
|
return String(value);
|
|
}
|
|
}
|
|
|
|
function pickToolUseId(parsed: Record<string, unknown>): string {
|
|
return (
|
|
asString(parsed.toolCallId) ||
|
|
asString(parsed.toolUseId) ||
|
|
asString(parsed.id)
|
|
);
|
|
}
|
|
|
|
function statusLine(parsed: Record<string, unknown>): string {
|
|
const text = asString(parsed.text).trim();
|
|
const tag = asString(parsed.tag).trim();
|
|
const used = asNumber(parsed.used, -1);
|
|
const size = asNumber(parsed.size, -1);
|
|
const parts: string[] = [];
|
|
if (text) parts.push(text);
|
|
if (tag && !text) parts.push(tag);
|
|
if (used >= 0 && size > 0) parts.push(`(${used}/${size} ctx)`);
|
|
return parts.join(" ") || tag || "status";
|
|
}
|
|
|
|
export function printAcpxStreamEvent(raw: string, debug: boolean): void {
|
|
const line = raw.trim();
|
|
if (!line) return;
|
|
const parsed = parseJson(line);
|
|
if (!parsed) {
|
|
if (debug) console.log(pc.gray(line));
|
|
else console.log(line);
|
|
return;
|
|
}
|
|
|
|
const type = asString(parsed.type);
|
|
if (type === "acpx.session") {
|
|
const agent = asString(parsed.agent, "acpx");
|
|
const session =
|
|
asString(parsed.acpSessionId) ||
|
|
asString(parsed.sessionId) ||
|
|
asString(parsed.runtimeSessionName);
|
|
const mode = asString(parsed.mode);
|
|
const permissionMode = asString(parsed.permissionMode);
|
|
const tail = [mode, permissionMode].filter(Boolean).join(" / ");
|
|
const suffix = tail ? ` [${tail}]` : "";
|
|
console.log(pc.blue(`${agent} session${session ? `: ${session}` : ""}${suffix}`));
|
|
return;
|
|
}
|
|
if (type === "acpx.text_delta") {
|
|
const text = asString(parsed.text);
|
|
if (!text) return;
|
|
const channel = asString(parsed.channel) || asString(parsed.stream);
|
|
const isThought = channel === "thought" || channel === "thinking";
|
|
if (isThought) console.log(pc.gray(text));
|
|
else process.stdout.write(pc.green(text));
|
|
return;
|
|
}
|
|
if (type === "acpx.tool_call") {
|
|
const name = asString(parsed.name, "acp_tool");
|
|
const status = asString(parsed.status);
|
|
const id = pickToolUseId(parsed);
|
|
const header = status ? `tool_call: ${name} [${status}]` : `tool_call: ${name}`;
|
|
const idSuffix = id ? ` (${id})` : "";
|
|
const isError = status === "failed" || status === "cancelled";
|
|
console.log((isError ? pc.red : pc.yellow)(`${header}${idSuffix}`));
|
|
if (parsed.input !== undefined) {
|
|
console.log(pc.gray(stringify(parsed.input)));
|
|
} else {
|
|
const text = asString(parsed.text).trim();
|
|
if (text) console.log(pc.gray(text));
|
|
}
|
|
return;
|
|
}
|
|
if (type === "acpx.tool_result") {
|
|
const isError = parsed.isError === true || parsed.error !== undefined;
|
|
console.log((isError ? pc.red : pc.cyan)(`tool_result: ${asString(parsed.name, "acp_tool")}`));
|
|
const content = stringify(parsed.content ?? parsed.output ?? parsed.error);
|
|
if (content) console.log((isError ? pc.red : pc.gray)(content));
|
|
return;
|
|
}
|
|
if (type === "acpx.status") {
|
|
console.log(pc.gray(`status: ${statusLine(parsed)}`));
|
|
return;
|
|
}
|
|
if (type === "acpx.result") {
|
|
const summary = asString(parsed.summary, asString(parsed.stopReason, asString(parsed.subtype, "complete")));
|
|
console.log(pc.blue(`result: ${summary}`));
|
|
return;
|
|
}
|
|
if (type === "acpx.error") {
|
|
console.log(pc.red(`error: ${asString(parsed.message, line)}`));
|
|
return;
|
|
}
|
|
console.log(debug ? pc.gray(line) : line);
|
|
}
|