mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-16 05:17:41 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - The native Runner keeps provider sessions under company authority, approvals, budgets and durable recovery. > - Cursor work was spread across candidate branches. The published branch lacked later plan, permission and cleanup fixes. > - Production also needs public installation and matching runtime assets for local and Daytona execution. > - This pull request consolidates Cursor onto current mainline recovery behavior and completes that installation path. > - The installed v11 release passed focused local and Daytona qualification after the generic mode and lifecycle cleanup. The later model-selection correction and current mainline merge produce v14 artifacts that need matching release qualification. > - Cursor admission is enabled in source; publish only an artifact combination with matching qualification. Native AskQuestion and complete per-run dollar accounting remain excluded. ## Linked Issues or Issue Description Refs: #14435, #14631, #14669, #14699, #14724. This completes the Cursor implementation by @cryppadotta from combined source `22c78242a4e0c2369fecf0c2dc4e7600fbad6706`. It preserves newer mainline recovery, completion and warm-directory behavior. Pi and Copilot remain gated. ## What Changed - Generate named Rust and TypeScript ACPX release profiles from one manifest. Share runtime pins with packaging and server verification. Preserve vendor runtime versions; bind the updated ACPX patch to Cursor profile v14 and reject stale generated declarations at build/typecheck. - Remove ACPX model allowlists, including the former Codex and Pi restrictions and the duplicate developer test-drive gate. Send any explicit model ID unchanged to its provider and verify the effective selection before prompting. The bundled ACPX package forwards unlisted IDs, rejects mismatched acknowledgements, and restores the exact selection after session load. It does not expand Cursor model aliases. Provider rejection, mismatch, or missing model controls fails without a fallback. Model examples live in evaluation fixtures, outside runtime declarations. - Add pinned Cursor execution, contained instructions, exact model verification and Agent/Plan/Ask modes. - Carry an opaque generic `mode` identifier in shared native execution, sidecar, Rust and recovery contracts. The provider adapter owns supported modes, defaults, native translation and acknowledgement. - Keep native RPC recognition, accepted-plan interpretation and permission evidence behind provider adapters. Shared settlement and recovery verify normalized facts and their committed evidence. - Replace the Cursor-only warm-attachment branch with a runner-owned capability. Only Cursor opts into it. Move profile compatibility and optional usage parsing into provider metadata and adapters. - Write generic plan-wait receipts. Read exact historical Cursor receipts through a separate compatibility decoder. Reject mixed formats and preserve existing authority checks. - Carry native plans, semantic questions, todos, child activity, permission identities and partial usage diagnostics through the Runner. - Preserve durable response delivery, cancellation, warm ownership and process retirement. - Finish accepted planning runs successfully. Keep their tasks open for explicit direction. Acceptance does not start implementation. - Ship `paperclipai runtime setup cursor` and its provisioner through the public package. npm installation does not download Cursor. Setup uses the OS account's closure-keyed cache so system-wide npm packages can remain read-only. Run it as the Paperclip service account. - Include Cursor in normal provider packs and Daytona images for macOS ARM64/x64 and Linux x64. - Reject stale release packs by source revision and current ACPX/Cursor pins before assembly writes files. Verify current Cursor version/profile/closure again at runtime. - Ship all three daemon targets and the expected Linux image-pack identity. A macOS controller uses its packaged Linux daemon for Daytona. Image mismatches fail before provider launch. - Use the vendored Runner boundary for installed readiness probes. Verify the actual installed Cursor probe. - Verify compiled public Daytona plugins and their release versions in installed smokes. - Record exact artifacts, the acceptance matrix, retained failures, supported capabilities and rollback behavior in the [readiness report](https://github.com/paperclipai/paperclip/blob/codex/cursor-production-readiness/doc/plans/2026-10-03-cursor-production-readiness.md). ## Verification - Current head `f7ec5cc1f0e30c62a829c016ff2013a2a9d79037` merges mainline `faa8e452c73bae5e044dd6379179a00106abb131`. It keeps Cursor plan and cancellation guards alongside mainline historical-question filtering. The evaluation catalog includes both Cursor and expanded adapter accounting cases (683 total). Recursive typecheck, full build, 696 lifecycle/recovery tests, 45 fixture tests and fixture typecheck passed. Current-head CI passed: 56 successful checks, one neutral and four skipped. [Complete CI](https://github.com/paperclipai/paperclip/actions/runs/37557996535). The fresh Base Greptile review is 5/5 on this exact head, with 304 files reviewed, zero new comments and zero unresolved threads. The user authorized overriding the CODEOWNER review gate after checks passed; no failing checks are overridden. Prior results below retain their own head identities. - Corrective head `3d2b168366258036f6b6a6fccb382c49138cc601` fixes the post-merge Apex finding. Automatic-review and new-evidence reconciliation preserve pending child results and recheck delivery under the status lock before completing. Account repair now excludes unrelated secret consumers and requires the failed agent's identity. Regression coverage includes the commit race, delivery statuses, current-run/current-intent exclusions, repeated reconciliation, both database reconciliation paths, and credential consumer boundaries. All 184 affected tests, server typecheck and server build passed. Current-head Base Greptile review is 5/5, with 304 files reviewed, zero new comments and zero unresolved threads. Current-head CI passed: 56 successful checks, one neutral and four skipped. [Complete CI](https://github.com/paperclipai/paperclip/actions/runs/37535994724). This Base review is distinct from the earlier Apex review. - Merge head `5957c257a` reconciles mainline `b508a05c4`. It preserves both accepted-plan waits and pending-child-completion checks, current provider selectors, task-creation response identities, and mainline ACPX missing-file handling. The combined patch is bound to Cursor profile v14; historical records keep their original identities. - Merge head `5957c257a` passed recursive typecheck, full build, 43 installed ACPX/package contracts, 107 provider UI and plan/recovery tests, 593 database-backed lifecycle tests, 49 profile/native contract tests, 45 Product E2E fixture tests, fixture typecheck, token gates, three provider-free browser task-creation cases, and Runner conformance/replay checks. Its complete CI passed (55 successful checks, one neutral and four skipped), while Apex returned 2/5 with a child-delivery finding addressed below. - The local full-suite attempt again failed the unchanged Git streaming test (360-second timeout) and was stopped. The concurrent local Rust attempt failed four unchanged Codex process/deadline tests; all four passed serially without code changes in 7.29 seconds after removing the competing test load. These failed commands are retained and are not reported as full-suite passes; the fresh Linux CI runs are tracked separately. - The previous head `907bdb2a2778c7ffeb4a662a91460c9d1ddfc9c5` earned Apex 5/5 with zero comments after fixing all three findings: per-user install cache, stale release-pack rejection, and public Linux smoke account/home handling. Its real built installer passed from read-only public packages on macOS ARM64 and Linux x64. All 137 release-registry checks and 64 ACPX package contracts passed. That review does not cover this mainline reconciliation. - Prior `beadd3654` passed the full CI matrix; its one unchanged chat test failure and successful single retry remain in the [CI history](https://github.com/paperclipai/paperclip/actions/runs/37521449327). Historical results below remain attributed to their original builds. - Fixture follow-up `dd59d7e82b103a88b7cbd7d2c38b612c0fbbff7a` removes provider-specific model choices from generic offline ACPX tests. The fake sidecar preserves the model and session identity selected at open through suspension. Affected verification passed: 106 Rust tests and 73 TypeScript tests. This commit changes test code only; the production-code checks below retain their recorded identities. Its CI and Greptile review later passed; those results belong to that historical head. - Model-selection cleanup `9a070808b48960a41fdfd369ae0636b95af82459`: 252 focused Runner tests passed (six platform skips), covering all six ACPX agents, native model acknowledgement, rejected selections, installation integrity and recovery identity. The merged branch passed recursive typecheck, full build, token gates, server admission (19 tests), and the Product E2E catalog (45 tests). The acceptance catalog passed all four tests. The full Rust suite passed: 643 tests, 2 ignored. It verifies sidecar acknowledgement of unlisted models and rejection of model mismatches. The final commits only update Rust tests; production sources match the verified build at `65ec3279ac50185e3cda109b5cfd9b4f56105de0`. No new paid provider calls were made. - The merge preserves both Cursor and the new mainline public-MCP fixture cases. Auto-merge remains disabled; the latest follow-up status is recorded above. The local `pnpm test:run` attempt hit the unchanged Git streaming test's 300-second timeout and was interrupted before merging mainline. The broad Runner attempt found obsolete single-model assertions plus three macOS fixture-path failures caused by a `/private/tmp` override. The assertions are corrected; affected TypeScript checks passed with the standard macOS temporary directory, and the complete Rust suite passed. Neither interrupted command is a full-suite pass. - Earlier declaration-cleanup head `6f4a5e9e2` passed recursive typecheck, build, Rust and focused tests. Its CI later exposed a test expecting duplicated Grok digest literals. The current source fixes that assertion to compare launcher bytes with the shared manifest. Historical successes and failed attempts are retained; no new live provider qualification is claimed. - Previous head `e75fde6098b0ddd8cec765bfb6ecaeecb88a26a6` passed complete CI (56 successful checks, one neutral, four skipped) and Greptile 5/5. [Historical complete CI](https://github.com/paperclipai/paperclip/actions/runs/37489112305). Those results are not claimed for the cleanup head. - Frozen live application: `d7b696f9b8f79095233e9e3d56d23e6a6018dd48`. Public package version: `0.0.0-cursor-verify.3d0c9b7761c6`. The declaration cleanup preserves release pins and does not relabel that tested artifact as a build of the new source. Mainline through `e34abee670` was reconciled while preserving accepted-plan waits, provider-capacity handling, and both Cursor and public-MCP fixtures. - Clean normal installation, explicit Cursor setup and daemon resolution passed on macOS ARM64, macOS x64 under Rosetta, and Linux x64. npm lifecycle hooks ran without silently downloading Cursor. - Historical v11 live matrix: **18/18 passed with cleanup** (nine local, nine Daytona) after the generic mode and lifecycle cleanup. The campaign has 23 attempts; all five failures and their diagnoses remain recorded. Exact case identities, hashes and limits are in the readiness report. All provider calls are real, use the explicit Luna model and company-bound credentials, and run without qualification or runtime-asset overrides. - The immutable Daytona image is `ghcr.io/paperclipai/paperclip-daytona-runner@sha256:d6259b6bba094702c13fc2283bd85550849c1c53145b656fb2746778f9fa1747`. The public Daytona plugin is installed independently and its version is checked. - Recursive typecheck, full build, token gates and Runner contract/conformance/replay checks passed on the frozen application. Its complete Linux CI suite passed. The duplicate local full-suite command was incomplete after timing failures; affected repeats passed, but that command is not reported as a clean pass. - Qualification fixtures passed typecheck, 1,675 Vitest tests (one skip), 128 Node checks, three provider-free browser tests, and 150 focused lifecycle tests after the final diagnostic correction. The affected legacy Cursor command file also passed all five tests after removing its shorter 10-second override; it now inherits the suite’s standard 15-second timeout. Greptile is 5/5 on `e75fde609` with no unresolved review threads. CI results above are recorded separately from historical build results. ## Risks - Cursor v14 includes the updated ACPX dependency patch and release identity. The v11 live matrix and image below remain historical evidence. They do not certify new v14 package/image artifacts. - ACPX accepts models beyond the qualification fixtures. Availability and entitlement depend on the provider. Successful configuration is not a claim of live qualification for every model. - Shared mode is an opaque identifier. Provider adapters own its meaning. Incompatible historical sessions remain fenced; exact committed plan waits and task history remain inspectable. - Native AskQuestion is excluded. Paperclip semantic questions are supported. Authoritative per-run dollar accounting is unavailable; partial counters remain diagnostics and unknown cost is not zero. - Image input, detailed native diffs, deeper child transcripts and native plan-file export remain follow-ups. - macOS x64 has clean-install and daemon-startup proof under Rosetta, not a separate live campaign on Intel hardware. - Release only the tested package/image combination. Merging this PR does not publish npm packages or deploy that image. Later builds need their own release verification. Rollback disables new Cursor admission while preserving records and recovery inspection. - A model can fail an exact instruction: one cancelled-plan attempt returned the wrong summary marker despite correct cancellation. The unchanged repeat passed; both results remain in the report. > ROADMAP.md was checked. This completes existing native Runner/Cursor work; it does not add an independent core feature proposal. ## Model Used OpenAI Codex, GPT-6. The exact serving variant and context window are not exposed in this session. The agent used reasoning, repository inspection, code execution, protocol tests and browser-backed Product E2E tools. Cursor acceptance uses the explicit `gpt-5.6-luna[context=272k,reasoning=medium,fast=false]` model. That is the evaluated provider model. ## 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 — affected suites passed; full CI and the retained local failed attempts are recorded separately above. - [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 — 56 successful checks, one neutral and four skipped on `f7ec5cc1f0e30c62a829c016ff2013a2a9d79037` - [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups — fresh Base review passed on `f7ec5cc1f0e30c62a829c016ff2013a2a9d79037`; zero new comments and no unresolved threads. The earlier Apex finding remains fixed. - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
1179 lines
44 KiB
TypeScript
1179 lines
44 KiB
TypeScript
import type { AdapterRuntimeCommandSpec, ServerAdapterModule } from "./types.js";
|
|
import { parseAdapterModelsEnv } from "../services/adapter-models-env.js";
|
|
import { stampClaudeAgentIdHeader } from "./claude-agent-id-header.js";
|
|
import {
|
|
buildSandboxNpmInstallCommand,
|
|
getAdapterSessionManagement,
|
|
PAPERCLIP_RUNNER_PERMISSION_CAPABILITIES,
|
|
} from "@paperclipai/adapter-utils";
|
|
import type { AdapterLoginCapability } from "@paperclipai/adapter-utils";
|
|
import { runAdapterExecutionTargetShellCommand } from "@paperclipai/adapter-utils/execution-target";
|
|
import {
|
|
execute as claudeExecute,
|
|
listClaudeSkills,
|
|
syncClaudeSkills,
|
|
listClaudeModels,
|
|
refreshClaudeModels,
|
|
testEnvironment as claudeTestEnvironment,
|
|
sessionCodec as claudeSessionCodec,
|
|
getQuotaWindows as claudeGetQuotaWindows,
|
|
getConfigSchema as getClaudeConfigSchema,
|
|
CLAUDE_SETUP_TOKEN_COMMAND,
|
|
parseSetupTokenPrompt,
|
|
parseSetupTokenCredential,
|
|
} from "@paperclipai/adapter-claude-local/server";
|
|
import {
|
|
agentConfigurationDoc as claudeAgentConfigurationDoc,
|
|
models as claudeModels,
|
|
} from "@paperclipai/adapter-claude-local";
|
|
import {
|
|
execute as codexExecute,
|
|
listCodexSkills,
|
|
syncCodexSkills,
|
|
testEnvironment as codexTestEnvironment,
|
|
sessionCodec as codexSessionCodec,
|
|
getQuotaWindows as codexGetQuotaWindows,
|
|
getConfigSchema as getCodexConfigSchema,
|
|
CODEX_DEVICE_LOGIN_COMMAND,
|
|
parseDeviceLoginPrompt,
|
|
} from "@paperclipai/adapter-codex-local/server";
|
|
import {
|
|
agentConfigurationDoc as codexAgentConfigurationDoc,
|
|
models as codexModels,
|
|
} from "@paperclipai/adapter-codex-local";
|
|
import {
|
|
execute as cursorExecute,
|
|
listCursorSkills,
|
|
syncCursorSkills,
|
|
testEnvironment as cursorTestEnvironment,
|
|
sessionCodec as cursorSessionCodec,
|
|
} from "@paperclipai/adapter-cursor-local/server";
|
|
import {
|
|
agentConfigurationDoc as cursorAgentConfigurationDoc,
|
|
models as cursorModels,
|
|
} from "@paperclipai/adapter-cursor-local";
|
|
import {
|
|
execute as cursorCloudExecute,
|
|
getConfigSchema as getCursorCloudConfigSchema,
|
|
sessionCodec as cursorCloudSessionCodec,
|
|
testEnvironment as cursorCloudTestEnvironment,
|
|
} from "@paperclipai/adapter-cursor-cloud/server";
|
|
import { agentConfigurationDoc as cursorCloudAgentConfigurationDoc } from "@paperclipai/adapter-cursor-cloud";
|
|
import {
|
|
execute as geminiExecute,
|
|
listGeminiSkills,
|
|
syncGeminiSkills,
|
|
testEnvironment as geminiTestEnvironment,
|
|
sessionCodec as geminiSessionCodec,
|
|
getConfigSchema as getGeminiConfigSchema,
|
|
} from "@paperclipai/adapter-gemini-local/server";
|
|
import {
|
|
agentConfigurationDoc as geminiAgentConfigurationDoc,
|
|
models as geminiModels,
|
|
} from "@paperclipai/adapter-gemini-local";
|
|
import {
|
|
execute as grokExecute,
|
|
listGrokSkills,
|
|
syncGrokSkills,
|
|
testEnvironment as grokTestEnvironment,
|
|
sessionCodec as grokSessionCodec,
|
|
GROK_DEVICE_LOGIN_COMMAND,
|
|
parseGrokDeviceLoginPrompt,
|
|
} from "@paperclipai/adapter-grok-local/server";
|
|
import {
|
|
agentConfigurationDoc as grokAgentConfigurationDoc,
|
|
models as grokModels,
|
|
} from "@paperclipai/adapter-grok-local";
|
|
import {
|
|
execute as kimiExecute,
|
|
listKimiSkills,
|
|
syncKimiSkills,
|
|
testEnvironment as kimiTestEnvironment,
|
|
sessionCodec as kimiSessionCodec,
|
|
} from "@paperclipai/adapter-kimi-local/server";
|
|
import {
|
|
agentConfigurationDoc as kimiAgentConfigurationDoc,
|
|
models as kimiModels,
|
|
} from "@paperclipai/adapter-kimi-local";
|
|
import {
|
|
createHermesGatewayServerAdapter,
|
|
createHermesLocalServerAdapter,
|
|
} from "@paperclipai/hermes-paperclip-adapter";
|
|
import {
|
|
execute as openCodeExecute,
|
|
listOpenCodeSkills,
|
|
syncOpenCodeSkills,
|
|
testEnvironment as openCodeTestEnvironment,
|
|
sessionCodec as openCodeSessionCodec,
|
|
listOpenCodeModels,
|
|
} from "@paperclipai/adapter-opencode-local/server";
|
|
import {
|
|
agentConfigurationDoc as openCodeAgentConfigurationDoc,
|
|
models as openCodeModels,
|
|
} from "@paperclipai/adapter-opencode-local";
|
|
import {
|
|
execute as openclawGatewayExecute,
|
|
testEnvironment as openclawGatewayTestEnvironment,
|
|
} from "@paperclipai/adapter-openclaw-gateway/server";
|
|
import {
|
|
agentConfigurationDoc as openclawGatewayAgentConfigurationDoc,
|
|
models as openclawGatewayModels,
|
|
} from "@paperclipai/adapter-openclaw-gateway";
|
|
import { listCodexModels, refreshCodexModels } from "./codex-models.js";
|
|
import { listCursorModels } from "./cursor-models.js";
|
|
import {
|
|
execute as piExecute,
|
|
listPiSkills,
|
|
syncPiSkills,
|
|
testEnvironment as piTestEnvironment,
|
|
sessionCodec as piSessionCodec,
|
|
listPiModels,
|
|
} from "@paperclipai/adapter-pi-local/server";
|
|
import { agentConfigurationDoc as piAgentConfigurationDoc } from "@paperclipai/adapter-pi-local";
|
|
import { BUILTIN_ADAPTER_TYPES } from "./builtin-adapter-types.js";
|
|
import { buildExternalAdapters } from "./plugin-loader.js";
|
|
import { getDisabledAdapterTypes } from "../services/adapter-plugin-store.js";
|
|
import { processAdapter } from "./process/index.js";
|
|
import { httpAdapter } from "./http/index.js";
|
|
import {
|
|
DEFAULT_OPENCODE_RUNNER_MODEL,
|
|
PaperclipRunnerProviderProfileError,
|
|
DEFAULT_ACPX_RUNNER_MODELS,
|
|
QUALIFIED_OPENCODE_RUNNER_VERSION,
|
|
resolvePaperclipRunnerProviderProfile,
|
|
} from "../services/native-runtime/provider-profile.js";
|
|
|
|
function readConfiguredCommand(config: Record<string, unknown>, fallback: string): string {
|
|
const value = typeof config.command === "string" ? config.command.trim() : "";
|
|
return value.length > 0 ? value : fallback;
|
|
}
|
|
|
|
function hasPathSeparator(command: string): boolean {
|
|
return command.includes("/") || command.includes("\\");
|
|
}
|
|
|
|
function shellQuote(value: string): string {
|
|
return `'${value.replace(/'/g, `'"'"'`)}'`;
|
|
}
|
|
|
|
function buildNpmRuntimeCommandSpec(
|
|
config: Record<string, unknown>,
|
|
fallbackCommand: string,
|
|
packageName: string,
|
|
): AdapterRuntimeCommandSpec {
|
|
const command = readConfiguredCommand(config, fallbackCommand);
|
|
const canSelfInstall = !hasPathSeparator(command) && command === fallbackCommand;
|
|
const installLine = buildSandboxNpmInstallCommand(packageName);
|
|
return {
|
|
command,
|
|
detectCommand: command,
|
|
installCommand: canSelfInstall
|
|
? `if ! command -v ${shellQuote(command)} >/dev/null 2>&1; then ${installLine}; fi`
|
|
: null,
|
|
};
|
|
}
|
|
|
|
function buildCursorRuntimeCommandSpec(config: Record<string, unknown>): AdapterRuntimeCommandSpec {
|
|
const command = readConfiguredCommand(config, "agent");
|
|
return {
|
|
command,
|
|
detectCommand: command,
|
|
installCommand: null,
|
|
};
|
|
}
|
|
|
|
const retiredAcpxMessage =
|
|
"The acpx_local adapter has been retired. Existing Claude and Codex ACPX agents should be migrated to claude_local or codex_local with adapterConfig.engine=\"acp\".";
|
|
|
|
const retiredAcpxAgentConfigurationDoc = `# acpx_local retired
|
|
|
|
Adapter: acpx_local
|
|
|
|
The standalone ACPX adapter has been retired. Use:
|
|
|
|
- claude_local with adapterConfig.engine="acp" for Claude ACP execution.
|
|
- codex_local with adapterConfig.engine="acp" for Codex ACP execution.
|
|
|
|
Paperclip keeps this tombstone registered so stale acpx_local rows fail clearly instead of falling back to the process adapter.
|
|
`;
|
|
|
|
// The Claude interactive login capability. Claude runs `claude setup-token` on a
|
|
// real pseudo-terminal. The user pastes a browser code back into the flow. The
|
|
// flow uses a fixed host-side timeout and records a stored session identifier on
|
|
// success. The capability data holds no secret; the callbacks return runtime
|
|
// values only.
|
|
const claudeLoginCapability: AdapterLoginCapability = {
|
|
panelMode: "submitted_browser_code",
|
|
timeoutPolicy: "fixed",
|
|
getCommand: () => CLAUDE_SETUP_TOKEN_COMMAND,
|
|
parsePrompt: (output) => {
|
|
const prompt = parseSetupTokenPrompt(output);
|
|
return prompt ? { url: prompt.url } : null;
|
|
},
|
|
captureCredential: (output) => {
|
|
const token = parseSetupTokenCredential(output);
|
|
return token === null ? null : Buffer.from(token, "utf8");
|
|
},
|
|
completionClaim: "storedSessionId",
|
|
};
|
|
|
|
// The Codex interactive login capability. Codex runs `codex login --device-auth`
|
|
// on a real pseudo-terminal, because a pipe emits no login prompt. The flow shows
|
|
// a one-time code that the user enters in the browser. The caller sets the
|
|
// host-side timeout. The device-login flow writes its credential inside the
|
|
// sandbox, so the capability declares no terminal credential capture and no
|
|
// completion claim.
|
|
const codexLoginCapability: AdapterLoginCapability = {
|
|
panelMode: "displayed_code",
|
|
timeoutPolicy: "caller_bounded",
|
|
getCommand: () => CODEX_DEVICE_LOGIN_COMMAND,
|
|
parsePrompt: (output) => {
|
|
const prompt = parseDeviceLoginPrompt(output);
|
|
return prompt ? { url: prompt.url, code: prompt.code } : null;
|
|
},
|
|
};
|
|
|
|
// The Grok interactive login capability. Grok runs `grok login --device-auth`
|
|
// on a real pseudo-terminal, the same way Codex does. The flow shows a
|
|
// one-time code that the user enters in the browser. The caller sets the
|
|
// host-side timeout. The device-login flow writes its credential inside the
|
|
// sandbox, so the capability declares no terminal credential capture and no
|
|
// completion claim. `getCommand` is descriptive only: the login path selects
|
|
// the real command from the closed key map in `login-command.ts`, never from
|
|
// this member.
|
|
const grokLoginCapability: AdapterLoginCapability = {
|
|
panelMode: "displayed_code",
|
|
timeoutPolicy: "caller_bounded",
|
|
getCommand: () => GROK_DEVICE_LOGIN_COMMAND,
|
|
parsePrompt: (output) => {
|
|
const prompt = parseGrokDeviceLoginPrompt(output);
|
|
return prompt ? { url: prompt.url, code: prompt.code } : null;
|
|
},
|
|
};
|
|
|
|
const claudeLocalAdapter: ServerAdapterModule = {
|
|
type: "claude_local",
|
|
runtimeToolDelivery: "native_mcp",
|
|
execute: stampClaudeAgentIdHeader(claudeExecute),
|
|
testEnvironment: claudeTestEnvironment,
|
|
acp: {
|
|
agentId: "claude",
|
|
skillsMode: "ephemeral",
|
|
prerequisites: {
|
|
nodeRange: ">=24.11.0",
|
|
packages: ["@agentclientprotocol/claude-agent-acp"],
|
|
},
|
|
},
|
|
listSkills: listClaudeSkills,
|
|
syncSkills: syncClaudeSkills,
|
|
sessionCodec: claudeSessionCodec,
|
|
sessionManagement: getAdapterSessionManagement("claude_local") ?? undefined,
|
|
supportsToolRefreshOnResume: true,
|
|
models: claudeModels,
|
|
listModels: listClaudeModels,
|
|
refreshModels: refreshClaudeModels,
|
|
supportsLocalAgentJwt: true,
|
|
supportsInstructionsBundle: true,
|
|
instructionsPathKey: "instructionsFilePath",
|
|
requiresMaterializedRuntimeSkills: false,
|
|
getRuntimeCommandSpec: (config) =>
|
|
buildNpmRuntimeCommandSpec(config, "claude", "@anthropic-ai/claude-code"),
|
|
agentConfigurationDoc: claudeAgentConfigurationDoc,
|
|
getConfigSchema: getClaudeConfigSchema,
|
|
getQuotaWindows: claudeGetQuotaWindows,
|
|
loginCapability: claudeLoginCapability,
|
|
};
|
|
|
|
const acpxLocalAdapter: ServerAdapterModule = {
|
|
type: "acpx_local",
|
|
runtimeToolDelivery: "environment",
|
|
async execute(ctx) {
|
|
await ctx.onLog("stderr", `${retiredAcpxMessage}\n`);
|
|
await ctx.onMeta?.({
|
|
adapterType: "acpx_local",
|
|
command: "acpx_local-retired",
|
|
commandNotes: [retiredAcpxMessage],
|
|
});
|
|
return {
|
|
exitCode: 1,
|
|
signal: null,
|
|
timedOut: false,
|
|
errorMessage: retiredAcpxMessage,
|
|
errorCode: "acpx_local_retired",
|
|
provider: "acpx",
|
|
summary: retiredAcpxMessage,
|
|
};
|
|
},
|
|
async testEnvironment() {
|
|
return {
|
|
adapterType: "acpx_local",
|
|
status: "fail",
|
|
testedAt: new Date().toISOString(),
|
|
checks: [
|
|
{
|
|
code: "acpx_local_retired",
|
|
level: "error",
|
|
message: retiredAcpxMessage,
|
|
hint: "Set the agent adapter to claude_local or codex_local and set adapterConfig.engine to acp.",
|
|
},
|
|
],
|
|
};
|
|
},
|
|
models: [],
|
|
supportsLocalAgentJwt: false,
|
|
supportsInstructionsBundle: false,
|
|
requiresMaterializedRuntimeSkills: false,
|
|
agentConfigurationDoc: retiredAcpxAgentConfigurationDoc,
|
|
getConfigSchema: () => ({ fields: [] }),
|
|
};
|
|
|
|
const codexLocalAdapter: ServerAdapterModule = {
|
|
type: "codex_local",
|
|
runtimeToolDelivery: "native_mcp",
|
|
execute: codexExecute,
|
|
testEnvironment: codexTestEnvironment,
|
|
acp: {
|
|
agentId: "codex",
|
|
skillsMode: "ephemeral",
|
|
prerequisites: {
|
|
nodeRange: ">=24.11.0",
|
|
packages: ["@agentclientprotocol/codex-acp"],
|
|
},
|
|
},
|
|
listSkills: listCodexSkills,
|
|
syncSkills: syncCodexSkills,
|
|
sessionCodec: codexSessionCodec,
|
|
sessionManagement: getAdapterSessionManagement("codex_local") ?? undefined,
|
|
supportsToolRefreshOnResume: true,
|
|
models: codexModels,
|
|
listModels: listCodexModels,
|
|
refreshModels: refreshCodexModels,
|
|
supportsLocalAgentJwt: true,
|
|
supportsInstructionsBundle: true,
|
|
instructionsPathKey: "instructionsFilePath",
|
|
requiresMaterializedRuntimeSkills: false,
|
|
getRuntimeCommandSpec: (config) => buildNpmRuntimeCommandSpec(config, "codex", "@openai/codex"),
|
|
agentConfigurationDoc: codexAgentConfigurationDoc,
|
|
getConfigSchema: getCodexConfigSchema,
|
|
getQuotaWindows: codexGetQuotaWindows,
|
|
loginCapability: codexLoginCapability,
|
|
};
|
|
|
|
const paperclipRunnerAdapter: ServerAdapterModule = {
|
|
type: "paperclip_runner",
|
|
runtimeToolDelivery: "environment",
|
|
async execute(ctx) {
|
|
const message = "paperclip_runner requires the native runner coordinator";
|
|
await ctx.onLog("stderr", `${message}\n`);
|
|
return {
|
|
exitCode: 1,
|
|
signal: null,
|
|
timedOut: false,
|
|
errorMessage: message,
|
|
errorCode: "paperclip_runner_coordinator_required",
|
|
provider: ctx.config.provider === "opencode"
|
|
? "opencode"
|
|
: ctx.config.provider === "claude_managed"
|
|
? "anthropic"
|
|
: ctx.config.provider === "aws_agentcore"
|
|
? "amazon-bedrock"
|
|
: ctx.config.provider === "acpx"
|
|
? "acpx"
|
|
: "codex",
|
|
summary: message,
|
|
};
|
|
},
|
|
async testEnvironment(context) {
|
|
let profile: ReturnType<typeof resolvePaperclipRunnerProviderProfile>;
|
|
try {
|
|
profile = resolvePaperclipRunnerProviderProfile(context.config);
|
|
} catch (error) {
|
|
const profileError = error instanceof PaperclipRunnerProviderProfileError
|
|
? error
|
|
: new PaperclipRunnerProviderProfileError(
|
|
"paperclip_runner_provider_unsupported",
|
|
"Paperclip Runner provider configuration is invalid.",
|
|
);
|
|
return {
|
|
adapterType: "paperclip_runner",
|
|
status: "fail" as const,
|
|
testedAt: new Date().toISOString(),
|
|
checks: [{
|
|
code: profileError.code,
|
|
level: "error" as const,
|
|
message: profileError.message,
|
|
}],
|
|
};
|
|
}
|
|
if (profile.provider === "acpx") {
|
|
if (["copilot", "pi"].includes(profile.acpxAgent)) {
|
|
// The profile resolver already validated the isolated host's exact
|
|
// qualification pair. Do not report a production readiness pass.
|
|
return {
|
|
adapterType: "paperclip_runner", status: "warn" as const, testedAt: new Date().toISOString(),
|
|
checks: [{ code: "acpx_candidate_qualification_only", level: "warn" as const,
|
|
message: "This exact candidate and model are admitted for operator-controlled qualification only. Verified runtime installation, bound credentials, and model access are checked before execution; production support remains pending." }],
|
|
};
|
|
}
|
|
try {
|
|
if (profile.acpxAgent !== "claude" && profile.acpxAgent !== "grok" && profile.acpxAgent !== "cursor") throw new Error("Select Codex to use the native Codex runner.");
|
|
const target = context.executionTarget;
|
|
if (target?.kind === "remote") {
|
|
const probe = await runAdapterExecutionTargetShellCommand(
|
|
`acpx-platform-${crypto.randomUUID()}`, target, "uname -s && uname -m",
|
|
{ cwd: target.remoteCwd, env: {}, timeoutSec: 15 },
|
|
);
|
|
if (probe.timedOut || probe.exitCode !== 0) throw new Error("Could not verify the remote ACPX runner platform.");
|
|
const [os, arch] = probe.stdout.trim().split(/\s+/);
|
|
if (!((os === "Linux" && arch === "x86_64") || (os === "Darwin" && (arch === "arm64" || (profile.acpxAgent !== "grok" && arch === "x86_64"))))) {
|
|
throw new Error(`ACPX ${profile.acpxAgent} requires a qualified Linux x64 or macOS architecture.`);
|
|
}
|
|
return {
|
|
adapterType: "paperclip_runner", status: "warn" as const, testedAt: new Date().toISOString(),
|
|
checks: [{ code: "acpx_remote_runtime_unverified", level: "warn" as const,
|
|
message: "The remote platform is supported. Runtime package integrity and readiness must still be verified by the remote runner before launch." }],
|
|
};
|
|
}
|
|
const { probeAcpxClaudeInstallation, probeAcpxGrokInstallation, probeAcpxCursorInstallation } = await import("../vendor/paperclip-runner/live/index.js");
|
|
await (profile.acpxAgent === "grok" ? probeAcpxGrokInstallation : profile.acpxAgent === "cursor" ? probeAcpxCursorInstallation : probeAcpxClaudeInstallation)(profile.model);
|
|
return {
|
|
adapterType: "paperclip_runner", status: "pass" as const, testedAt: new Date().toISOString(),
|
|
checks: [{ code: "acpx_runtime_ready", level: "info" as const, message: `ACPX ${profile.acpxAgent} runtime is installed and verified. Model access is checked when it runs.` }],
|
|
};
|
|
} catch (error) {
|
|
return {
|
|
adapterType: "paperclip_runner", status: "fail" as const, testedAt: new Date().toISOString(),
|
|
checks: [{ code: "acpx_runtime_unavailable", level: "error" as const, message: error instanceof Error ? error.message : "ACPX Claude runtime could not be verified." }],
|
|
};
|
|
}
|
|
}
|
|
if (profile.provider === "claude_managed") {
|
|
return {
|
|
adapterType: "paperclip_runner",
|
|
status: "warn" as const,
|
|
testedAt: new Date().toISOString(),
|
|
checks: [{
|
|
code: "claude_managed_profile_selected",
|
|
level: "info" as const,
|
|
message: `Claude Managed profile ${profile.managedProfileId} is selected with retention acknowledged. Its stored qualification, API-key binding, and spend ceiling are verified before the first turn.`,
|
|
}, {
|
|
code: "claude_managed_retention_notice",
|
|
level: "warn" as const,
|
|
message: "Claude Managed is a stateful beta service and is not eligible for ZDR or HIPAA modes.",
|
|
}],
|
|
};
|
|
}
|
|
if (profile.provider === "aws_agentcore") {
|
|
return {
|
|
adapterType: "paperclip_runner",
|
|
status: "warn" as const,
|
|
testedAt: new Date().toISOString(),
|
|
checks: [{
|
|
code: "aws_agentcore_profile_selected",
|
|
level: "info" as const,
|
|
message: `AWS AgentCore profile ${profile.agentCoreProfileId} is selected with retention acknowledged. Its stored qualification, invocation limits, and estimated spend ceiling are verified before the first turn.`,
|
|
}, {
|
|
code: "aws_agentcore_retention_notice",
|
|
level: "warn" as const,
|
|
message: "AgentCore Memory retains short-term events for 90 days; the spend ceiling is an estimate, not an AWS currency hard stop.",
|
|
}],
|
|
};
|
|
}
|
|
const result = profile.provider === "opencode"
|
|
? await openCodeTestEnvironment(context)
|
|
: await codexTestEnvironment(context);
|
|
return { ...result, adapterType: "paperclip_runner" };
|
|
},
|
|
listSkills: listCodexSkills,
|
|
syncSkills: syncCodexSkills,
|
|
sessionCodec: codexSessionCodec,
|
|
models: [
|
|
...codexModels,
|
|
{ id: DEFAULT_OPENCODE_RUNNER_MODEL, label: "OpenRouter · DeepSeek V4 Flash 0731" },
|
|
{ id: DEFAULT_ACPX_RUNNER_MODELS.claude, label: "Claude Sonnet 5" },
|
|
{ id: "global.anthropic.claude-sonnet-4-6", label: "Amazon Bedrock · Claude Sonnet 4.6 (global)" },
|
|
],
|
|
listModels: async () => [
|
|
...await listCodexModels(),
|
|
{ id: DEFAULT_OPENCODE_RUNNER_MODEL, label: "OpenRouter · DeepSeek V4 Flash 0731" },
|
|
{ id: DEFAULT_ACPX_RUNNER_MODELS.claude, label: "Claude Sonnet 5" },
|
|
{ id: "global.anthropic.claude-sonnet-4-6", label: "Amazon Bedrock · Claude Sonnet 4.6 (global)" },
|
|
],
|
|
refreshModels: async () => [
|
|
...await refreshCodexModels(),
|
|
{ id: DEFAULT_OPENCODE_RUNNER_MODEL, label: "OpenRouter · DeepSeek V4 Flash 0731" },
|
|
{ id: DEFAULT_ACPX_RUNNER_MODELS.claude, label: "Claude Sonnet 5" },
|
|
{ id: "global.anthropic.claude-sonnet-4-6", label: "Amazon Bedrock · Claude Sonnet 4.6 (global)" },
|
|
],
|
|
supportsLocalAgentJwt: false,
|
|
supportsInstructionsBundle: true,
|
|
instructionsPathKey: "instructionsFilePath",
|
|
requiresMaterializedRuntimeSkills: false,
|
|
getRuntimeCommandSpec: (config) => config.provider === "claude_managed"
|
|
|| config.provider === "aws_agentcore"
|
|
|| config.provider === "acpx"
|
|
? { command: "paperclip-runnerd", detectCommand: null, installCommand: null }
|
|
: config.provider === "opencode"
|
|
? buildNpmRuntimeCommandSpec(
|
|
config,
|
|
"opencode",
|
|
`opencode-ai@${QUALIFIED_OPENCODE_RUNNER_VERSION}`,
|
|
)
|
|
: buildNpmRuntimeCommandSpec(config, "codex", "@openai/codex@0.160.0"),
|
|
agentConfigurationDoc:
|
|
"# Paperclip Runner\n\nAdapter: paperclip_runner\n\nRuns Codex, OpenCode, Claude Managed, AWS AgentCore, or ACPX Claude/Grok Build/Cursor through the Rust Paperclip runner and authenticated PRP transport. GitHub Copilot and Pi are awaiting local and Daytona qualification and are not enabled for production runs. Managed providers use company-scoped qualified profiles, explicit retention acknowledgement, and spend limits.\n",
|
|
getConfigSchema: () => ({
|
|
fields: [
|
|
{
|
|
key: "provider",
|
|
label: "Provider",
|
|
type: "select" as const,
|
|
default: "codex",
|
|
options: [
|
|
{ value: "codex", label: "Codex" },
|
|
{ value: "opencode", label: `OpenCode ${QUALIFIED_OPENCODE_RUNNER_VERSION}` },
|
|
{ value: "claude_managed", label: "Claude Managed" },
|
|
{ value: "aws_agentcore", label: "AWS AgentCore" },
|
|
{ value: "acpx", label: "ACP agents" },
|
|
],
|
|
hint: "Select a local provider, company-qualified managed provider, or an ACP agent.",
|
|
},
|
|
{
|
|
key: "acpxAgent", label: "ACP agent", type: "select" as const, default: "claude",
|
|
options: [{ value: "claude", label: "Claude" }, { value: "grok", label: "Grok Build" }],
|
|
meta: { visibleWhen: { key: "provider", value: "acpx" } },
|
|
},
|
|
{
|
|
key: "codexPermissionMode",
|
|
label: "Codex permission mode",
|
|
type: "select" as const,
|
|
default: PAPERCLIP_RUNNER_PERMISSION_CAPABILITIES.codex.defaultMode,
|
|
options: PAPERCLIP_RUNNER_PERMISSION_CAPABILITIES.codex.options.map(
|
|
({ value, label }) => ({ value, label }),
|
|
),
|
|
hint: PAPERCLIP_RUNNER_PERMISSION_CAPABILITIES.codex.description,
|
|
meta: { visibleWhen: { key: "provider", value: "codex" } },
|
|
},
|
|
{
|
|
key: "opencodePermissionMode",
|
|
label: "OpenCode permission mode",
|
|
type: "select" as const,
|
|
default: PAPERCLIP_RUNNER_PERMISSION_CAPABILITIES.opencode.defaultMode,
|
|
options: PAPERCLIP_RUNNER_PERMISSION_CAPABILITIES.opencode.options.map(
|
|
({ value, label }) => ({ value, label }),
|
|
),
|
|
hint: PAPERCLIP_RUNNER_PERMISSION_CAPABILITIES.opencode.description,
|
|
meta: { visibleWhen: { key: "provider", value: "opencode" } },
|
|
},
|
|
{
|
|
key: "acpxPermissionMode",
|
|
label: "ACPX permission mode",
|
|
type: "select" as const,
|
|
default: PAPERCLIP_RUNNER_PERMISSION_CAPABILITIES.acpx.defaultMode,
|
|
options: PAPERCLIP_RUNNER_PERMISSION_CAPABILITIES.acpx.options.map(
|
|
({ value, label }) => ({ value, label }),
|
|
),
|
|
hint: PAPERCLIP_RUNNER_PERMISSION_CAPABILITIES.acpx.description,
|
|
meta: { visibleWhen: { key: "provider", value: "acpx" } },
|
|
},
|
|
{
|
|
key: "model",
|
|
label: "Provider model",
|
|
type: "text" as const,
|
|
default: "",
|
|
placeholder: DEFAULT_OPENCODE_RUNNER_MODEL,
|
|
hint: "OpenCode uses provider/model form. ACPX Claude accepts Claude model IDs, including custom IDs.",
|
|
meta: { visibleWhen: { key: "provider", value: "opencode" } },
|
|
},
|
|
{
|
|
key: "managedProfileId",
|
|
label: "Managed Agent profile",
|
|
type: "text" as const,
|
|
required: true,
|
|
hint: "Company-scoped qualified profile ID or key.",
|
|
meta: { visibleWhen: { key: "provider", value: "claude_managed" } },
|
|
},
|
|
{
|
|
key: "maxSessionListCostUsd",
|
|
label: "Session spend ceiling (USD)",
|
|
type: "number" as const,
|
|
default: 1,
|
|
hint: "Hard ceiling for one Claude Managed session.",
|
|
meta: { visibleWhen: { key: "provider", value: "claude_managed" } },
|
|
},
|
|
{
|
|
key: "managedAgentsRetentionAcknowledged",
|
|
label: "Acknowledge managed retention",
|
|
type: "toggle" as const,
|
|
default: false,
|
|
hint: "Claude Managed is stateful beta and is not eligible for ZDR or HIPAA modes.",
|
|
meta: { visibleWhen: { key: "provider", value: "claude_managed" } },
|
|
},
|
|
{
|
|
key: "agentCoreProfileId",
|
|
label: "AgentCore profile",
|
|
type: "text" as const,
|
|
required: true,
|
|
hint: "Company-scoped qualified AgentCore profile ID or key.",
|
|
meta: { visibleWhen: { key: "provider", value: "aws_agentcore" } },
|
|
},
|
|
{
|
|
key: "maxEstimatedSessionCostUsd",
|
|
label: "Estimated session ceiling (USD)",
|
|
type: "number" as const,
|
|
default: 1,
|
|
hint: "Paperclip estimate; AWS does not provide a per-session currency hard stop.",
|
|
meta: { visibleWhen: { key: "provider", value: "aws_agentcore" } },
|
|
},
|
|
{
|
|
key: "maxIterations",
|
|
label: "Maximum iterations",
|
|
type: "number" as const,
|
|
default: 8,
|
|
hint: "Must be between 1 and the qualified maximum of 8.",
|
|
meta: { visibleWhen: { key: "provider", value: "aws_agentcore" } },
|
|
},
|
|
{
|
|
key: "maxOutputTokens",
|
|
label: "Maximum output tokens",
|
|
type: "number" as const,
|
|
default: 4_096,
|
|
hint: "Must be between 1 and the qualified maximum of 4096.",
|
|
meta: { visibleWhen: { key: "provider", value: "aws_agentcore" } },
|
|
},
|
|
{
|
|
key: "timeoutSeconds",
|
|
label: "Invocation timeout (seconds)",
|
|
type: "number" as const,
|
|
default: 300,
|
|
hint: "Must be between 1 and the qualified maximum of 300 seconds.",
|
|
meta: { visibleWhen: { key: "provider", value: "aws_agentcore" } },
|
|
},
|
|
{
|
|
key: "agentCoreRetentionAcknowledged",
|
|
label: "Acknowledge 90-day Memory retention",
|
|
type: "toggle" as const,
|
|
default: false,
|
|
hint: "The qualified AgentCore profile retains short-term Memory events for 90 days.",
|
|
meta: { visibleWhen: { key: "provider", value: "aws_agentcore" } },
|
|
},
|
|
{
|
|
key: "lifecycleMode",
|
|
label: "Runner lifecycle",
|
|
type: "select" as const,
|
|
default: "per_turn",
|
|
options: [
|
|
{ value: "per_turn", label: "Turn by turn" },
|
|
{ value: "warm", label: "Warm session" },
|
|
],
|
|
hint: "Warm sessions retain runnerd and Codex between governed runs.",
|
|
},
|
|
{
|
|
key: "idleTimeoutMs",
|
|
label: "Warm idle timeout (ms)",
|
|
type: "number" as const,
|
|
default: 300_000,
|
|
hint: "Warm sessions suspend after this much inactivity.",
|
|
meta: { visibleWhen: { key: "lifecycleMode", value: "warm" } },
|
|
},
|
|
],
|
|
}),
|
|
loginCapability: codexLoginCapability,
|
|
};
|
|
|
|
const cursorLocalAdapter: ServerAdapterModule = {
|
|
type: "cursor",
|
|
runtimeToolDelivery: "environment",
|
|
execute: cursorExecute,
|
|
testEnvironment: cursorTestEnvironment,
|
|
listSkills: listCursorSkills,
|
|
syncSkills: syncCursorSkills,
|
|
sessionCodec: cursorSessionCodec,
|
|
sessionManagement: getAdapterSessionManagement("cursor") ?? undefined,
|
|
supportsToolRefreshOnResume: true,
|
|
models: cursorModels,
|
|
listModels: listCursorModels,
|
|
supportsLocalAgentJwt: true,
|
|
supportsInstructionsBundle: true,
|
|
instructionsPathKey: "instructionsFilePath",
|
|
requiresMaterializedRuntimeSkills: true,
|
|
getRuntimeCommandSpec: buildCursorRuntimeCommandSpec,
|
|
agentConfigurationDoc: cursorAgentConfigurationDoc,
|
|
};
|
|
|
|
const cursorCloudAdapter: ServerAdapterModule = {
|
|
type: "cursor_cloud",
|
|
runtimeToolDelivery: "invocation_context",
|
|
execute: cursorCloudExecute,
|
|
testEnvironment: cursorCloudTestEnvironment,
|
|
sessionCodec: cursorCloudSessionCodec,
|
|
sessionManagement: getAdapterSessionManagement("cursor_cloud") ?? undefined,
|
|
models: [],
|
|
supportsLocalAgentJwt: false,
|
|
supportsInstructionsBundle: true,
|
|
instructionsPathKey: "instructionsFilePath",
|
|
requiresMaterializedRuntimeSkills: false,
|
|
agentConfigurationDoc: cursorCloudAgentConfigurationDoc,
|
|
getConfigSchema: getCursorCloudConfigSchema,
|
|
};
|
|
|
|
const geminiLocalAdapter: ServerAdapterModule = {
|
|
type: "gemini_local",
|
|
runtimeToolDelivery: "environment",
|
|
execute: geminiExecute,
|
|
testEnvironment: geminiTestEnvironment,
|
|
acp: {
|
|
agentId: "gemini",
|
|
skillsMode: "ephemeral",
|
|
prerequisites: {
|
|
nodeRange: ">=24.11.0",
|
|
packages: ["@google/gemini-cli"],
|
|
},
|
|
},
|
|
listSkills: listGeminiSkills,
|
|
syncSkills: syncGeminiSkills,
|
|
sessionCodec: geminiSessionCodec,
|
|
sessionManagement: getAdapterSessionManagement("gemini_local") ?? undefined,
|
|
supportsToolRefreshOnResume: true,
|
|
models: geminiModels,
|
|
supportsLocalAgentJwt: true,
|
|
supportsInstructionsBundle: true,
|
|
instructionsPathKey: "instructionsFilePath",
|
|
requiresMaterializedRuntimeSkills: true,
|
|
getRuntimeCommandSpec: (config) =>
|
|
buildNpmRuntimeCommandSpec(config, "gemini", "@google/gemini-cli"),
|
|
agentConfigurationDoc: geminiAgentConfigurationDoc,
|
|
getConfigSchema: getGeminiConfigSchema,
|
|
};
|
|
|
|
const grokLocalAdapter: ServerAdapterModule = {
|
|
type: "grok_local",
|
|
runtimeToolDelivery: "environment",
|
|
execute: grokExecute,
|
|
testEnvironment: grokTestEnvironment,
|
|
listSkills: listGrokSkills,
|
|
syncSkills: syncGrokSkills,
|
|
sessionCodec: grokSessionCodec,
|
|
sessionManagement: getAdapterSessionManagement("grok_local") ?? undefined,
|
|
supportsToolRefreshOnResume: true,
|
|
models: grokModels,
|
|
supportsLocalAgentJwt: true,
|
|
supportsInstructionsBundle: true,
|
|
instructionsPathKey: "instructionsFilePath",
|
|
requiresMaterializedRuntimeSkills: true,
|
|
getRuntimeCommandSpec: (config) => ({
|
|
command: readConfiguredCommand(config, "grok"),
|
|
detectCommand: readConfiguredCommand(config, "grok"),
|
|
installCommand: null,
|
|
}),
|
|
agentConfigurationDoc: grokAgentConfigurationDoc,
|
|
loginCapability: grokLoginCapability,
|
|
};
|
|
|
|
const kimiLocalAdapter: ServerAdapterModule = {
|
|
type: "kimi_local",
|
|
runtimeToolDelivery: "environment",
|
|
execute: kimiExecute,
|
|
testEnvironment: kimiTestEnvironment,
|
|
acp: {
|
|
agentId: "kimi",
|
|
skillsMode: "ephemeral",
|
|
prerequisites: {
|
|
nodeRange: ">=20.0.0",
|
|
packages: ["@moonshot-ai/kimi-code"],
|
|
},
|
|
},
|
|
listSkills: listKimiSkills,
|
|
syncSkills: syncKimiSkills,
|
|
sessionCodec: kimiSessionCodec,
|
|
sessionManagement: getAdapterSessionManagement("kimi_local") ?? undefined,
|
|
supportsToolRefreshOnResume: true,
|
|
models: kimiModels,
|
|
supportsLocalAgentJwt: true,
|
|
supportsInstructionsBundle: true,
|
|
instructionsPathKey: "instructionsFilePath",
|
|
requiresMaterializedRuntimeSkills: true,
|
|
getRuntimeCommandSpec: (config) =>
|
|
buildNpmRuntimeCommandSpec(config, "kimi", "@moonshot-ai/kimi-code"),
|
|
agentConfigurationDoc: kimiAgentConfigurationDoc,
|
|
};
|
|
|
|
const hermesGatewayAdapter: ServerAdapterModule = {
|
|
...createHermesGatewayServerAdapter(),
|
|
runtimeToolDelivery: "invocation_context",
|
|
};
|
|
|
|
const hermesLocalAdapter: ServerAdapterModule = {
|
|
...createHermesLocalServerAdapter(),
|
|
runtimeToolDelivery: "environment",
|
|
};
|
|
|
|
const openclawGatewayAdapter: ServerAdapterModule = {
|
|
type: "openclaw_gateway",
|
|
runtimeToolDelivery: "invocation_context",
|
|
execute: openclawGatewayExecute,
|
|
testEnvironment: openclawGatewayTestEnvironment,
|
|
models: openclawGatewayModels,
|
|
supportsLocalAgentJwt: false,
|
|
supportsInstructionsBundle: false,
|
|
requiresMaterializedRuntimeSkills: false,
|
|
agentConfigurationDoc: openclawGatewayAgentConfigurationDoc,
|
|
};
|
|
|
|
const openCodeLocalAdapter: ServerAdapterModule = {
|
|
type: "opencode_local",
|
|
runtimeToolDelivery: "environment",
|
|
execute: openCodeExecute,
|
|
testEnvironment: openCodeTestEnvironment,
|
|
listSkills: listOpenCodeSkills,
|
|
syncSkills: syncOpenCodeSkills,
|
|
sessionCodec: openCodeSessionCodec,
|
|
models: openCodeModels,
|
|
sessionManagement: getAdapterSessionManagement("opencode_local") ?? undefined,
|
|
supportsToolRefreshOnResume: true,
|
|
listModels: listOpenCodeModels,
|
|
supportsLocalAgentJwt: true,
|
|
supportsInstructionsBundle: true,
|
|
instructionsPathKey: "instructionsFilePath",
|
|
requiresMaterializedRuntimeSkills: true,
|
|
getRuntimeCommandSpec: (config) => buildNpmRuntimeCommandSpec(config, "opencode", "opencode-ai"),
|
|
agentConfigurationDoc: openCodeAgentConfigurationDoc,
|
|
};
|
|
|
|
const piLocalAdapter: ServerAdapterModule = {
|
|
type: "pi_local",
|
|
runtimeToolDelivery: "environment",
|
|
execute: piExecute,
|
|
testEnvironment: piTestEnvironment,
|
|
listSkills: listPiSkills,
|
|
syncSkills: syncPiSkills,
|
|
sessionCodec: piSessionCodec,
|
|
sessionManagement: getAdapterSessionManagement("pi_local") ?? undefined,
|
|
supportsToolRefreshOnResume: true,
|
|
models: [],
|
|
listModels: listPiModels,
|
|
supportsLocalAgentJwt: true,
|
|
supportsInstructionsBundle: true,
|
|
instructionsPathKey: "instructionsFilePath",
|
|
requiresMaterializedRuntimeSkills: true,
|
|
getRuntimeCommandSpec: (config) =>
|
|
buildNpmRuntimeCommandSpec(config, "pi", "@mariozechner/pi-coding-agent"),
|
|
agentConfigurationDoc: piAgentConfigurationDoc,
|
|
};
|
|
|
|
const adaptersByType = new Map<string, ServerAdapterModule>();
|
|
|
|
// For builtin types that are overridden by an external adapter, we keep the
|
|
// original builtin so it can be restored when the override is deactivated.
|
|
const builtinFallbacks = new Map<string, ServerAdapterModule>();
|
|
|
|
// Tracks which override types are currently deactivated (paused). When
|
|
// paused, `getServerAdapter()` returns the builtin fallback instead of the
|
|
// external. Persisted across reloads via the same disabled-adapters store.
|
|
const pausedOverrides = new Set<string>();
|
|
|
|
function registerBuiltInAdapters() {
|
|
for (const adapter of [
|
|
acpxLocalAdapter,
|
|
claudeLocalAdapter,
|
|
codexLocalAdapter,
|
|
paperclipRunnerAdapter,
|
|
openCodeLocalAdapter,
|
|
piLocalAdapter,
|
|
cursorCloudAdapter,
|
|
cursorLocalAdapter,
|
|
geminiLocalAdapter,
|
|
grokLocalAdapter,
|
|
kimiLocalAdapter,
|
|
hermesGatewayAdapter,
|
|
hermesLocalAdapter,
|
|
openclawGatewayAdapter,
|
|
processAdapter,
|
|
httpAdapter,
|
|
]) {
|
|
adaptersByType.set(adapter.type, adapter);
|
|
}
|
|
}
|
|
|
|
registerBuiltInAdapters();
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Load external adapter plugins (e.g. droid_local)
|
|
//
|
|
// External adapter packages export createServerAdapter() which returns a
|
|
// ServerAdapterModule. When the module provides its own sessionManagement
|
|
// it is preserved; otherwise the host falls back to the built-in registry
|
|
// lookup (so externals that override a built-in type inherit the builtin's
|
|
// policy). This brings init-time registration to at-least-as-good behavior
|
|
// as the hot-install path (routes/adapters.ts:179 -> registerServerAdapter):
|
|
// both preserve module-provided sessionManagement, and init-time additionally
|
|
// applies the registry fallback for externals overriding a built-in type.
|
|
// ---------------------------------------------------------------------------
|
|
|
|
/** Cached sync wrapper — the store is a simple JSON file read, safe to call frequently. */
|
|
function getDisabledAdapterTypesFromStore(): string[] {
|
|
return getDisabledAdapterTypes();
|
|
}
|
|
|
|
/**
|
|
* Merge an external adapter module with host-provided session management.
|
|
*
|
|
* Module-provided `sessionManagement` takes precedence. When absent, fall
|
|
* back to the hardcoded registry keyed by adapter type (so externals that
|
|
* override a built-in — same `type` — inherit the builtin's policy). If
|
|
* neither is available, `sessionManagement` remains `undefined`.
|
|
*
|
|
* Used by both the init-time IIFE below (external-adapter load pass on
|
|
* server start) and the hot-install path in `routes/adapters.ts`
|
|
* (`registerWithSessionManagement`), so the two load paths resolve
|
|
* `sessionManagement` identically.
|
|
*/
|
|
export function resolveExternalAdapterRegistration(
|
|
externalAdapter: ServerAdapterModule,
|
|
): ServerAdapterModule {
|
|
return {
|
|
...externalAdapter,
|
|
sessionManagement:
|
|
externalAdapter.sessionManagement
|
|
?? getAdapterSessionManagement(externalAdapter.type)
|
|
?? undefined,
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Load external adapters from the plugin store and hardcoded sources.
|
|
* Called once at module initialization. The promise is exported so that
|
|
* callers (e.g. assertKnownAdapterType, app startup) can await completion
|
|
* and avoid racing against the loading window.
|
|
*/
|
|
const externalAdaptersReady: Promise<void> = (async () => {
|
|
try {
|
|
const externalAdapters = await buildExternalAdapters();
|
|
for (const externalAdapter of externalAdapters) {
|
|
const overriding = BUILTIN_ADAPTER_TYPES.has(externalAdapter.type);
|
|
if (overriding) {
|
|
console.log(
|
|
`[paperclip] External adapter "${externalAdapter.type}" overrides built-in adapter`,
|
|
);
|
|
// Save the original builtin for later restoration.
|
|
const existing = adaptersByType.get(externalAdapter.type);
|
|
if (existing && !builtinFallbacks.has(externalAdapter.type)) {
|
|
builtinFallbacks.set(externalAdapter.type, existing);
|
|
}
|
|
}
|
|
adaptersByType.set(
|
|
externalAdapter.type,
|
|
resolveExternalAdapterRegistration(externalAdapter),
|
|
);
|
|
}
|
|
} catch (err) {
|
|
console.error("[paperclip] Failed to load external adapters:", err);
|
|
}
|
|
})();
|
|
|
|
/**
|
|
* Await this before validating adapter types to avoid race conditions
|
|
* during server startup. External adapters are loaded asynchronously;
|
|
* calling assertKnownAdapterType before this resolves will reject
|
|
* valid external adapter types.
|
|
*/
|
|
export function waitForExternalAdapters(): Promise<void> {
|
|
return externalAdaptersReady;
|
|
}
|
|
|
|
export function registerServerAdapter(adapter: ServerAdapterModule): void {
|
|
if (BUILTIN_ADAPTER_TYPES.has(adapter.type) && !builtinFallbacks.has(adapter.type)) {
|
|
const existing = adaptersByType.get(adapter.type);
|
|
if (existing) {
|
|
builtinFallbacks.set(adapter.type, existing);
|
|
}
|
|
}
|
|
adaptersByType.set(adapter.type, adapter);
|
|
}
|
|
|
|
export function unregisterServerAdapter(type: string): void {
|
|
if (type === processAdapter.type || type === httpAdapter.type) return;
|
|
if (builtinFallbacks.has(type)) {
|
|
pausedOverrides.delete(type);
|
|
const fallback = builtinFallbacks.get(type);
|
|
if (fallback) {
|
|
adaptersByType.set(type, fallback);
|
|
}
|
|
return;
|
|
}
|
|
if (BUILTIN_ADAPTER_TYPES.has(type)) {
|
|
return;
|
|
}
|
|
adaptersByType.delete(type);
|
|
}
|
|
|
|
export function requireServerAdapter(type: string): ServerAdapterModule {
|
|
const adapter = findActiveServerAdapter(type);
|
|
if (!adapter) {
|
|
throw new Error(`Unknown adapter type: ${type}`);
|
|
}
|
|
return adapter;
|
|
}
|
|
|
|
export function getServerAdapter(type: string): ServerAdapterModule {
|
|
return findActiveServerAdapter(type) ?? processAdapter;
|
|
}
|
|
|
|
/**
|
|
* Memoized view of PAPERCLIP_ADAPTER_MODELS, keyed by the raw env string so
|
|
* tests (and live env mutation) that change the variable are still observed.
|
|
* Parsing happens at most once per distinct raw value instead of per
|
|
* `listAdapterModels` request, and malformed values fail SOFT here: we log the
|
|
* parse error once (per distinct raw value) and fall back to adapter-discovered
|
|
* models rather than throwing at request time.
|
|
*/
|
|
let adapterModelsEnvCache: {
|
|
raw: string | undefined;
|
|
value: ReturnType<typeof parseAdapterModelsEnv>;
|
|
} | null = null;
|
|
|
|
function getDeclaredAdapterModels(): ReturnType<typeof parseAdapterModelsEnv> {
|
|
const raw = process.env.PAPERCLIP_ADAPTER_MODELS;
|
|
if (adapterModelsEnvCache && adapterModelsEnvCache.raw === raw) {
|
|
return adapterModelsEnvCache.value;
|
|
}
|
|
let value: ReturnType<typeof parseAdapterModelsEnv> = null;
|
|
try {
|
|
value = parseAdapterModelsEnv(process.env);
|
|
} catch (err) {
|
|
console.error(
|
|
"[paperclip] Invalid PAPERCLIP_ADAPTER_MODELS; ignoring declared model lists:",
|
|
err,
|
|
);
|
|
}
|
|
adapterModelsEnvCache = { raw, value };
|
|
return value;
|
|
}
|
|
|
|
function declaredModelsForAdapter(type: string): { id: string; label: string }[] | null {
|
|
const declared = getDeclaredAdapterModels()?.[type];
|
|
return declared?.length
|
|
? declared.map((model) => ({ id: model.id, label: model.label ?? model.id }))
|
|
: null;
|
|
}
|
|
|
|
export async function listAdapterModels(type: string): Promise<{ id: string; label: string }[]> {
|
|
const declaredModels = declaredModelsForAdapter(type);
|
|
if (declaredModels) return declaredModels;
|
|
const adapter = findActiveServerAdapter(type);
|
|
if (!adapter) return [];
|
|
// The built-in Codex adapter's OpenAI discovery includes image, audio, and
|
|
// embedding models that Codex cannot run. Use its curated list; declared
|
|
// models above and custom adapter discovery remain authoritative.
|
|
if (adapter === codexLocalAdapter) return adapter.models ?? [];
|
|
if (adapter.listModels) {
|
|
const discovered = await adapter.listModels();
|
|
if (discovered.length > 0) return discovered;
|
|
}
|
|
return adapter.models ?? [];
|
|
}
|
|
|
|
export async function refreshAdapterModels(type: string): Promise<{ id: string; label: string }[]> {
|
|
const declaredModels = declaredModelsForAdapter(type);
|
|
if (declaredModels) return declaredModels;
|
|
if (findActiveServerAdapter(type) === codexLocalAdapter) return listAdapterModels(type);
|
|
const adapter = findActiveServerAdapter(type);
|
|
if (!adapter) return [];
|
|
if (adapter.refreshModels) {
|
|
const refreshed = await adapter.refreshModels();
|
|
if (refreshed.length > 0) return refreshed;
|
|
}
|
|
if (adapter.listModels) {
|
|
const discovered = await adapter.listModels();
|
|
if (discovered.length > 0) return discovered;
|
|
}
|
|
return adapter.models ?? [];
|
|
}
|
|
|
|
export function listServerAdapters(): ServerAdapterModule[] {
|
|
return Array.from(adaptersByType.values());
|
|
}
|
|
|
|
/**
|
|
* List adapters excluding those that are disabled in settings.
|
|
* Used for menus and agent creation flows — disabled adapters remain
|
|
* functional for existing agents but hidden from selection.
|
|
*/
|
|
export function listEnabledServerAdapters(): ServerAdapterModule[] {
|
|
const disabled = getDisabledAdapterTypesFromStore();
|
|
const disabledSet = disabled.length > 0 ? new Set(disabled) : null;
|
|
return disabledSet
|
|
? Array.from(adaptersByType.values()).filter((a) => !disabledSet.has(a.type))
|
|
: Array.from(adaptersByType.values());
|
|
}
|
|
|
|
export async function detectAdapterModel(
|
|
type: string,
|
|
): Promise<{ model: string; provider: string; source: string; candidates?: string[] } | null> {
|
|
const adapter = findActiveServerAdapter(type);
|
|
if (!adapter?.detectModel) return null;
|
|
const detected = await adapter.detectModel();
|
|
if (!detected) return null;
|
|
return {
|
|
model: detected.model,
|
|
provider: detected.provider,
|
|
source: detected.source,
|
|
...(detected.candidates?.length ? { candidates: detected.candidates } : {}),
|
|
};
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Override pause / resume
|
|
// ---------------------------------------------------------------------------
|
|
|
|
/**
|
|
* Pause or resume an external override for a builtin adapter type.
|
|
*
|
|
* - `paused = true` → subsequent calls to `getServerAdapter(type)` return
|
|
* the builtin fallback instead of the external adapter. Already-running
|
|
* agent sessions are unaffected (they hold a reference to the module they
|
|
* started with).
|
|
*
|
|
* - `paused = false` → the external adapter is active again.
|
|
*
|
|
* Returns `true` if the state actually changed, `false` if the type is not
|
|
* an override or was already in the requested state.
|
|
*/
|
|
export function setOverridePaused(type: string, paused: boolean): boolean {
|
|
if (!builtinFallbacks.has(type)) return false;
|
|
const wasPaused = pausedOverrides.has(type);
|
|
if (paused && !wasPaused) {
|
|
pausedOverrides.add(type);
|
|
console.log(`[paperclip] Override paused for "${type}" — builtin adapter restored`);
|
|
return true;
|
|
}
|
|
if (!paused && wasPaused) {
|
|
pausedOverrides.delete(type);
|
|
console.log(`[paperclip] Override resumed for "${type}" — external adapter active`);
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/** Check whether the external override for a builtin type is currently paused. */
|
|
export function isOverridePaused(type: string): boolean {
|
|
return pausedOverrides.has(type);
|
|
}
|
|
|
|
/** Get the set of types whose overrides are currently paused. */
|
|
export function getPausedOverrides(): Set<string> {
|
|
return pausedOverrides;
|
|
}
|
|
|
|
export function findServerAdapter(type: string): ServerAdapterModule | null {
|
|
return adaptersByType.get(type) ?? null;
|
|
}
|
|
|
|
export function findActiveServerAdapter(type: string): ServerAdapterModule | null {
|
|
if (pausedOverrides.has(type)) {
|
|
const fallback = builtinFallbacks.get(type);
|
|
if (fallback) return fallback;
|
|
}
|
|
return adaptersByType.get(type) ?? null;
|
|
}
|