mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-26 18:31:34 +01:00
Dotta
560e7e48b5
## 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
99 lines
4.3 KiB
Markdown
99 lines
4.3 KiB
Markdown
# Capability Semantic Tool Catalog
|
|
|
|
The semantic tool catalog is the transport-neutral surface an agent may call. It
|
|
is a frozen set of JSON-schema descriptors — no HTTP method, path, or provider
|
|
detail. Provider-specific shapes are produced only by *bindings*, so every
|
|
provider sees the same operation set.
|
|
|
|
Each protocol action is single-sourced in its own module under
|
|
`src/protocol-actions/`. That module owns the action's policy metadata,
|
|
documentation, examples, and its live and scenario JSON-schema presentations.
|
|
`src/catalog/canonical-operations.ts`, `src/semantic-tools/catalog.ts`, and
|
|
`src/tools/capability-semantic-tool-catalog.ts` are compatibility projections;
|
|
do not add action definitions to them. See
|
|
[catalog reconciliation](../spec/capability/catalog-reconciliation.md).
|
|
|
|
Sources: `src/protocol-actions/`, `src/catalog/canonical-operations.ts`,
|
|
`src/tools/capability-semantic-tool-catalog.ts`,
|
|
`src/tools/capability-semantic-tool-types.ts`, `src/tools/capability-tool-bindings.ts`,
|
|
barrel `src/tools/index.ts`.
|
|
|
|
## Two dispositions, plus a separate control-plane list
|
|
|
|
A tool descriptor's `disposition` is either **`always_agent_tool`** or
|
|
**`optional_agent_tool`**. Control-plane-owned operations are a separate frozen
|
|
list, not a disposition — they are never exposed as tools. See
|
|
[capability disposition](capability-disposition.md) and
|
|
[authorization and exposure](capability-authorization-and-exposure.md).
|
|
|
|
The catalog holds **37 tools**: 14 always-agent tools and 23 optional tools
|
|
across 10 groups.
|
|
|
|
<!-- These counts are drift-checked against src/tools/capability-semantic-tool-catalog.ts
|
|
by src/catalog/catalog-docs.test.ts; update the catalog, not the numbers. -->
|
|
|
|
### Always-agent tools (14)
|
|
|
|
`get_task_context`, `get_task_history`, `list_documents`, `read_document`,
|
|
`list_document_revisions`, `report_progress`, `answer_status_question`,
|
|
`finish_task`, `block_task`, `request_review`, `write_document`,
|
|
`request_human_input`, `register_deliverable`, `inspect_operation_result`.
|
|
|
|
### Optional tools (23), by group
|
|
|
|
| Group | Tools |
|
|
| --- | --- |
|
|
| discovery | `search_tasks`, `list_agents`, `list_projects`, `list_goals` |
|
|
| delegation_dependencies | `create_task`, `set_dependencies` |
|
|
| governance | `list_approvals`, `request_approval`, `decide_approval`, `comment_on_approval` |
|
|
| cases | `list_cases`, `upsert_case` |
|
|
| workspace_runtime | `get_workspace_runtime`, `control_workspace_service` |
|
|
| routines | `list_routines`, `manage_routine` |
|
|
| company_skills | `list_company_skills`, `sync_company_skills` |
|
|
| secrets | `list_secret_metadata`, `read_secret_value` |
|
|
| portability_admin | `export_company`, `administer_company` |
|
|
| test_escape_hatch | `generic_api_request` |
|
|
|
|
## Descriptor shape
|
|
|
|
Each descriptor carries `operationId`, `version` (1), `title`, `description`,
|
|
input/output JSON schemas, `disposition`, an optional `optionalGroup`,
|
|
`requiredClaims`, and optionally `allowedRoles`, `taskModes`, a `sideEffectClass`
|
|
(`read`, `task_write`, `company_write`, `governance`, `workspace_control`,
|
|
`secret_read`, `admin`, `test_escape_hatch`), an `idempotency` level, `redaction`
|
|
rules, and an abstract `mockCommandMapping`.
|
|
|
|
The `mockCommandMapping` is one of `context_read`, `snapshot_read`,
|
|
`semantic_command`, `operation_result`, or `mock_extension` — describing *what*
|
|
the tool does against the mock, never *how* a transport would carry it.
|
|
|
|
## Transport neutrality
|
|
|
|
Bindings, not descriptors, produce provider shapes, both derived from the same
|
|
`visibleTools.tools` array:
|
|
|
|
- `CapabilityFakeAgentToolBinding` emits `{operationId, description, inputSchema,
|
|
outputSchema}`.
|
|
- `CapabilityCodexToolBinding` emits `{type: "function", name, description, strict:
|
|
true, parameters}`.
|
|
|
|
Because both bindings derive from one array, the fake-agent and Codex operation
|
|
surfaces are byte-identical. The [conformance suite](capability-eval-conformance.md)
|
|
asserts this parity (the 18/18 fake-agent/Codex operation matrix).
|
|
|
|
## Running the tests
|
|
|
|
```sh
|
|
pnpm --filter @paperclipai/paperclip-runner exec vitest run \
|
|
src/tools/capability-semantic-tools.test.ts
|
|
```
|
|
|
|
The "catalog" describe asserts a unique, versioned, provider-neutral catalog and
|
|
that every optional group is present.
|
|
|
|
## Related
|
|
|
|
- [Authorization and exposure](capability-authorization-and-exposure.md)
|
|
- [Mock ControlPlanePort](capability-mock-control-plane-port.md)
|
|
- [Eval conformance](capability-eval-conformance.md)
|