## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - The runner package already provides the production protocol and execution spine. > - Contributors still need stable SDK surfaces, deterministic test tools, and local inspection tools. > - Those surfaces share generated contracts and must change as one package boundary. > - This pull request adds the package-local SDK, labs, examples, and drift checks. > - The benefit is a reviewable developer platform that does not change application execution selection. ## Linked Issues or Issue Description **Subsystem affected** `packages/paperclip-runner` — runner SDK, conformance tools, and developer tooling. **Problem or motivation** The production runner spine is present, but package consumers cannot build deterministic integrations, inspect sessions, or verify provider-neutral behavior through supported surfaces. **Proposed solution** Add browser, React, standalone, live-session, scenario, conformance, and evaluation surfaces. Add generated contract inventories and package-local verification scripts. Keep production application routing unchanged. **Alternatives considered** We considered splitting each generated catalog, SDK surface, and demo into separate pull requests. Those changes share exports, fixtures, and drift gates. Splitting them would create intermediate package states that do not build. **Roadmap alignment** No overlapping item appears in `ROADMAP.md`. This work extends the runner package that is already on `master`. ## What Changed - Add browser, React, standalone, live-session, and issue-thread SDK surfaces. - Add deterministic mock control-plane, scenario, conformance, replay, and evaluation tools. - Add bounded Codex, OpenCode, and ACPX development transports and fixtures. - Keep deferred managed-provider execution fail-closed. Persisted compatibility data remains readable. - Add generated capability inventories with their source files and drift checks. - Add examples, package documentation, browser checks, and clean-consumer checks. - Preserve the reviewed protocol bounds, replay compatibility aliases, process environment isolation, and semantic redaction limits. - Update the ACPX package patch that the existing workspace patch registry already tracks. - Do not change `pnpm-lock.yaml`, repository workflows, server runtime selection, or the application UI. ## Verification GitHub Actions is the verification authority for this pull request. The repository CI, package TypeScript and Rust checks, package tests, generated-output drift checks, browser checks, security scans, and Greptile review must pass on the exact head. Local test suites were not run because this series uses parallel GitHub Actions for verification. ## Risks This is a large greenfield package change. The main risks are public export drift, generated-output drift, and optional React consumer compatibility. Package boundary checks, clean-consumer checks, and browser tests cover those risks. Production adapter selection and server execution are outside this pull request. ## Stack 1. **This PR:** runner SDK and developer tooling. 2. [Codex production server integration](https://github.com/paperclipai/paperclip/pull/12616). 3. [Provider-neutral task-thread UI](https://github.com/paperclipai/paperclip/pull/12617). ## Model Used OpenAI Codex, GPT-5, high-reasoning mode, with tool use and code execution. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have described the issue in-PR following the feature request template - [x] I have not referenced internal/instance-local Paperclip issues or links - [x] My branch name describes the change and contains no internal Paperclip ticket id - [ ] 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 risks above - [ ] All Paperclip CI gates are green - [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge
2.9 KiB
Capability semantic catalog and authorization
Capability adds a transport-neutral tool boundary over the deterministic mock
ControlPlanePort. It does not contain Paperclip REST routes, authentication
headers, credentials, ACPX code, or a real control-plane binding.
Public boundary
Import the catalog, policy, dispatcher, and binding helpers from the package root:
import {
CapabilitySemanticDispatcher,
createCapabilityProviderNeutralBinding,
} from "@paperclipai/paperclip-runner";
const dispatcher = new CapabilitySemanticDispatcher(mockPort, {
scenario: {
id: "dependency-manager",
claims: ["dependencies:write"],
},
explicitClaims: ["dependencies:write"],
});
const exposed = dispatcher.listTools(runId);
const result = await dispatcher.dispatch({
runId,
callId: "tool-call-1",
operationId: "set_dependencies",
input: {
idempotencyKey: "dependency-change-1",
blockedByTaskIds: ["task-2"],
},
});
createCapabilityProviderNeutralBinding("fake") and
createCapabilityProviderNeutralBinding("live_codex") return identical contract
arrays. Only the binding label differs. Track 7E can translate those definitions
to Codex tool definitions and pass calls to the dispatcher without changing
operation IDs, schemas, claims, or result shapes.
Authorization order
Exposure and invocation both evaluate the actor, active-task ownership and mode, scenario allow/deny rules, role restrictions, run claims, and explicit claims. Optional operations require their descriptor claim to be present in the intersection authorized for the run. The dispatcher repeats the evaluation immediately before every mock read or command; a tool that was exposed earlier can still be denied after a claim or ownership change.
Unauthorized optional tools are absent from listTools. Direct calls receive a
paperclip.semantic-denial.v1 result. The mock command boundary independently
checks command claims and task ownership, so bypassing catalog exposure does not
bypass authorization.
The generic API escape hatch is an optional skill_test descriptor and is
disabled by default. When a scenario and explicit claim enable it, only two
read-only package-local paths are accepted: /mock/state/revision and
/mock/task.
Protected data
Tool schemas contain no credential fields. Inputs containing protected keys or credential-shaped values are rejected before mutation. Read results, denials, and immutable semantic authorization records pass through the same recursive redactor. Mock actor discovery also omits capability and budget internals.
Generate and verify the checked-in contracts with:
pnpm --dir packages/paperclip-runner generate:semantic-contracts
pnpm --dir packages/paperclip-runner check:semantic-contracts
The generated contract is
generated/capability/semantic-tool-contracts.json. Capability traceability remains
under generated/capability/ and is checked with check:capability-contract.