mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-28 12:04:41 +01:00
## Thinking Path > - Paperclip manages work for AI agents. > - Runner can execute in a different environment from Core. > - Core owns provider selection, policy, and resource assignments. > - The execution environment must prepare its own files and paths. > - A shared contract must keep these responsibilities separate. > - This PR adds that contract to the Runner execution driver. ## Linked Issues or Issue Description **Problem or motivation** Runner transport prepares provider files on the controller before launch. An execution owner cannot prepare those files in its own environment through the existing driver. **Proposed solution** Add `prepareLaunch` to the execution driver. Supply versioned Core requirements. Accept a configuration ID, requirements digest, and ordinary provider descriptor. Validate Core policy and assignments before launch. Keep existing provider session checks. **Alternatives considered** Provider-specific ownership flags would spread the boundary across backends. Shell preparation would expose process details in the plugin API. Refs #16993, #16977. Both prerequisites are merged. This PR now targets master. Native plugin integration and execution-host preparation follow separately. PR #16978 contains an earlier, unmerged prototype. Its `persistentAgentHome` mode and skill path-map call will be replaced by this preparation contract before activation. This PR preserves current master callers of the skill helper. ## What Changed - Add the optional preparation callback and an explicit Runner artifact identity. - Keep the built-in preparation path as the default. - Validate provider policy and resource assignment identity. Preserve instruction text when resource locations change. - Persist the attachment seed after an authority epoch rotation, so a later controller restart can recover the same run. - Preserve explicit context removal on a new run. Only an omitted context can reuse the saved context. Remove its registered instruction framing when context is removed. - Save exact requirements and configurations in a private file outside Runner commands. Retain the active record across failed attachments. Use current grants for new runs. Keep incompatible session changes rejected. - Join delayed preparation during startup and warm attachment cleanup. Retain an unsettled checkpoint after a timeout. Prevent work after cancellation. - Use the supplied Runner artifact for interrupted handoff recovery. Restore the exact target configuration at each handoff crash boundary. Check the Runner state when the final ACK may be lost. - Bind the changed shared sources to Copilot profile v51. Preserve the v50 receipt and current integrity checks. ## Verification - Workspace typecheck passed. - All 487 affected Runner transport, control-plane, preparation store, builder, policy, and profile tests passed on commit `eaf8ae8d1`. - Workspace build and typecheck passed again on commit `eaf8ae8d12c7ef2d22d226e4b3f05fdbf79ef4cb`. - Both warm attachment cleanup regressions fail before the fix. They pass after the fix. The tests cover delayed preparation, timeout retention, and concurrent attachment rejection. - The routed handoff regression fails with a missing controller binary before the fix. It passes after the fix. The execution owner launches the real fixture Runner. - The 200,000-byte instruction regression fails before the fix and passes after it. Four prepared handoff crash cases verify exact request and configuration recovery. The store tests verify private file mode, conflicting records, corrupt data, and active-run retention. - A real Runner with a controlled fake provider verifies execution-host paths, exact recovery, warm reuse, incompatible profile rejection, and cancellation. It does not contact an external provider. - The regression found undefined settings in strict PRP command hashing. Requirements now contain only JSON values. The warm transition test passes without changing PRP validation. - The broader root suite on the prerequisite finished with 22,420 passing tests, seven failed tests in unchanged Git and diagnostic code, and two suite setup errors because Cargo was absent from its PATH. This PR does not claim a passing full root suite. - The CI Build job passed compilation and production runtime boot, then its runner received a shutdown signal during the clean public install check. Other jobs reported lost communication with their self-hosted runners. The failed jobs passed on retry on the same commit; successful jobs kept their results. - The current Superagent security scan is inconclusive because its pinned merge-base checkout failed or timed out. GitHub rejected the check rerun request through the available API. This is not a passing security scan. - Standard Greptile and Greptile Apex each returned 5/5 on `eaf8ae8d1`. All review threads are resolved. CI passed on attempt 2. Current checks have 55 successes, four optional skips, and the inconclusive security scan described above. The branch is ready, mergeable, and current with master. - No live provider qualification or deployment was run. ## Risks - A preparation owner must store configurations and keep retries bound to the same task and requirements. - Copilot source binding requires a new profile identity. This PR does not claim fresh live qualification. - The callback is an SDK extension. This PR does not connect it to a plugin task process owner or add a Launcher endpoint. ## Model Used - OpenAI Codex, GPT-6. Reasoning and repository tools. The exact serving model identifier and context size are not exposed in this session. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change (e.g. `docs/...`, `fix/...`) and contains no internal Paperclip ticket id or instance-derived details - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] All Paperclip CI gates are green - [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
887 lines
58 KiB
Markdown
887 lines
58 KiB
Markdown
# Paperclip Native Runner
|
|
|
|
To add a harness/provider to native Runner, start with
|
|
[create-runner-adapter](../../.agents/skills/create-runner-adapter/SKILL.md), the
|
|
[Runner integration playbook](../../doc/RUNNER-INTEGRATION-PLAYBOOK.md), and
|
|
[acceptance/evidence templates](../../doc/runner-integration-templates.md).
|
|
They cover the new Runner integration path; legacy adapters are preserved as a
|
|
compatibility boundary.
|
|
|
|
This package is the standalone development boundary for Paperclip's native
|
|
runner protocol, process supervision, durable transport, provider drivers, and
|
|
normalized session backends. Rust owns the production runner under `runner/`;
|
|
TypeScript provides the control-plane reference, browser SDK, scenario tools,
|
|
and conformance oracle.
|
|
|
|
The package includes one coherent set of capabilities: PRP v1 validation and
|
|
replay, a supervised local runner with a scripted fake harness, durable
|
|
WebSocket delivery and recovery, qualified Codex, OpenCode, ACPX, Claude
|
|
Managed, and AWS AgentCore drivers, live
|
|
session and issue-thread surfaces, a public browser/React SDK, a standalone
|
|
adapter demo, and a deterministic mock control plane. None of these surfaces
|
|
imports or starts Paperclip's server, UI, CLI, or production database.
|
|
|
|
## Execution environment lifecycle
|
|
|
|
`RunnerExecutionDriver` defines the environment hooks shared by coding harnesses
|
|
and external bot harnesses. The server's `createNativeRunnerExecutionDriver`
|
|
supplies this contract for local, SSH, and sandbox execution. Provider-specific
|
|
session setup stays separate from environment selection.
|
|
|
|
Connection registration prepares remote resources and returns the process's
|
|
connection configuration before launch. Local Runners connect to Core over
|
|
loopback WS. SSH Runners and eligible sandboxes connect to the configured Core
|
|
WSS endpoint. Sandboxes with authorized WebSocket ingress listen inside the
|
|
sandbox; Core connects through the provider endpoint after process dispatch.
|
|
Ingress selection fails closed and does not fall back to outbound WSS.
|
|
|
|
The returned activation, readiness, failure, checkpoint, and release hooks feed
|
|
the existing shared PRP control plane. PRP owns authentication, commands, replay,
|
|
tool authority, and run transitions. Process ownership hooks provide launch,
|
|
verified adoption, and durable state access. A lost connection does not prove
|
|
process termination, and a required checkpoint failure must prevent lease release.
|
|
|
|
The driver is an in-process interface. Its filesystem paths and process launch
|
|
specifications are internal to built-in execution; they are not a plugin wire
|
|
contract. Existing flat transport options remain compatible through this shared
|
|
interface. This refactor does not add Launcher APIs or change harness capabilities.
|
|
|
|
An execution owner can supply `prepareLaunch`, a Runner artifact identity, and
|
|
process and connection hooks. Core supplies the launch requirements. The owner
|
|
returns a provider descriptor bound to those requirements. Core checks the policy
|
|
and assigned resources. See [Runner launch preparation](../../doc/runner-launch-preparation.md)
|
|
for the contract and recovery record.
|
|
|
|
Connection continuations inspect the harness descriptor's optional
|
|
`toolRefreshOnResume` capability. Native Codex, Claude Managed Agents, AgentCore,
|
|
OpenCode, and qualified Claude/Codex/Grok ACPX profiles expose it; unqualified
|
|
harnesses leave it false or absent. Changing tools can replace a provider process while retaining
|
|
the provider conversation. Company, agent, task, workspace, model, instruction,
|
|
and skill compatibility still gate recovery. An MCP-only assignment change can
|
|
resume only when the selected harness explicitly supports refreshing tools.
|
|
|
|
Compact continuation messages include the active completion revision and criterion
|
|
IDs plus a reminder to obtain an accepted `paperclip_finish` or `paperclip_block`
|
|
result for this turn. Reports from earlier turns do not finish the new turn.
|
|
Provider final text alone remains insufficient; governed waits and strict native
|
|
completion validation keep their existing behavior. This reminder changes the
|
|
resumed model input, not the tool catalog or automatic retry policy.
|
|
|
|
When recovery needs a fresh conversation, the server supplies a deterministic
|
|
handoff through a lazy history loader at the fresh attempt boundary.
|
|
It includes the original request, recent messages, resolved interaction
|
|
summaries, agent replies, and document excerpts, with source identities and
|
|
retrieval instructions. Reads and excerpts are bounded; the handoff has a
|
|
24,000-byte ceiling and explicit truncation/omission markers. Conversation
|
|
reset boundaries, deleted messages, source quarantine, and secret redaction
|
|
apply before model submission. Successful recovery does not fetch or replay the
|
|
handoff.
|
|
Legacy adapters advertise `supportsToolRefreshOnResume` for their selected
|
|
harness: Claude and Codex CLI/ACP, Grok CLI, Gemini/Kimi CLI/ACP, and
|
|
Cursor/OpenCode/Pi CLI. CLI adapters using environment tool delivery start each
|
|
invocation with current endpoints and credentials, including resumed turns. ACP reloads
|
|
current MCP bindings, including run-scoped credentials, while preserving the
|
|
conversation; an unqualified/custom harness retains its restart fence.
|
|
Legacy fresh attempts receive the same bounded handoff, including resume-failure
|
|
fallbacks. Provider
|
|
authentication repairs retain their existing fresh-session recovery behavior.
|
|
|
|
## ACPX release declarations
|
|
|
|
`acpx-profiles.json` owns the package versions, command/profile digests, and
|
|
required execution policies used by TypeScript and Rust. It contains no models.
|
|
After changing it, run `pnpm --filter @paperclipai/paperclip-runner generate:acpx-profiles`.
|
|
Normal build and typecheck reject stale generated declarations. Generation also
|
|
checks installed dependency pins and agreement with Cursor's distribution manifest
|
|
and immutable release attestation (`cursor-contract.json`). Cursor's per-platform
|
|
closure pins are generated from `cursor-distributions.json`.
|
|
|
|
Codex startup and browser login prefer the CLI from the installed dependency
|
|
graph. If that dependency is absent, they use an executable `codex` from the
|
|
selected execution host's `PATH`. An explicit execution command takes precedence,
|
|
and resumed sessions retain their recorded command. Older or newer CLI versions
|
|
are allowed. Relative PATH entries use the selected process working directory.
|
|
Compatibility is established by the actual protocol or login attempt.
|
|
Missing executables and real protocol failures still return actionable errors.
|
|
Package identity and executable containment remain checked. Browser login keeps
|
|
its provider-specific credential home and resolves the installed Codex CLI on
|
|
64-bit Linux and macOS independently of the daemon's libc requirements.
|
|
|
|
Exact dependency pins remain release and ACPX artifact-qualification checks.
|
|
They make published builds reproducible and verify sandbox artifacts; they do not
|
|
add a version-number gate to ordinary native Codex startup or browser login.
|
|
|
|
Release packages retain the pinned Codex JavaScript dependency graph, but do not
|
|
bundle Codex native binaries. The published manifest declares the official,
|
|
exact-version platform packages as optional dependencies. npm installs the
|
|
package for the consumer's operating system and architecture. Those declarations
|
|
belong to the published server manifest; the bundled JavaScript wrapper delegates
|
|
platform installation there so npm can keep native and legacy versions separate.
|
|
The wrapper code and patched ACP bridge stay unchanged.
|
|
Codex sandbox read roots include the separately installed native vendor resources
|
|
without granting access to enclosing npm directories or credential homes.
|
|
This packaging does not change agent defaults or
|
|
the selected runner of an existing agent.
|
|
|
|
Every ACPX harness accepts an explicit caller-selected model without a Paperclip
|
|
model allowlist. The adapter sends that ID unchanged and verifies the provider's
|
|
effective model before prompting. An incomplete discovery catalog does not block
|
|
selection; a provider rejection or mismatch fails without choosing a fallback.
|
|
Qualification model selections live in test catalogs, separately from optional
|
|
product defaults. The legacy resolved snapshot field `qualificationModel` contains
|
|
the caller's selected model; its serialized name preserves recovery identities.
|
|
Historical profile fixtures remain immutable evidence, not release declarations.
|
|
|
|
Pi credentials are selected from the explicit run environment and remain session-bound.
|
|
The native Rust launcher forwards the controller-bound credential names, including
|
|
custom provider references, without restricting Pi to an OpenRouter credential.
|
|
Built-in providers can use their usual API-key environment variables. Custom Pi
|
|
providers are supported through `PAPERCLIP_PI_PROVIDERS`: a JSON object containing
|
|
the native `models.json` provider entries (without the outer `providers` key).
|
|
The runner writes that configuration to the private Pi agent directory and binds
|
|
its digest to recovery. API-key and header environment references are forwarded
|
|
only from the explicit run environment; command-based credential resolution is
|
|
unsupported. Select the provider/model ID explicitly in the agent configuration.
|
|
The bundled ACPX package tests exercise unlisted model selection, rejection,
|
|
exact acknowledgement, and replay on a loaded connection. Catalog membership
|
|
and Cursor model-alias expansion do not determine the selected model.
|
|
Provider activity adapters own native tool identities, evidence, and diagnostic
|
|
usage projection; the shared driver and sidecar consume those hooks.
|
|
|
|
## Public package surfaces
|
|
|
|
- `@paperclipai/paperclip-runner` — production contracts, clients/backends,
|
|
PRP validation/replay, canonical catalog/dispatcher, and compatibility check.
|
|
- `@paperclipai/paperclip-runner/testing` — deterministic mocks plus PRP and
|
|
semantic conformance kits. Tests and external conformance consumers import
|
|
this explicitly.
|
|
- `@paperclipai/paperclip-runner/evals` — versioned native-attempt metadata,
|
|
fail-closed package/binary compatibility checks, and explicit runnerd
|
|
artifact resolution for eval consumers.
|
|
|
|
The package root has no mock or scenario exports. Generic credential-free
|
|
matrix orchestration lives in the workspace-private
|
|
`@paperclipai/paperclip-eval-kernel`; scenario content and provider-backed eval
|
|
campaigns remain outside the runtime package.
|
|
See [ADR 0001](docs/adr/0001-runner-testing-eval-package-boundaries.md).
|
|
|
|
The two conformance surfaces intentionally prove different contracts. The
|
|
existing `runControlPlanePortConformance` suite checks narrow PRP run/event
|
|
persistence. `CAPABILITY_HIGH_RISK_SEMANTIC_VECTORS` and
|
|
`runSemanticConformanceKit` compare normalized tool authorization, state,
|
|
effects, audit, retries, conflicts, redaction, continuation, and terminal
|
|
decisions. The production adapter stays App-owned and invokes Paperclip's real
|
|
route/service authorities; it does not copy those rules into this package.
|
|
|
|
## Quick start
|
|
|
|
Native provider debug-trace correlation uses an incremental index owned by its transport. Pending
|
|
event lookups read only newly appended bytes, with a 1 MiB read budget per lookup;
|
|
they retry until the observed suffix is indexed. Partial records remain pending,
|
|
and trace replacement or truncation invalidates the index. Closing a transport
|
|
clears its index. Other active transports cannot evict its progress. Records over
|
|
64 KiB are skipped by the correlation index without buffering or parsing their
|
|
full contents; the original trace file retains them. Do not restore a full
|
|
synchronous trace scan for each pending event: it blocks event delivery and can
|
|
leave the board showing an active run after the provider turn has already ended.
|
|
|
|
The package also builds `paperclip-runner-acpx-sidecar`. This bounded v2
|
|
stdin/stdout bridge admits the pinned Claude, Codex, Grok and Cursor ACPX profiles.
|
|
It validates the exact model, session identity, tool catalog, structured input,
|
|
and terminal settlement at the process boundary. Copilot and Pi remain gated.
|
|
Verified distributions are build-owned; no provider accepts an arbitrary executable.
|
|
See [the rich ACP capability report](../../doc/architecture/runner-rich-acp-capabilities.md).
|
|
|
|
Install Cursor explicitly with `paperclipai runtime setup cursor`; npm installation
|
|
does not download it. Run setup as the OS user that runs Paperclip (the service
|
|
account for a managed service). Setup writes to that account's
|
|
`~/.paperclip/runtimes/cursor/<platform>-<arch>/<closure-sha256>`, so a system-wide
|
|
npm installation can remain read-only. Isolated provider HOME/XDG settings do not
|
|
redirect this cache. Container images continue to use their packaged assets.
|
|
Configure a company secret binding for `CURSOR_API_KEY` or
|
|
`CURSOR_AUTH_TOKEN`, select Cursor in the Runner configuration, and select an exact
|
|
model ID. Agent is the default; Plan and Ask are explicit modes. Paperclip semantic
|
|
questions are supported. Native AskQuestion and authoritative per-run dollar usage
|
|
are unavailable. Accepting a native plan ends the planning run successfully while
|
|
the task waits for the next instruction. See the
|
|
[Cursor release report](../../doc/plans/2026-10-03-cursor-production-readiness.md).
|
|
|
|
A release includes all four platform daemons and the Linux provider-pack identity
|
|
from its matching Daytona image. Run `stage:release-binaries` with a manifest that
|
|
binds each daemon path and SHA-256, plus `remoteProviderPacks: {"linux-x64": {path, sha256}, "linux-arm64": {path, sha256}}` for
|
|
the actual image's `provider-pack.json`. Assemble these assets after the normal
|
|
build and include them in the server's vendored Runner output before npm packing.
|
|
Assembly requires the provider pack's source revision to match `sourceRevision`
|
|
and its ACPX profiles and Cursor distribution to match the current source pins.
|
|
An independently rehashed older pack is rejected.
|
|
Provider-pack builds replace the installed Copilot platform wrappers with relative
|
|
launchers. These wrappers remain usable after the pack moves into an image. The
|
|
build still rejects any wrapper that retains its temporary deployment path.
|
|
Ordinary remote Cursor startup uses the packaged Linux daemon and verifies every
|
|
image asset against that manifest. A mismatched image fails before the provider
|
|
starts; install the matching package and image together.
|
|
|
|
### Native binary platform baseline
|
|
|
|
Release packages contain Paperclip daemons for `linux-x64`, `linux-arm64`,
|
|
`darwin-arm64`, and `darwin-x64`. Codex native binaries are installed separately
|
|
through the official optional npm platform dependencies described above.
|
|
|
|
The shipped Linux daemons target **GNU libc 2.39 or newer**, on x86-64 or AArch64.
|
|
Their ELF version requirements include `GLIBC_2.39`; both depend on `libc.so.6`,
|
|
`libm.so.6`, `libgcc_s.so.1`, and the matching GNU dynamic loader. The ARM64
|
|
loader is `/lib/ld-linux-aarch64.so.1`; x64 uses
|
|
`/lib64/ld-linux-x86-64.so.2`. This is a binary compatibility baseline, not a
|
|
promise that every Linux distribution or kernel has been qualified.
|
|
|
|
Hosted native producers use Ubuntu 24.04 for both Linux architectures. Clean npm
|
|
install checks use the pinned Debian 13 Node image; the cloud Dockerfile uses
|
|
Debian 13 (`node:24-trixie-slim`). macOS binaries build on the existing macOS 15
|
|
Apple Silicon and Intel hosts. Actual task and follow-up acceptance is performed
|
|
on Apple Silicon; Intel qualification covers build, installation, and protocol
|
|
startup.
|
|
|
|
For sandbox environments, the existing explicit environment probe can measure
|
|
OS, architecture and libc from its allocated lease. It records those facts only
|
|
for an image pinned with `@sha256`, after confirmed lease cleanup. The record is
|
|
server-owned and bound to the company, effective provider/image configuration
|
|
and active custom-image identity. Creation and discovery read this record without
|
|
allocating a sandbox. Configuration or image changes invalidate it. Mutable tags,
|
|
provider defaults and unverified snapshot names do not establish compatibility;
|
|
they keep automatic Legacy selection until there is verifiable immutable image
|
|
or Daytona snapshot-ID evidence. See managed snapshot qualification below.
|
|
A connection-only success does not establish native readiness.
|
|
|
|
### Managed Daytona snapshot qualification
|
|
|
|
Claude's automatic Connect flow can qualify a named Daytona snapshot through the
|
|
existing administrator-only saved environment probe. The bundled Daytona plugin
|
|
resolves the name to its provider snapshot ID, creates the probe sandbox by ID,
|
|
and returns its account and creation identity. OS, architecture and libc facts
|
|
are recorded only after confirmed cleanup. Native execution uses that same
|
|
snapshot ID; discovery does not allocate or perform provider lookups. A deleted
|
|
snapshot fails at the provider rather than silently selecting a replacement with
|
|
the same name. Configuration, resolved credentials and active captured-template
|
|
changes require another probe. Other named provider templates and mutable OCI
|
|
tags remain unqualified. A provider plugin without snapshot identity support
|
|
returns an actionable setup failure; it cannot certify a native default.
|
|
|
|
|
|
On Linux, Codex's sandboxed filesystem modes also require the host to permit its
|
|
unprivileged namespaces. A no-privilege Docker container can prohibit nested
|
|
namespace creation even when installation and binary compatibility pass.
|
|
Qualification therefore retains the restricted Docker install/lifecycle checks
|
|
and exercises the same installed graph's read-only native startup on the actual
|
|
ARM host. This does not qualify arbitrary container or managed setup targets;
|
|
their selected runtime must pass setup in that environment.
|
|
|
|
Ubuntu 24.04 also needs system `bubblewrap` and the stock
|
|
`bwrap-userns-restrict` AppArmor profile described in
|
|
[Codex's Linux prerequisites](https://learn.chatgpt.com/docs/sandboxing#prerequisites).
|
|
The qualified ARM64 host uses that distribution helper/profile while retaining
|
|
AppArmor enforcement and global namespace restrictions. Hosted qualification
|
|
materializes authenticated stock package files without running maintainer
|
|
scripts; it verifies native startup and package continuity separately from the
|
|
restricted Docker installation check. This does not prove a normal OS package
|
|
installation journey or a paid provider task on ARM64.
|
|
|
|
Automatic creation selects legacy execution when a Linux host has musl, unknown
|
|
libc, or a measured GNU libc version below the baseline. Existing agents retain
|
|
their stored runner. Windows, 32-bit ARM, and Alpine/musl native qualification
|
|
remain deferred.
|
|
|
|
Native release jobs cache Cargo dependencies per platform and OS baseline,
|
|
including compiler, lockfile, and external generated-contract inputs. Workspace
|
|
crates and released binaries are rebuilt and verified every time. Only canonical
|
|
exact-source master pushes may save trusted caches; preview qualification can
|
|
restore them. JavaScript preparation and native compilation run concurrently,
|
|
and both must succeed before artifact metadata and source-bound hashes are
|
|
recorded. Run Docker and native qualification on hosted CI rather than a local
|
|
developer machine.
|
|
|
|
Pi cold provider admission has an absolute 60-second budget. Warm run attachment
|
|
checkpoints the old ACPX sidecar and starts a new one, so it uses that same budget
|
|
while retaining the existing Runner authority. Live adoption and ordinary
|
|
commands retain their 30-second bounds. Closing the transport cancels admission;
|
|
an acknowledgement received after the admission deadline cannot revive it.
|
|
|
|
The board's transcript parser coalesces consecutive identical Pi runtime-failure
|
|
display rows within one run, turn and session, including the exit handler and
|
|
its late prompt rejection. Both original PRP facts remain in the run log.
|
|
Distinct failure details, intervening retry activity and later turns remain
|
|
visible. The profile-14 notice projection, wrapper bytes and terminal settlement
|
|
remain unchanged.
|
|
|
|
Cursor candidate configuration accepts `acpxSessionMode: "agent" | "plan" | "ask"`
|
|
(default `agent`). This selects the native Cursor mode independently of
|
|
`acpxPermissionMode` and Paperclip task planning or company approvals. The mode
|
|
is validated at the API boundary and is bound to provider admission and recovery;
|
|
changing it cannot reuse an incompatible warm session. Other providers reject
|
|
this setting. Cursor configuration requires an explicit model. Pending providers retain
|
|
operator-controlled qualification admission.
|
|
|
|
|
|
Remote Codex sessions relay assigned app tools through the server's configured
|
|
gateway. Small catalogs are sent directly. When a catalog would exceed the
|
|
runner's 256-operation or 768 KiB contract limit, the server exposes
|
|
`paperclip_search_assigned_tools` and `paperclip_call_assigned_tool` instead.
|
|
Search returns bounded pages of names, descriptions, and input schemas. Each
|
|
page intersects the session's pinned assignments with current gateway grants.
|
|
An individual schema that exceeds a page returns an `inputSchemaRef`. The same
|
|
search tool retrieves that schema in chunks via `schemaTool` and
|
|
`schemaOffset`; discovery can continue past the large tool.
|
|
Calls retain task ownership, work-mode restrictions, gateway authorization,
|
|
approvals, and audit. Core task tools and the runner's completion tools keep
|
|
their reserved space; no assigned tools are silently removed to fit the limit.
|
|
|
|
Native Claude skill assignments travel in the runtime-context snapshot through
|
|
runnerd to the ACPX sidecar. After acquiring the provider lifetime lease, the
|
|
host materializes the assigned bundles under the isolated Claude home's
|
|
`skills/` directory before launch. Reopening a provider refreshes that snapshot;
|
|
project and ambient host settings remain excluded. This path is separate from
|
|
the legacy `claude_local` adapter's remote skill staging.
|
|
|
|
The isolated Claude settings pin both `model` and `availableModels` to the
|
|
user's requested ID. This keeps ACP from replacing an exact ID with a picker
|
|
alias during selection and verification. Users can keep selecting models from
|
|
the normal Claude catalog or entering custom IDs; unavailable models still fail
|
|
at the provider rather than silently falling back.
|
|
|
|
ACPX Claude defaults to `approve-all`, shown as **Full auto (approve all)**.
|
|
OpenCode defaults to `allow`; native Codex defaults to `never` (no approval
|
|
pauses). These defaults cover all assigned tools and connections, including
|
|
provider-native operations. Full auto is resolved consistently for agent
|
|
creation, adapter conversion, direct driver launches, and fresh/resumed turns.
|
|
Explicitly stored restrictive modes still apply.
|
|
|
|
Native OpenCode forwards incremental text and reasoning parts as they arrive;
|
|
the final full snapshot selects the final response without repeating streamed
|
|
text. Delta parts must match an observed message and part identity. Identical
|
|
chunks without event IDs remain distinct tokens. Each isolated launch disables
|
|
automatic updates, remote model-catalog refreshes, and default plugins; the
|
|
runner supplies the pinned executable, selected model, and assigned MCP tools.
|
|
Provider inference and reasoning still contribute to time to first text. These
|
|
startup settings do not disable model reasoning.
|
|
|
|
On macOS, the verified OpenCode executable keeps its private launch pathname
|
|
until the provider process exits. Removing that pathname immediately after
|
|
spawn can kill or stall the signed binary before its health check succeeds.
|
|
Ownership, permissions, and file-identity checks remain enforced; cleanup also
|
|
runs on failed launches, and retries create a fresh launch snapshot.
|
|
|
|
Call `session.startTurn({ message, reasoningMode: "disabled" })` to disable
|
|
reasoning for one OpenCode/OpenRouter turn. `CapabilityLiveSession.sendMessage`
|
|
accepts the same option in its second argument. The choice travels in the durable
|
|
`turn.start` command and selects an OpenCode model variant for that prompt only.
|
|
Omitting it (or passing `"default"`) on the next turn restores provider defaults,
|
|
including on a warm or recovered session. It is not an environment variable or
|
|
agent-wide setting. No automatic decision policy selects it. The model must
|
|
support disabling reasoning; other runner providers reject an explicit selection
|
|
before starting work. Native sessions expose support through the
|
|
`perTurnReasoning` capability.
|
|
|
|
OpenCode's proxy sends agent instructions once per turn through the system prompt. The
|
|
task envelope retains task-specific constraints and the completion contract,
|
|
without repeating the system instructions. This applies to all users of the
|
|
proxy; already-recorded conversation history is not rewritten.
|
|
|
|
The runner's authenticated bridge and controller still enforce company access,
|
|
action claims, task modes, and governed approvals. Provider permission defaults
|
|
do not change workspace isolation or grant credentials or connection access.
|
|
`approve-paperclip` remains an optional narrower mode for assigned planning and
|
|
task tools; `approve-reads` allows assigned reads; `deny-all` rejects requests.
|
|
None of these restrictive modes is the default.
|
|
|
|
`prepare_repository` requires a provider permission decision in restrictive
|
|
modes, including `approve-paperclip`: repository acquisition can clone onto the
|
|
controller and is not automatically approved as a planning action. Full auto
|
|
still allows it; repository acquisition currently has no cumulative disk quota.
|
|
|
|
Restrictive profiles route supported permission decisions through durable runtime
|
|
requests and the existing task interaction controls. Requests are persisted
|
|
before presentation; answers are checked against the offered decisions and
|
|
acknowledged by the sidecar before settlement. Unknown, stale and duplicate
|
|
responses fail. Missing provider decision support remains a blocked disposition,
|
|
not implicit approval. Company access checks still run for each Paperclip tool.
|
|
Provider death expires pending promises; approvals are never replayed into a
|
|
replacement process.
|
|
|
|
Automatic Paperclip/read allowances currently require the Claude SDK dispatch
|
|
boundary. Grok preserves these restricted settings, but its ACP requests lack
|
|
independently bound tool authority. Those operations require a supported operator
|
|
permission decision; a missing interactive responder stops with
|
|
`approval_required`. An explicitly selected `approve-all` policy permits unattended
|
|
Grok work in an assigned sandbox. Paperclip authorization and governed approvals
|
|
still apply.
|
|
|
|
Runnerd selects only qualified provider profiles. Claude Managed and AWS
|
|
AgentCore receive immutable company-profile snapshots with explicit retention,
|
|
spend, and invocation limits. No provider process receives a Paperclip API
|
|
credential or unrestricted server environment.
|
|
|
|
Claude Managed resolves its API key from the company secret bound to the
|
|
selected profile. AWS AgentCore uses workload identity only; long-lived static
|
|
AWS access keys are intentionally removed from the runner environment.
|
|
|
|
The Rust core includes a bounded client for the sidecar protocol. It enforces
|
|
request identity, event order, frame and queue limits, timeouts, redacted
|
|
diagnostics, and process-group cleanup. Runnerd selects this package-local
|
|
transport only through an exact qualified provider descriptor.
|
|
|
|
Before a later provider adapter consumes a valid sidecar event, the Rust core
|
|
also requires its optional or mandatory run and turn scope to match the active
|
|
execution. Process and diagnostic events can remain global. All operational,
|
|
tool, input, permission, and terminal events require the exact active binding.
|
|
|
|
A package-local payload boundary decodes events only after that scope check. It
|
|
validates control identities, terminal status, question sets, and the admitted
|
|
runtime event types and bounded fields. It redacts diagnostic and retained
|
|
event values again before they can enter provider state. Authoritative semantic
|
|
tool arguments are validated for transport bounds and forwarded unchanged,
|
|
including credential-bearing document and instruction content. The provider
|
|
harness owns credential policy; redaction of logs and audit previews must not
|
|
reject or rewrite execution arguments. Diagnostic detection requires explicit
|
|
credential fields/assignments or recognizable key, Bearer, JWT, or PEM formats,
|
|
not ordinary prose such as "credential handling" or dotted filenames.
|
|
|
|
Human question tools accept one complete `payload.questionSet` for text and
|
|
choice questions. The control plane generates legacy `questions` entries with
|
|
stable free-text option IDs. Legacy callers remain supported. Calls that supply
|
|
both forms must describe the same complete form; partial forms remain invalid.
|
|
The native recovery bridge uses the same projection for answer delivery.
|
|
|
|
The server validates canonical answer constraints before persistence. Regex
|
|
matching runs in isolated workers with a one-second deadline and at most four
|
|
active workers. A timeout or capacity error leaves the question pending. The
|
|
ordinary and native answer paths both await this validation before persistence.
|
|
Saved native answer delivery does not repeat regex matching.
|
|
|
|
Validated ACPX runtime events normalize into the same provider-neutral activity
|
|
families as the direct Codex transport. Reasoning contents stay private. Tool
|
|
targets are resolved within the workspace under the provider host's path
|
|
semantics and receive a versioned sidecar boundary marker before becoming
|
|
bounded, display-only PRP safe paths. Raw or unmarked provider locations fail
|
|
closed. URI-scheme and Windows drive-shaped values require a separate sidecar
|
|
attestation backed by an existing in-workspace entry or, for a not-yet-created
|
|
edit target, an existing in-workspace parent. This preserves real POSIX colon
|
|
filenames without treating arbitrary URI text as a path. Windows separators
|
|
are canonicalized, and consumers must not reinterpret the display value as
|
|
file-access authority. Operational semantic-result and terminal events remain
|
|
reserved for the stateful adapter rather than being duplicated.
|
|
|
|
The ACPX provider reducer preserves that order while it tracks one
|
|
active turn, bounded assistant text, semantic results, and pending tool or input
|
|
correlations. Terminal events flush the final assistant message first and clear
|
|
unresolved turn-scoped requests.
|
|
|
|
The package-local session bootstrap starts the bounded sidecar transport,
|
|
verifies the qualified capability handshake and effective model, opens one
|
|
identity-bound session, and confirms its run attachment. Any failed bootstrap
|
|
terminates the process; session shutdown preserves persistent provider state.
|
|
The session can then start one immutable-workspace turn, request interruption,
|
|
and reduce polled events through the scope-first state boundary. A mismatched
|
|
command acknowledgement or invalid event terminates the session fail closed.
|
|
Polled semantic calls pass through the run-scoped authorized tool bridge before
|
|
they can be returned to a caller. Before a follow-up turn releases settled tool
|
|
receipts, runner-core suspends and reaps the idle sidecar/provider generation,
|
|
then resumes the same verified persistent identity in a fresh generation. This
|
|
prevents a late session-lifetime MCP callback from inheriting the next turn's
|
|
event authority.
|
|
|
|
The Rust question-response validator checks the versioned response envelope
|
|
against the exact persisted question IDs, answer modes, options, required
|
|
answers, custom-answer policy, and text constraints before provider delivery.
|
|
Tool results and structured question responses then use two-phase resolution:
|
|
validate retained identity and schema, require the exact sidecar
|
|
acknowledgement, and only then clear pending local state. Codex permission
|
|
requests violate its pinned sidecar policy and terminate the session fail
|
|
closed.
|
|
Safe suspension is available only with no active turn or pending request. The
|
|
sidecar must return the exact persistent session identity before runnerd
|
|
terminates the local process.
|
|
Already validated ACPX reducer events project into provider-neutral durable
|
|
events only with an exact run, session, turn, and item binding. Raw sidecar
|
|
envelopes and permission requests are not admitted at this boundary.
|
|
A safely suspended session can be recorded as a bounded private checkpoint.
|
|
The checkpoint binds the exact provider identity, run, catalog revision, and
|
|
catalog digest and is replaced atomically before a later recovery attempt.
|
|
Recovery releases the stored identity only after those bindings match the
|
|
prospective session configuration exactly.
|
|
|
|
Run the complete contract gate with:
|
|
|
|
```sh
|
|
pnpm install --filter @paperclipai/paperclip-runner --lockfile=false --offline --ignore-scripts --dev
|
|
pnpm --filter @paperclipai/paperclip-runner verify
|
|
```
|
|
|
|
The verification command requires a stable Rust toolchain with `cargo` on
|
|
`PATH`, in addition to Node.js 24.11+ and pnpm 9+.
|
|
|
|
Minimal Debian/Ubuntu hosts without root access can extract the required
|
|
Playwright browser libraries into a user-owned cache and run the same acceptance
|
|
sequence with:
|
|
|
|
```sh
|
|
pnpm --filter @paperclipai/paperclip-runner verify:rootless
|
|
```
|
|
|
|
The tracer's final line is stable:
|
|
|
|
```json
|
|
{
|
|
"schemaVersion": "paperclip.runner.conformance.output.v1",
|
|
"runIdentity": {
|
|
"runId": "run_conformance_0001",
|
|
"sessionId": "session_conformance_0001"
|
|
},
|
|
"result": {
|
|
"status": "succeeded",
|
|
"summary": "Standalone Conformance fixture accepted."
|
|
}
|
|
}
|
|
```
|
|
|
|
Run only the tracer with:
|
|
|
|
```sh
|
|
pnpm --filter @paperclipai/paperclip-runner trace:conformance
|
|
```
|
|
|
|
Replay the Replay happy path, run a Local session, or open the browser
|
|
devtool:
|
|
|
|
```sh
|
|
pnpm --filter @paperclipai/paperclip-runner replay:fixture
|
|
pnpm --filter @paperclipai/paperclip-runner trace:local-runner -- --scenario happy-path
|
|
pnpm --filter @paperclipai/paperclip-runner trace:codex
|
|
pnpm --filter @paperclipai/paperclip-runner demo:live-console -- --host 127.0.0.1 --port 4174
|
|
|
|
# Live console: chat with a live session in the browser.
|
|
pnpm --filter @paperclipai/paperclip-runner console:live-console
|
|
pnpm --filter @paperclipai/paperclip-runner browser:dev --host 127.0.0.1 --port 4179
|
|
|
|
# SDK: open the public-SDK reference console and mini consumer.
|
|
pnpm --filter @paperclipai/paperclip-runner console:sdk
|
|
|
|
# Standalone: run the standalone legacy/native/kill-switch tracer and page.
|
|
pnpm --filter @paperclipai/paperclip-runner trace:standalone
|
|
pnpm --filter @paperclipai/paperclip-runner trace:standalone -- --feature-flag enabled
|
|
pnpm --filter @paperclipai/paperclip-runner trace:standalone -- --feature-flag enabled --kill-switch enabled
|
|
pnpm --filter @paperclipai/paperclip-runner demo:standalone
|
|
|
|
```
|
|
|
|
Live console provider-backed routes are loopback-only and reject wildcard/LAN
|
|
binds. Browser mutations require same-origin Fetch Metadata, matching Origin,
|
|
and JSON content; see the protocol-server tutorial for direct `curl` examples.
|
|
|
|
## Direct live protocol qualification
|
|
|
|
The canonical direct live protocol suite lives in the separate
|
|
`paperclip-evals` repository under `evals/paperclip-runner/`. Its
|
|
`live-mini.json` roster is the complete 35-case Codex qualification lane. Build
|
|
this package's TypeScript output, release `paperclip-runnerd`, package tarball,
|
|
and `dist-issue-thread` viewer, then use the roster runner documented in that
|
|
repository. The package ships the required orchestration entry point as
|
|
`paperclip-runner-eval-session` (`dist/cli/eval-session.js`). Evalbook owns the
|
|
consistent HTML matrix and read-only attempt drill-down pages.
|
|
|
|
The hosted full-campaign workflow, parallel matrix, credential boundaries,
|
|
canonical report merge, and versioned S3 index are documented in
|
|
[`docs/runner-protocol-live-evals.md`](docs/runner-protocol-live-evals.md).
|
|
|
|
This direct protocol qualification is separate from the stress-derived Runner
|
|
workflow schedule below and from the full-stack browser model E2E suite.
|
|
|
|
## Stress-derived workflow, chaos, and AWS AgentCore operations
|
|
|
|
The deterministic workflow scorer and the chaos schedule do not require
|
|
provider credentials:
|
|
|
|
```sh
|
|
pnpm --filter @paperclipai/paperclip-runner test:runner-workflow-evals
|
|
pnpm --filter @paperclipai/paperclip-runner report:runner-chaos-evals
|
|
```
|
|
|
|
`report:runner-live-evals` is a paid, provider-backed command. Native Codex
|
|
requires `OPENAI_API_KEY`; ACPX Claude requires
|
|
`ANTHROPIC_API_KEY`; OpenCode candidates require `OPENROUTER_API_KEY`. The live
|
|
matrix remains qualified-only and does not persist credential values. Candidate
|
|
qualification uses `eval-session --candidate-profile <pi|cursor|copilot>` with an
|
|
explicit model and a separately materialized pinned candidate pack. This option
|
|
is a constructor-bound diagnostic opt-in; session JSON cannot enable a candidate.
|
|
Missing credentials or unverifiable spend block paid qualification. Set
|
|
`PAPERCLIP_EVAL_MAX_CAMPAIGN_COST_USD` to a positive finite number to bound
|
|
additional scheduling after the observed campaign total reaches that value:
|
|
|
|
```sh
|
|
PAPERCLIP_EVAL_MAX_CAMPAIGN_COST_USD=12 \
|
|
PAPERCLIP_EVALS_ROOT=/path/to/paperclip-evals \
|
|
pnpm --filter @paperclipai/paperclip-runner report:runner-live-evals
|
|
|
|
# Run two scheduled native Codex executions only.
|
|
PAPERCLIP_EVALS_ROOT=/path/to/paperclip-evals \
|
|
pnpm --filter @paperclipai/paperclip-runner report:runner-live-evals -- \
|
|
--candidate codex-luna --limit 2
|
|
```
|
|
|
|
GitHub-hosted live campaigns additionally require the default branch, an
|
|
allowlisted numeric actor ID, the protected `runner-e2e-paid` environment, and
|
|
an explicit repository variable before scheduled runs are enabled. Manual
|
|
dispatches accept the same candidate, case, and execution-limit selectors. The
|
|
paid job uses the reviewed RunsOn Fleet label when `RUNNER_E2E_AWS_ENABLED=true`
|
|
and otherwise stays on `ubuntu-latest`. Uploaded reports contain redacted
|
|
observations and trace digests, not raw provider
|
|
frames, prompts, credentials, tool arguments, or hidden reasoning.
|
|
|
|
The AgentCore proof-of-concept uses an AWS CLI v2 profile to provision a
|
|
dedicated invocation role and scoped resources. Its local mode-`0600` metadata
|
|
file contains no access keys; probes assume short-lived STS credentials and
|
|
clear them after use. Validate locally, provision or inspect the stack, run the
|
|
bounded lab/smoke, and tear it down explicitly with:
|
|
|
|
```sh
|
|
pnpm --filter @paperclipai/paperclip-runner test:aws-agentcore-provisioning
|
|
pnpm --filter @paperclipai/paperclip-runner aws-agentcore:provision -- --dry-run
|
|
pnpm --filter @paperclipai/paperclip-runner aws-agentcore:provision
|
|
pnpm --filter @paperclipai/paperclip-runner aws-agentcore:probe
|
|
pnpm --filter @paperclipai/paperclip-runner aws-agentcore:lab
|
|
pnpm --filter @paperclipai/paperclip-runner smoke:capability:aws-agentcore
|
|
pnpm --filter @paperclipai/paperclip-runner aws-agentcore:destroy -- --yes
|
|
```
|
|
|
|
To admit the hosted direct-eval workflow, provision with the account-local
|
|
GitHub Actions OIDC provider and keep the default exact repository and protected
|
|
environment binding:
|
|
|
|
```sh
|
|
pnpm --filter @paperclipai/paperclip-runner aws-agentcore:provision -- \
|
|
--aws-profile paperclip-dev \
|
|
--github-oidc-provider-arn arn:aws:iam::<account-id>:oidc-provider/token.actions.githubusercontent.com
|
|
```
|
|
|
|
This adds only `repo:paperclipai/paperclip:environment:runner-e2e-paid` as a
|
|
web-identity subject on the scoped invocation role. The generated nonsecret
|
|
profile records that role as both the local invocation role and the hosted
|
|
execution role.
|
|
|
|
Provisioning can incur Bedrock, AgentCore Runtime/Memory, storage, and private
|
|
networking charges. Provisioning refuses to modify a colliding stack unless its
|
|
Paperclip ownership tags and template description match. A verified
|
|
`ROLLBACK_COMPLETE` stack still requires `--replace-failed-stack` plus an
|
|
interactive confirmation (or `--yes`) before it can be deleted and recreated.
|
|
Destruction requires `--yes` and refuses to remove a stack with an active
|
|
recorded lab unless `--force` is also supplied.
|
|
|
|
## Package-owned commands
|
|
|
|
| Command | Purpose |
|
|
| ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `build` | Compile the TypeScript public surface, Rust workspace, and browser devtool. |
|
|
| `typecheck` | Check TypeScript, Rust, generated schema sources, and browser types. |
|
|
| `test` | Run Rust/TypeScript fixture, supervisor, fake-driver, live/replay, and boundary tests. |
|
|
| `check:forbidden-imports` | Reject TypeScript imports and Cargo path dependencies that cross into Paperclip core. |
|
|
| `check:tracked-imports` | Reject tracked imports and `package.json` entry points that only resolve against untracked files, so a clean checkout of any commit builds. |
|
|
| `check:numbered-milestones` | Reject numbered construction-milestone names in tracked package paths and source. |
|
|
| `check:package-boundaries` | Enforce the acyclic runtime/testing/eval dependency and manifest boundary. |
|
|
| `check:clean-consumers` | Pack the runner and install its root, evals, and testing exports in a clean consumer. |
|
|
| `test:eval-slice` | Run the credential-free eval bundle, scoring, and behavior/fault slice. |
|
|
| `test:runner-workflow-evals` | Run the deterministic provider-neutral workflow matrix. |
|
|
| `report:runner-workflow-evals` | Validate deterministic fail-closed results and write JSON, Markdown, JUnit, and GitHub-safe reports. |
|
|
| `report:runner-live-evals` | Execute the paid provider schedule and render its immutable attempts with the canonical `paperclip-evals` HTML grid. |
|
|
| `report:runner-chaos-evals` | Write the credential-free eight-scenario chaos schedule. |
|
|
| `test:aws-agentcore-provisioning` | Validate the AgentCore template and wrapper safety contracts without provisioning. |
|
|
| `aws-agentcore:provision` / `probe` / `lab` / `destroy` | Manage the scoped AgentCore proof-of-concept lifecycle. |
|
|
| `smoke:capability:aws-agentcore` | Exercise the qualified AgentCore profile through the capability harness. |
|
|
| `check:conformance-parity` | Require byte-for-byte equivalent Rust and TypeScript tracer output. |
|
|
| `check:replay-goldens` | Require all reducer snapshots and cross-language summaries to match checked goldens. |
|
|
| `check:replay-parity` | Run TypeScript and Rust against the same Replay fixture summaries. |
|
|
| `check:browser-tokens` | Reject component-local visual literals and require the standalone token layer. |
|
|
| `docs:validate` | Validate local documentation links. |
|
|
| `trace:conformance` | Run the Rust mock-core tracer, print the stable result, and exit. |
|
|
| `trace:conformance:typescript` | Run the TypeScript reference tracer directly. |
|
|
| `replay:fixture` | Validate and reduce a fixture to a final snapshot. |
|
|
| `trace:local-runner` | Run one native local session through the Rust runner and fake harness. |
|
|
| `trace:codex` | Run the mock core with a real, local skillless Codex app-server session. |
|
|
| `demo:live-console` | Start the package-local HTTP/SSE server with server-only Codex authentication. |
|
|
| `console:live-console` | Start the standalone browser devtool with the Live console on `127.0.0.1:4180`. |
|
|
| `console:sdk` | Start the public-SDK reference console and mini consumer on `127.0.0.1:4181`. |
|
|
| `test:sdk` | Run targeted browser-client, reducer-projection, and React component contract tests. |
|
|
| `test:browser:sdk` | Exercise both consumers with the fake driver, keyboard/a11y checks, reconnect/replay, measurements, and screenshots. |
|
|
| `record:sdk:codex` | Run both public consumers against a safe real Codex session and capture live screenshots. |
|
|
| `check:capability-contract` | Verify the generated capability, legacy MCP, and eval traceability contract. |
|
|
| `check:semantic-contracts` | Verify the provider-neutral semantic tool contract is current. |
|
|
| `trace:live-runner` | Run the real runnerd/Codex semantic loop against the mock control plane. |
|
|
| `demo:scenarios` | Start the Capability scenario explorer over the mock control plane on `127.0.0.1:4183`. |
|
|
| `console:issue-thread` | Start the Paperclip-style issue thread on `127.0.0.1:4184`. |
|
|
| `test:scenarios` | Run the scenario index, run-artifact, parity, explorer component, and route tests. |
|
|
| `test:browser:scenarios` | Exercise both the scenario explorer and issue-thread browser contracts. |
|
|
| `browser:dev` | Start the standalone live/replay browser devtool. |
|
|
| `test:browser` | Exercise static replay and live scenarios, then capture temporary screenshots under ignored test output. |
|
|
| `verify` | Run the complete deterministic Conformance through SDK acceptance sequence. |
|
|
| `verify:rootless` | Extract Debian/Ubuntu browser libraries without root, then run `verify`. |
|
|
|
|
## Navigate
|
|
|
|
- [Architecture and dependency boundary](docs/architecture.md)
|
|
- [ADR 0001: runner and testing package boundaries](docs/adr/0001-runner-testing-eval-package-boundaries.md)
|
|
- [Tutorial index](docs/index.md)
|
|
- [Conformance hand-run tutorial](docs/tutorials/conformance-standalone-tracer.md)
|
|
- [Replay hand-run tutorial](docs/tutorials/replay.md)
|
|
- [Local runner hand-run tutorial](docs/tutorials/local-runner.md)
|
|
- [Local protocol reference](docs/local-runner.md)
|
|
- [Durable transport reference](docs/durable-recovery.md)
|
|
- [Codex skillless Codex tutorial](docs/tutorials/codex.md)
|
|
- [Codex skillless Codex driver reference](docs/codex-driver.md)
|
|
- [Live console protocol/server tutorial](docs/tutorials/live-console-protocol-server.md)
|
|
- [Live console protocol/server reference](docs/live-console-protocol-server.md)
|
|
- [Live console tutorial](docs/tutorials/live-console.md)
|
|
- [Live console reference](docs/live-console.md)
|
|
- [SDK console tutorial](docs/tutorials/sdk-console.md)
|
|
- [SDK browser SDK reference](docs/sdk.md)
|
|
- [SDK component decision record](docs/design/sdk-component-decisions.md)
|
|
- [Capability semantic catalog and authorization](docs/capability-semantic-catalog.md)
|
|
- [Capability live runnerd/Codex loop](docs/capability-live-runnerd-codex.md)
|
|
- [Capability issue-thread UI](docs/capability-issue-thread-ui.md)
|
|
- [PRP compatibility/versioning policy](docs/protocol-compatibility.md)
|
|
- [Adding a harness and permission-mode requirements](docs/adding-a-harness.md)
|
|
- [PRP v1 expressiveness audit](spec/prp-v1-expressiveness-audit.md)
|
|
- [Cumulative end-to-end tutorial](docs/tutorials/end-to-end.md)
|
|
|
|
Codex adds the package-local real-model reference driver, Live console adds the
|
|
package-local browser console, and SDK extracts a reusable public SDK plus
|
|
two standalone consumers. Runtime production Paperclip integration remains
|
|
deferred; the App-owned production conformance adapter is test-only.
|
|
|
|
The SDK reference console opens in direct chat mode. Enter a normal prompt,
|
|
then open the protocol inspector to review events and reducer state. Expand a
|
|
Terminal row and its nested **Debug details** disclosure to inspect every
|
|
canonical event retained for that command. The header marker `🖇️ v0.1.2`
|
|
identifies the current console iteration.
|
|
|
|
`create_task` accepts an optional initial `status` of `backlog` or `todo`. Use `backlog` when the user wants a saved task or plan without execution: assignment and the initial plan are committed without scheduling a wake, even when dependencies are already complete. Omitting status preserves immediate delegation (`todo`, or `blocked` for unresolved dependencies).
|
|
|
|
|
|
Linux provider-pack producers run on the corresponding native Linux target and
|
|
retain `provider-pack.json` with a relocatable `provider-pack.tar.gz`. Release
|
|
assembly binds both identities to the same source as its four daemons. The
|
|
historical `remoteProviderPack` field remains the Linux x64 identity. Linux
|
|
ARM64 packs do not qualify Pi, Cursor or Copilot on that target.
|
|
|
|
For an installed SSH host, install the same release producer's pack at
|
|
`$HOME/.local/share/paperclip-runner/provider-pack` or
|
|
`/opt/paperclip-runner/provider-pack`. A Mac controller selects its packaged
|
|
Linux target identity after probing the selected host. The runtime verifies the
|
|
installed pack before prompting. No development pack override is needed. A
|
|
missing or mismatched pack fails clearly. Existing explicit overrides remain
|
|
authoritative. ARM64 cloud-image production remains deferred.
|
|
|
|
### Oversized OpenCode events
|
|
|
|
The OpenCode driver keeps SSE frames up to 1,048,576 characters exact. It compacts longer
|
|
frames while retaining tool identity, status, and bounded output excerpts. This
|
|
also applies when a complete large frame arrives inside one network chunk.
|
|
Canonical tool rows mark shortened output, report its original byte count, and
|
|
do not claim a digest for text that was not retained. A structure that cannot
|
|
fit the compacted bound produces a diagnostic; the event stream continues.
|
|
|
|
Tool output and error fields have reserved retention space and size records,
|
|
so large input values cannot consume their output tails or make excerpts look
|
|
complete. A separator split between reads does not count against the frame limit.
|
|
## Preconfigured home
|
|
|
|
Set `homeMode: "preconfigured"` in a `paperclip_runner` agent's adapter config
|
|
(or the runnerd transport options) to use the execution account's existing home.
|
|
The default is `"isolated"`. The initial supported providers are native Codex
|
|
and ACPX Claude. Preconfigured ACPX Codex fails before launch until its session
|
|
permissions can enforce denial of Runner state; use native Codex or isolated mode.
|
|
An operator must select this mode on the agent/Runner
|
|
configuration. Task-level overrides are rejected, and agent credentials cannot
|
|
set or inherit this option. Other providers reject this option. The internal ACPX task bridge uses a stable
|
|
session name so an existing user MCP server named `paperclip` remains available.
|
|
|
|
Prepare authentication, skills, and external MCP servers on the execution machine
|
|
before launching. Runner does not install skills, copy or remove credentials, or
|
|
rewrite user configuration in this mode. Providers can still refresh credentials
|
|
and update their own metadata. Runner still supplies the requested
|
|
model, task instructions, and its internal task/completion tools. Local permission
|
|
rules and hooks apply. Native Codex tools can read and modify the execution home
|
|
(read-only for planning); credentials in that home are not isolated from tools.
|
|
Native Codex separately denies Runner-owned protocol state; ACPX Claude retains
|
|
its existing provider trust boundary. Execution is unattended: native Codex uses `never`, and
|
|
ACPX rejects requests for approval. The initial ACPX mode requires the Runner
|
|
setting `acpxPermissionMode: "approve-all"` (its default); other Runner modes are
|
|
unqualified here and fail before launch. Local permission rules still apply.
|
|
Preconfigured ACPX read-only/planning tasks also fail before provider launch
|
|
until a read-only launch is qualified; use isolated mode or native Codex for planning.
|
|
If local settings block a task, change them
|
|
and retry. Existing blocked results and failure diagnostics report the outcome;
|
|
a hook that also blocks the reporting tool can leave only a generic diagnostic.
|
|
|
|
Runner retains private protocol/session state and a fence for each session.
|
|
Different sessions may share the same home. Mode and home bindings fence recovery;
|
|
switching either requires a new session. Backups never include the external home.
|
|
Recovering a run uses its saved mode even if the agent configuration has changed.
|
|
Remote execution discovers the execution account's home on the remote machine
|
|
using `getent`; it does not copy the controller's HOME, XDG paths, or login state.
|
|
The external provider history must still exist to resume a session after a remote
|
|
machine is replaced. Missing history fails recovery rather than importing an
|
|
isolated home. OpenCode and the remaining ACPX profiles require separate
|
|
qualification before this mode can be enabled for them.
|
|
|
|
## Assigned local MCP servers
|
|
|
|
An execution host can assign local stdio MCP servers alongside the existing
|
|
`PAPERCLIP_NATIVE_MCP_NAME` / `URL` / `TOKEN` HTTP gateway. This is general transport
|
|
support for local MCP implementations that satisfy the executable-verification
|
|
and private Unix socket requirements below. Runner uses each server's own tool
|
|
schemas and responses. Set
|
|
`PAPERCLIP_NATIVE_MCP_STDIO` to a JSON array of bindings with these fields:
|
|
|
|
```json
|
|
[{"name":"local_tools","command":"/opt/local-tools/bin/mcp-server","args":[],"env":{"HOME":"/home/agent"},"sha256":"sha256:<64 lowercase hex digits>","serialResource":"/home/agent/.local/state/local-tools/runtime/service.sock"}]
|
|
```
|
|
|
|
`serialResource` identifies the shared resource for cross-process call locking;
|
|
the MCP transport itself uses stdio. It must name an existing private Unix socket
|
|
with the ownership and path requirements below.
|
|
|
|
Set `PAPERCLIP_NATIVE_MCP_PROXY` to the assigned Runner executable. These are
|
|
execution-host inputs, excluded from configurable task environment and provider
|
|
shell inheritance. Names use letters, digits, underscores or hyphens and cannot
|
|
replace the internal task server or gateway. Commands are verified against their
|
|
assigned digest before execution. The backend receives only its assigned environment.
|
|
|
|
Runner supplies these session-local bindings to native Codex and through the
|
|
shared ACPX runtime. ACPX clients must support stdio MCP assignments.
|
|
User or project MCP files are never rewritten. Read-only sessions omit these
|
|
bindings. Host assignment authorizes native Codex to use these local tools without
|
|
a new per-call prompt, matching execution-host utilities available through shell.
|
|
ACPX adapters use the existing ACPX permission policy. Explicit native Codex tool
|
|
deny/prompt rules remain effective; requested approvals use the existing PRP
|
|
permission request, bound to the active thread and turn. Only one-time accept, decline or cancel
|
|
decisions are accepted. Shell escalation stays disabled.
|
|
Preconfigured Claude remains unattended and rejects approval requests.
|
|
|
|
The relay forwards tool schemas and native MCP content. For native Codex
|
|
0.160/0.162, image-bearing results put structured metadata in a text block instead of
|
|
`structuredContent`, because those clients otherwise discard the image blocks.
|
|
ACPX adapters receive the original response unchanged. Tool schemas and actions
|
|
are forwarded without provider-specific translation.
|
|
|
|
Provider-client smoke tests exercised native Codex 0.160.0 and Claude SDK
|
|
0.3.286 with local MCP servers and loopback model APIs. This records the clients
|
|
used to verify image delivery and approvals; it is not an exhaustive adapter
|
|
compatibility test.
|
|
|
|
All `tools/call` requests for the same private Unix socket are serialized across
|
|
sessions and processes, including reads. Metadata requests stay responsive.
|
|
Cancelling a queued request prevents dispatch. An active request retains its fence
|
|
until the backend acknowledges it; client cancellation cannot prove daemon work
|
|
stopped. If a relay exits with an unacknowledged call, later calls fail closed until
|
|
the host restarts that resource with a new socket. Do not remove its lock marker
|
|
while daemon work might still be running. The socket and its parent must be private,
|
|
canonical paths owned by the same account. Local stdio assignment requires Unix;
|
|
other platforms retain the HTTP path.
|