Files
PaperClipAI/server/src/adapters/registry.ts
T
DottaandPaperclip 57e977be72 feat: integrate Pi 1.0 into the experimental Runner (#14921)
## Thinking Path

> - Paperclip manages AI agents and their work.
> - The experimental Runner owns provider processes and durable
sessions.
> - Pi needs working task execution and human controls.
> - The five-PR stack must preserve changes already on master.
> - Each layer now carries the complete integrated source for a safe
sequential fallback.
> - This PR belongs to native GitHub stack #15602, ending at #14956.

## Linked Issues or Issue Description

Refs #14436, #14631, #14743 and #14956.

Ship Pi 1.0 through the experimental Paperclip Runner. The five PRs are
#14921, #14922, #14923, #14924 and #14956. The user authorized the
complete merge after checks pass. Existing `pi_local` execution is
unchanged. Accounting and wider provider/platform qualification remain
deferred.

## What Changed

- Recover missing final replies after workspace finalization changes
owners, using accepted-turn evidence without rerunning work or granting
external-chat publication.
- Preserve the admitted Pi instruction root across warm runs, while
retaining changed-root rejection.
- Give Pi a bounded 15-second default shutdown grace so stop, drain
acknowledgement and durable suspension can complete. Explicit deadlines
and other providers retain their existing behavior.
- Integrate the Pi 1.0 runtime and master contracts.
- Use Pi profile 22. Preserve explicit caller-selected models and exact
native thinking levels. Keep Pi's wrapper, helper, extension and
question/control behavior unchanged from the qualified profile-19
runtime.
- Preserve master's Dot lifecycle and consent fields, configured task
environment, status guards and current Codex/Claude dependency versions.
Cursor stays qualified. Copilot stays pending; profile 17 binds the
changed shared protocol validation sources.
- Exclude general AWS IAM credentials from Pi static/custom provider
bindings and selected task projections; preserve the provider-scoped
Bedrock bearer key. Profile 21 is retained as historical provenance.
Rust and cloud install probes use the current declaration.
- Patch bundled brace-expansion 5.0.9 to the exact official 5.0.12
payload. Pin the patch and complete runtime closures. Include the patch
in normal installed setup tooling. Keep the upstream Pi shrinkwrap as
provenance and permit only this exact security correction.
- Include current attestation files in the Docker build context. Keep
the repository lockfile unchanged from master. CI and private image
builds resolve manifest changes before their frozen installation.

## Verification

- Full local `pnpm -r typecheck` passes, including Runner Rust, server
and UI. Focused integration checks pass: 194 Runner
admission/environment tests, 63 profile/credential tests with one
expected skip, 152 Dot/UI configuration tests, and Pi transcript/notice
tests.
- Full local `pnpm build` passes on the final source.
- Fresh final-source checks pass: all 698 Rust workspace tests (32
binaries), 156 credential/profile/controller tests with one expected
skip, Runner TypeScript typecheck, and 20 package/setup/sandbox tests.
- The profile-21 Pi materializer passes on the native host with the
official pinned Node 24.21.0 and its npm. It verifies all 150 locked
packages, the patched dependency and the exact closure. Setup/package
bundle tests and UI token gates pass.
- The old hashes were reproduced for all three supported targets before
calculating the patched graph. New closure hashes are darwin-arm64
`282022db10150c6632b3444df421342e7d534bdf5d5fb1097a2e79d0625a2bcf`,
darwin-x64
`64e251e19009f755c0b04f73ce2138246faab71a961b0f13d75ebfcc34bef12e`, and
linux-x64
`713b1fdff42fb56a1518bdc084f181d70bee8ebadc3e4b1d76321ed9108c8410`.
Independent native platform execution is separate from graph identity
reproduction.
- Historical cloud qualification remains unchanged: all seven core cases
pass on shipping source `10dc43c9ec65d88c2f782d62afb296d09494f215`,
harness `1a4408a48cfb5a1f094a311141c257c92cd7a893`, image
`sha256:5b3a775b383591bda1b0c1889e509acc70ce7f37c53f09733c81d59037f02280`,
and accepted Sonnet 4.6/low fixture. All 215 canonical files and all
seven cleanup checks pass independent verification. These are profile-19
results and are not relabeled as fresh profile-22 runs.
- Current Pi digest:
`sha256:e92078bee3c23bec4100aa589013a44613d054cd686826534025d8019e9f39a9`.
[The readiness
plan](https://github.com/paperclipai/paperclip/blob/codex/pi-production-readiness/doc/plans/2026-10-02-pi-production-readiness.md)
preserves campaign and failed-attempt provenance.
- Merge only after every PR's current-head CI and fresh review pass.
Linux CI covers the full suites, build and browser tests. The local
embedded Postgres API-authority suite cannot start on this macOS/Node 26
host, so Linux CI must confirm that suite.

### Fresh profile-22 core qualification — 2026-10-08

All seven accepted core cases pass canonically on Pi profile 22, with
`openrouter/anthropic/claude-sonnet-4.6` and native-confirmed low
thinking. This model is a fixture; production accepts the caller's
explicit Pi provider/model.

Runtime/install source: `3241a992f2a7703e59e97ed0fd3e5d6405de4401`.
Frozen accepted harness: `1a4408a48cfb5a1f094a311141c257c92cd7a893`.
Immutable cloud image:
`ghcr.io/paperclipai/paperclip-daytona-runner@sha256:506f22db7edd78f37c0c40bec1cc084af1850455026dbf467194bfbb8fcef141`.
Pi digest:
`sha256:e92078bee3c23bec4100aa589013a44613d054cd686826534025d8019e9f39a9`.

[Hosted Linux image and clean-install
verification](https://github.com/paperclipai/paperclip/actions/runs/37868328023)
passes, including all 20 source-bound archives, normal CLI/Pi setup,
companion import and the production pack reader. This exact installation
source includes the latest master integration and the corrected Pi warm
instruction-root fence. Full local typecheck/build and current-head
hosted CI verify the final stack. All 13 focused real-root regressions
pass. The full local executor suite passed 662 tests; 15 database tests
could not start the Mac embedded PostgreSQL service. Hosted Linux CI
passes the full required verification and E2E checks. These fresh
results keep their own source identity; profile-19 results remain
historical.

| Core path | Canonical campaign | Retained archive SHA-256 |
| --- | --- | --- |
| File edit, validation, download and Done |
`pi-core22-replyfix-0-1791511228` | 23 files;
`a473e8603a3dd4737863291f8d3d1e392391f0b16d433c3e0e0e9d8baf7a97b0` |
| Pending question and controller restart |
`pi-core22-replyfix-1-1791511376` | 33 files;
`6b829c4eb74e1f32a89c692a4ae7130dbfc1c6d3cf13915effe2103d9e242c8e` |
| Three-turn session/process/workspace continuity |
`pi-core22-replyfix-2-1791511587` | 23 files;
`7a87021f8f9a3fdd3c58bb4467f8d82c635e3ea4795d6e75f144d9aa14818df8` |
| Four typed questions and browser reconnects |
`pi-core22-replyfix-3-1791511881` | 42 files;
`9e31755252be1f4f9cb0626c984c142d4d1ae5f5bee3a7af08444db8d12c280a` |
| Plan approval and completion | `pi-core22-replyfix-4-1791512031` | 22
files;
`a0383ce1aab38e7b5a25ce0e9dd3bebea5c037ebd96ae6b29dae19015da2ae2c` |
| Same-turn steering and permission denial |
`pi-core22-replyfix-5-1791512261` | 39 files;
`c929b8c7070f0b66aedc17e65ca46e6beab1e363926ac9f7e2a75fb250f05949` |
| Stop during pending permission | `pi-core22-replyfix-6-1791512390` |
33 files;
`7f0a58ae0f4d5bfc76149435f4e322537089c5bd16e7ffe9b5ad71f10a621a07` |

All 215 canonical files (28714587 bytes) are independently
hash-verified. All seven cleanup grades pass, with no owned runtime
process or temporary root after each case. Automatic retries are zero.
The owned cloud host stopped normally after retention. The prior
profile-22 warm attempt remains failed and separately retained: archive
SHA-256
`1e54eba5ec72b50cee1534b23d1d1d4f21a090006b8a64501ba70db972abfde5`. Its
original canonical classification is preserved. Diagnosis reproduced a
product bug comparing an agent-files root against an unset
checkpoint-only field. The fix stores the admitted physical root
separately from the adopted per-run collection capability. The real-root
regression fails before the fix and passes afterward, including
rejection of a changed physical root. Fixture, grader, model and all
seven accepted case IDs are unchanged; this fresh campaign tests
final-reply publication after file registration first. The intermediate
restart attempt also remains failed and retained: archive SHA-256
`5dcaefdf1d17cf4cd54fd4cf810f45e736667392339b8ce7caf08bb4e225277f`. Its
original canonical classification is preserved. Pi resumed, wrote the
verified answer and completed its task; exact runner suspension was
proven, but idle stop consumed about 5.2s and left under 3s for the
drain acknowledgement. The Pi-only default shutdown grace is now 15s,
preserving a full 5s drain round trip and a finite suspension reserve.
Explicit caller deadlines, other provider defaults, literal drain
receipts and exact suspension identity checks remain unchanged. The
timing regression fails before this correction and passes afterward; all
18 focused settlement tests and Runner typecheck pass. The final-source
file attempt is also preserved as failed (`candidate_failure`), archive
SHA-256
`db6767b6773ea618997927ac77bdb005a5ac81492c7b9c0ffbc900449f829bc9`.
Native edit, validation, exact downloadable artifact and Done/succeeded
all passed, and the exact final reply was durably recorded. A workspace
recovery owner completed before the live heartbeat reached presentation,
leaving that reply absent from task chat. Recovery now materializes only
a completed final reply from the accepted turn of an ordinary internal
Done task, preserving issue/run/contract binding, suppression,
external-chat authorization and same-run deduplication. The database
regression covers the generated file-preparation receipt, suppression,
unapproved external continuation and replay. Server typecheck and all 49
response-selection tests pass; hosted Linux verifies the database
regression because embedded PostgreSQL cannot start on this Mac.

The delayed-final-answer database regression passes on [the final
root-source Linux server
shard](https://github.com/paperclipai/paperclip/actions/runs/37868262553/job/113628594152),
alongside 1,108 passing tests. The first root Runner shard had one
unchanged durable-resume test exceed its 5-second timeout; the identical
top-source shard and the isolated exact test passed. One rerun of that
failed job and its required aggregate passed without source or test
changes. The original failed job log and the single-rerun receipt remain
retained.

### October 9 merge verification

Current merge head: `5a8fe63512a7166aaef5cf50065a25008aa8b44b`. All
current-head checks pass, including `ci / verify` and `ci / e2e`;
exact-head Greptile review is 5/5 with no unresolved threads. Current
master conflicts are resolved. The user authorized the maintainer
override of the code-owner review gate after these checks. The seven
retained live core cases remain bound to source
`3241a992f2a7703e59e97ed0fd3e5d6405de4401` and its recorded cloud image.

## Risks

- The security correction changes the dependency closure and profile
identity. Old sessions must reopen on the new profile. Exact identities
and credential bindings fail closed.
- The runner remains experimental and requires explicit selection.
Legacy Pi Local is unchanged. Caller model IDs pass through; the E2E
model is a fixture.
- Accounting and the broad platform/provider matrix remain deferred.
This merge does not publish a release or deploy a service.

## Model Used

OpenAI GPT-6 through Codex assisted with reasoning, repository
inspection, editing and tool use. The exact serving ID and context
window are not exposed in this session. Final live qualification uses Pi
1.0.0 with `openrouter/anthropic/claude-sonnet-4.6` and native-confirmed
low thinking.

## 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
#` OR (b) described the issue in-PR following the relevant issue
template
- [x] I have not referenced internal/instance-local Paperclip issues or
links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip`
URLs)
- [x] My branch name describes the change (e.g. `docs/...`, `fix/...`)
and contains no internal Paperclip ticket id or instance-derived details
- [x] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [x] All Paperclip CI gates are green
- [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge

---------

Co-authored-by: Paperclip <noreply@paperclip.ing>
2026-10-09 08:56:41 -05:00

1196 lines
45 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 === "openai_dot") {
return { adapterType: "paperclip_runner", status: "warn" as const, testedAt: new Date().toISOString(),
checks: [{ code: "dot_event_test_required", level: "warn" as const, message: "Dot manages its model and billing. Validate the dedicated agent binding and event round trip in Paperclip; this read-only check does not wake the Dot." }] };
}
if (profile.provider === "acpx") {
if (["copilot"].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" && profile.acpxAgent !== "pi") 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, probeAcpxPiInstallation } = await import("../vendor/paperclip-runner/live/index.js");
await (profile.acpxAgent === "pi" ? probeAcpxPiInstallation : 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/Pi through the Rust Paperclip runner and authenticated PRP transport. Pi accepts an explicit provider/model ID and uses the company credentials bound to the agent environment. GitHub Copilot awaits local and Daytona qualification. 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: "acpxSessionMode",
label: "Cursor mode",
type: "select" as const,
default: "agent",
options: [
{ value: "agent", label: "Agent" },
{ value: "plan", label: "Plan" },
{ value: "ask", label: "Ask" },
],
hint: "Select Cursor's session mode. Permissions and company approval rules still apply.",
meta: { visibleWhen: { key: "acpxAgent", value: "cursor" } },
},
{
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;
}