forked from farhoodlabs/paperclip
534aee66ae
## Thinking Path
> - Paperclip orchestrates AI agents for zero-human companies
> - There are many adapter types, one per agent-runtime product (Claude,
Codex, OpenCode, Cursor local CLI, etc.)
> - Cursor shipped a public TypeScript SDK on 2026-04-29 that exposes
Cursor's full hosted-agent platform (cloud VMs, harness, MCP, skills,
hooks)
> - Paperclip had no first-class adapter for this — agents that wanted
to use Cursor's managed cloud runtime had to fall back to the local CLI
adapter, which loses the cloud session, streaming, and durable run model
> - This PR adds a new `cursor_cloud` adapter built directly on
`@cursor/sdk`, with Paperclip's heartbeat mapped to Cursor's
durable-agent + per-run model
> - The benefit is that any Paperclip agent can now drive a Cursor cloud
agent across heartbeats with native session reuse, streaming, and
cancellation, while Paperclip remains the source of truth for issue/task
state
## What Changed
- New built-in adapter package `packages/adapters/cursor-cloud` (15
files, ~1.7k LOC) backed by `@cursor/sdk` ^1.0.12
- `src/server/execute.ts` — SDK-first lifecycle: `Agent.create` /
`Agent.resume` / `Agent.getRun` / `agent.send` / `run.stream` /
`run.wait`, with session reuse keyed on the (runtime env type, env name,
repo set) tuple
- `src/server/session.ts` — codec for `cursorAgentId` + `latestRunId` +
repo metadata, persisted in `runtime.sessionParams`
- `src/server/test.ts` — environment probe via `Cursor.me()` and
optional model validation via `Cursor.models.list()`
- `src/ui/parse-stdout.ts` + `src/cli/format-event.ts` — normalize
Cursor SDK message types (`status`, `thinking`, `assistant`, `user`,
`tool_call`, `tool_result`, `result`) into Paperclip transcript events
for the UI and CLI
- Registrations: `packages/shared/src/constants.ts`,
`packages/adapter-utils/src/session-compaction.ts`,
`server/src/adapters/{registry,builtin-adapter-types}.ts`,
`ui/src/adapters/{registry,adapter-display-registry}.ts` +
`ui/src/adapters/cursor-cloud/index.ts`, `cli/src/adapters/registry.ts`,
plus workspace deps in `cli`/`server`/`ui` `package.json`
- `ui/src/components/AgentConfigForm.tsx` — hide local-Cursor
`mode`/thinking-effort field for `cursor_cloud` (different config
surface)
- 11 vitest tests covering execute paths (fresh create, matching-resume,
active-run reattach, non-finished result), session codec round-trip,
transcript parsing, and config building
## Verification
Reviewer steps:
```bash
pnpm install
pnpm --filter @paperclipai/adapter-cursor-cloud typecheck # → clean
pnpm vitest run packages/adapters/cursor-cloud # → 11/11 passing
```
End-to-end check against a real Cursor cloud agent (requires
`CURSOR_API_KEY` and Cursor GitHub-app install on the target repo):
1. Create a `cursor_cloud` agent in Paperclip with `repoUrl` set to the
test repo, `repoStartingRef: main`, and `env.CURSOR_API_KEY` set
2. Trigger a heartbeat → adapter calls `Agent.create({ cloud: { env: {
type: "cloud" }, repos: [...] } })`, streams events, terminates on
`finished`
3. Trigger a second heartbeat → adapter calls `Agent.resume` or
`agent.send` follow-up depending on prior-run state, reusing
`cursorAgentId`
4. The Paperclip UI/CLI transcript reflects Cursor `status` / `thinking`
/ `assistant` events as they stream
5. Cancellation from Paperclip maps to `run.cancel()` or Cloud API v1
`cancelRun` for cross-heartbeat cancellation
A direct-SDK smoke run against a real repo (devinfoley/my_test_project @
main) confirmed: `Cursor.me()` ok → `Agent.create` → `agent.send` →
`run.stream()` (30 events) → terminal status `finished` in ~11s.
## Risks
- **New adapter, additive only.** No existing adapter or registry is
replaced; current `cursor` local-CLI adapter is untouched. Default
behavior of any existing agent is unchanged.
- **External dependency on `@cursor/sdk`.** Cursor's SDK is v1.0.x and
may evolve. Mocked unit tests cover the public surface used here; if the
SDK breaks compatibility we update the adapter independently.
- **Cost/budget.** `cursor_cloud` runs on Cursor's billed cloud VMs;
operators must understand they are spending money outside Paperclip's
budget controls when they enable this adapter. Same shape as other
API-billed adapters.
- **No webhook support in V1.** The SDK already provides
stream/wait/cancel/reattach, so V1 does not require a public callback
URL. If a future use case needs out-of-band wakes, we add a Cloud API v1
webhook bridge as a separate change. This is called out in the issue
plan document.
- **Lockfile.** Per repo policy, `pnpm-lock.yaml` is intentionally not
in this PR — CI's lockfile workflow will update it on merge given the
manifest changes.
## Model Used
- Provider: Anthropic Claude (via Claude Code / Paperclip `claude_local`
adapter)
- Model: `claude-opus-4-7` (Claude Opus 4.7), knowledge cutoff January
2026
- Mode: standard tool-use with extended reasoning
- Context: ~200k token window
- Capabilities used: code generation, multi-file edits, shell/test
execution, GitHub PR workflow
## 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 run tests locally and they pass (11/11 in
`packages/adapters/cursor-cloud`)
- [x] I have added or updated tests where applicable (4 new test files,
11 cases)
- [ ] If this change affects the UI, I have included before/after
screenshots (the only UI change is hiding the local-Cursor mode field on
the `cursor_cloud` adapter — happy to attach a screenshot if the
reviewer wants one)
- [x] I have updated relevant documentation to reflect my changes (issue
plan document supersedes the pre-SDK design; tracked in PAPA-203)
- [x] I have considered and documented any risks above
- [x] I will address all Greptile and reviewer comments before
requesting merge
---------
Co-authored-by: Paperclip <noreply@paperclip.ing>
267 lines
9.8 KiB
TypeScript
267 lines
9.8 KiB
TypeScript
import type { UIAdapterModule } from "./types";
|
|
import { acpxLocalUIAdapter } from "./acpx-local";
|
|
import { claudeLocalUIAdapter } from "./claude-local";
|
|
import { codexLocalUIAdapter } from "./codex-local";
|
|
import { cursorCloudUIAdapter } from "./cursor-cloud";
|
|
import { cursorLocalUIAdapter } from "./cursor";
|
|
import { geminiLocalUIAdapter } from "./gemini-local";
|
|
import { openCodeLocalUIAdapter } from "./opencode-local";
|
|
import { piLocalUIAdapter } from "./pi-local";
|
|
import { openClawGatewayUIAdapter } from "./openclaw-gateway";
|
|
import { hermesLocalUIAdapter } from "./hermes-local";
|
|
import { processUIAdapter } from "./process";
|
|
import { httpUIAdapter } from "./http";
|
|
import { loadDynamicParser, invalidateDynamicParser, setDynamicParserResultNotifier } from "./dynamic-loader";
|
|
import { SchemaConfigFields, buildSchemaAdapterConfig } from "./schema-config-fields";
|
|
|
|
const uiAdapters: UIAdapterModule[] = [];
|
|
const adaptersByType = new Map<string, UIAdapterModule>();
|
|
|
|
// Types registered at module load time — allowed to be overridden by
|
|
// external adapters that ship their own ui-parser.js via the server.
|
|
const builtinTypes = new Set<string>();
|
|
|
|
// Original builtin adapters stored for restoration when external overrides
|
|
// are deactivated or removed.
|
|
const builtinAdaptersByType = new Map<string, UIAdapterModule>();
|
|
|
|
// Tracks which builtin types currently have an active external override.
|
|
const activeExternalOverrides = new Set<string>();
|
|
|
|
// Generation counter to discard stale dynamic parser loads. When an override
|
|
// is deactivated while a load is in-flight, the generation is bumped and the
|
|
// stale result is discarded in its .then() handler.
|
|
const overrideGeneration = new Map<string, number>();
|
|
|
|
// Subscriber list — components can register to be notified when adapters change
|
|
// (e.g., when a dynamic parser replaces a placeholder).
|
|
const adapterChangeListeners = new Set<() => void>();
|
|
|
|
/** Subscribe to adapter registry changes. Returns unsubscribe function. */
|
|
export function onAdapterChange(fn: () => void): () => void {
|
|
adapterChangeListeners.add(fn);
|
|
return () => adapterChangeListeners.delete(fn);
|
|
}
|
|
|
|
function notifyAdapterChange(): void {
|
|
for (const fn of adapterChangeListeners) fn();
|
|
}
|
|
|
|
setDynamicParserResultNotifier(notifyAdapterChange);
|
|
|
|
function registerBuiltInUIAdapters() {
|
|
for (const adapter of [
|
|
acpxLocalUIAdapter,
|
|
claudeLocalUIAdapter,
|
|
codexLocalUIAdapter,
|
|
cursorCloudUIAdapter,
|
|
geminiLocalUIAdapter,
|
|
hermesLocalUIAdapter,
|
|
openCodeLocalUIAdapter,
|
|
piLocalUIAdapter,
|
|
cursorLocalUIAdapter,
|
|
openClawGatewayUIAdapter,
|
|
processUIAdapter,
|
|
httpUIAdapter,
|
|
]) {
|
|
builtinTypes.add(adapter.type);
|
|
builtinAdaptersByType.set(adapter.type, adapter);
|
|
registerUIAdapter(adapter);
|
|
}
|
|
}
|
|
|
|
export function registerUIAdapter(adapter: UIAdapterModule): void {
|
|
const existingIndex = uiAdapters.findIndex((entry) => entry.type === adapter.type);
|
|
if (existingIndex >= 0) {
|
|
uiAdapters.splice(existingIndex, 1, adapter);
|
|
} else {
|
|
uiAdapters.push(adapter);
|
|
}
|
|
adaptersByType.set(adapter.type, adapter);
|
|
notifyAdapterChange();
|
|
}
|
|
|
|
export function unregisterUIAdapter(type: string): void {
|
|
if (type === processUIAdapter.type || type === httpUIAdapter.type) return;
|
|
const existingIndex = uiAdapters.findIndex((entry) => entry.type === type);
|
|
if (existingIndex >= 0) {
|
|
uiAdapters.splice(existingIndex, 1);
|
|
}
|
|
adaptersByType.delete(type);
|
|
}
|
|
|
|
export function findUIAdapter(type: string): UIAdapterModule | null {
|
|
return adaptersByType.get(type) ?? null;
|
|
}
|
|
|
|
registerBuiltInUIAdapters();
|
|
|
|
export function getUIAdapter(type: string): UIAdapterModule {
|
|
const builtIn = adaptersByType.get(type);
|
|
|
|
if (!builtIn) {
|
|
let loadStarted = false;
|
|
return {
|
|
type,
|
|
label: type,
|
|
parseStdoutLine: (line: string, ts: string) => {
|
|
if (!loadStarted) {
|
|
loadStarted = true;
|
|
loadDynamicParser(type).then((parserModule) => {
|
|
if (parserModule) {
|
|
registerUIAdapter({
|
|
type,
|
|
label: type,
|
|
parseStdoutLine: parserModule.parseStdoutLine,
|
|
createStdoutParser: parserModule.createStdoutParser,
|
|
ConfigFields: SchemaConfigFields,
|
|
buildAdapterConfig: buildSchemaAdapterConfig,
|
|
});
|
|
}
|
|
});
|
|
}
|
|
return processUIAdapter.parseStdoutLine(line, ts);
|
|
},
|
|
ConfigFields: SchemaConfigFields,
|
|
buildAdapterConfig: buildSchemaAdapterConfig,
|
|
};
|
|
}
|
|
|
|
return builtIn;
|
|
}
|
|
|
|
/**
|
|
* Keep the UI adapter registry in sync with the server's adapter list.
|
|
*
|
|
* Two concerns:
|
|
*
|
|
* 1. **Builtin overrides** — when an external adapter ships a ui-parser.js for a
|
|
* builtin type, the external parser takes priority. When the external is
|
|
* disabled or removed the original builtin parser is restored transparently.
|
|
* A generation counter guards against stale loads that resolve after the
|
|
* override has been torn down.
|
|
*
|
|
* 2. **Non-builtin externals** — register a bridge adapter that lazily loads the
|
|
* dynamic parser on first stdout line, falling back to the generic process
|
|
* adapter. Once the parser resolves the bridge is replaced.
|
|
*/
|
|
export function syncExternalAdapters(
|
|
serverAdapters: {
|
|
type: string;
|
|
label: string;
|
|
disabled?: boolean;
|
|
/** When true, the external override for a builtin type is client-side paused. */
|
|
overrideDisabled?: boolean;
|
|
}[],
|
|
): void {
|
|
const enabledExternalTypes = new Set(
|
|
serverAdapters.filter((a) => !a.disabled && !a.overrideDisabled).map((a) => a.type),
|
|
);
|
|
const allExternalTypes = new Set(
|
|
serverAdapters.map((a) => a.type),
|
|
);
|
|
|
|
// ── Builtin override lifecycle ──────────────────────────────────────────
|
|
|
|
for (const builtinType of builtinTypes) {
|
|
const originalBuiltin = builtinAdaptersByType.get(builtinType);
|
|
if (!originalBuiltin) continue;
|
|
|
|
const hasExternal = allExternalTypes.has(builtinType);
|
|
const externalEnabled = enabledExternalTypes.has(builtinType);
|
|
const wasOverridden = activeExternalOverrides.has(builtinType);
|
|
|
|
if (hasExternal && externalEnabled && !wasOverridden) {
|
|
// Activate: external just became active → replace builtin with bridge.
|
|
activeExternalOverrides.add(builtinType);
|
|
|
|
const gen = (overrideGeneration.get(builtinType) ?? 0) + 1;
|
|
overrideGeneration.set(builtinType, gen);
|
|
|
|
let loadStarted = false;
|
|
const fallbackParser = originalBuiltin.parseStdoutLine;
|
|
const externalEntry = serverAdapters.find((a) => a.type === builtinType);
|
|
const label = externalEntry?.label ?? builtinType;
|
|
|
|
registerUIAdapter({
|
|
type: builtinType,
|
|
label,
|
|
parseStdoutLine: (line: string, ts: string) => {
|
|
if (!loadStarted) {
|
|
loadStarted = true;
|
|
loadDynamicParser(builtinType).then((parserModule) => {
|
|
// Discard if the override was torn down while the load was in-flight.
|
|
if (parserModule && overrideGeneration.get(builtinType) === gen) {
|
|
registerUIAdapter({
|
|
type: builtinType,
|
|
label,
|
|
parseStdoutLine: parserModule.parseStdoutLine,
|
|
createStdoutParser: parserModule.createStdoutParser,
|
|
ConfigFields: originalBuiltin.ConfigFields,
|
|
buildAdapterConfig: originalBuiltin.buildAdapterConfig,
|
|
});
|
|
}
|
|
});
|
|
}
|
|
return fallbackParser(line, ts);
|
|
},
|
|
ConfigFields: originalBuiltin.ConfigFields,
|
|
buildAdapterConfig: originalBuiltin.buildAdapterConfig,
|
|
});
|
|
} else if ((!hasExternal || !externalEnabled) && wasOverridden) {
|
|
// Deactivate: external disabled or removed → restore builtin.
|
|
activeExternalOverrides.delete(builtinType);
|
|
overrideGeneration.delete(builtinType);
|
|
invalidateDynamicParser(builtinType);
|
|
registerUIAdapter(originalBuiltin);
|
|
}
|
|
}
|
|
|
|
// ── Non-builtin externals ───────────────────────────────────────────────
|
|
|
|
for (const { type, label } of serverAdapters) {
|
|
if (builtinTypes.has(type)) continue; // handled above
|
|
|
|
const existing = adaptersByType.get(type);
|
|
|
|
// If this type already has an externally-loaded dynamic parser, skip —
|
|
// it was loaded from disk on a previous sync. Only re-trigger loading
|
|
// when the server returns a new external adapter that hasn't been loaded yet.
|
|
if (existing && existing !== processUIAdapter) continue;
|
|
|
|
let loadStarted = false;
|
|
// Use the existing built-in parser as fallback (if any) so we don't
|
|
// regress to the generic process parser while the dynamic one loads.
|
|
const fallbackParser = existing?.parseStdoutLine ?? processUIAdapter.parseStdoutLine;
|
|
|
|
registerUIAdapter({
|
|
type,
|
|
label,
|
|
parseStdoutLine: (line: string, ts: string) => {
|
|
if (!loadStarted) {
|
|
loadStarted = true;
|
|
loadDynamicParser(type).then((parserModule) => {
|
|
if (parserModule) {
|
|
registerUIAdapter({
|
|
type,
|
|
label,
|
|
parseStdoutLine: parserModule.parseStdoutLine,
|
|
createStdoutParser: parserModule.createStdoutParser,
|
|
ConfigFields: existing?.ConfigFields ?? SchemaConfigFields,
|
|
buildAdapterConfig: existing?.buildAdapterConfig ?? buildSchemaAdapterConfig,
|
|
});
|
|
}
|
|
});
|
|
}
|
|
return fallbackParser(line, ts);
|
|
},
|
|
ConfigFields: existing?.ConfigFields ?? SchemaConfigFields,
|
|
buildAdapterConfig: existing?.buildAdapterConfig ?? buildSchemaAdapterConfig,
|
|
});
|
|
}
|
|
}
|
|
|
|
export function listUIAdapters(): UIAdapterModule[] {
|
|
return [...uiAdapters];
|
|
}
|