0 Fork 0

mirror of https://github.com/paperclipai/paperclip.git synced 2026-10-08 21:03:51 +02:00

Files

T

Dotta 560e7e48b5 feat(runner): add SDK and developer tooling (#12608 )

## 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

2026-08-31 21:33:11 -05:00

2.5 KiB

Raw Permalink Blame History

Standalone Standalone Adapter Demo

This tutorial exercises the Standalone tracer entirely inside packages/paperclip-runner/. It does not install the runner into Paperclip, call a Paperclip API, change an instance flag, edit an agent profile, create a Paperclip task, or use the repository server/database integration.

1. Run the default legacy path

From the repository root:

pnpm --filter @paperclipai/paperclip-runner trace:standalone

The JSON trace must report:

resolvedMode: "legacy";
resolutionReason: "feature_flag_disabled";
nativeAdapterInvocationCount: 0;
legacyAdapterInvocationCount: 1;
complete replay, reducer, and finalization summaries.

2. Enable the native standalone path

pnpm --filter @paperclipai/paperclip-runner trace:standalone -- --feature-flag enabled

The trace must report resolvedMode: "native". Both paths execute the same public ControlPlanePort conformance suite and reduce the same canonical PRP events. The adapter label and invocation counters make the selected path inspectable.

3. Prove the kill switch

pnpm --filter @paperclipai/paperclip-runner trace:standalone -- --feature-flag enabled --kill-switch enabled

The trace must return to resolvedMode: "legacy" with resolutionReason: "kill_switch_enabled". No native adapter invocation is allowed after the kill switch resolves the path.

4. Open the standalone demo page

pnpm --filter @paperclipai/paperclip-runner demo:standalone

Open http://127.0.0.1:4182/standalone-demo/. The page starts on the legacy path. Toggle the native demo flag, inspect contract/reducer/finalization state, then enable the kill switch and confirm the page returns to legacy. Expand the trace JSON to inspect replay and idempotency details.

5. Run the package-local checks

pnpm --filter @paperclipai/paperclip-runner exec vitest run \
  src/standalone/standalone-demo.test.ts \
  src/conformance/control-plane-port.test.ts
pnpm --filter @paperclipai/paperclip-runner run build:standalone

These checks require no running Paperclip service or credentials.

Human checkpoint

Confirm the page defaults to legacy.
Enable the native demo flag and compare the contract and reducer panels.
Inspect the replay and finalization fields in the JSON trace.
Enable the kill switch and confirm native invocations return to zero.
Confirm no Paperclip instance or repository path outside packages/paperclip-runner/ was needed.

2.5 KiB Raw Permalink Blame History