@tduyng/pi-cursor 0.0.2 → 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +58 -68
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,105 +1,95 @@
1
- # pi-cursor
1
+ # @tduyng/pi-cursor
2
2
 
3
- Cursor models in Pi through the official Cursor SDK. Pi keeps its own system prompt, tools, approvals, compaction and session tree. Cursor is only the authenticated model transport.
3
+ Cursor models inside pi, through the official Cursor SDK. The SDK runs the agent loop, and everything above the transport stays pi's: system prompt, tools, approvals, compaction and session tree.
4
4
 
5
- No Cursor CLI is installed or called. Login is the SDK browser flow, which mints a stored Cursor API key under `~/.cursor/sdk/auth.json`.
5
+ ## Tools are callbacks, not a server
6
6
 
7
- The provider id is `cursor`, and model ids are Cursor's own ids. `/model cursor/gpt-5.5` and `/model cursor/claude-opus-4-8` work as written.
7
+ `LocalAgentOptions.customTools` registers one in-process callback per tool, and a tool call does not end the Cursor run. The callback waits, pi executes the named tool through its normal pipeline, and the next `streamSimple` call resolves the callback with the result. The same run continues, so the model sees the result in the same conversation.
8
8
 
9
- ## Requirements
9
+ The extension switches Cursor's own harness off: `AgentOptions.tools: ['mcp']` leaves only pi's custom tools, and `local.settingSources: []` drops Cursor's rules, skills and MCP servers. No HTTP MCP server, no Hono server, no tool-name rewriting.
10
10
 
11
- - Pi 1.4 or newer.
12
- - Node 24 or newer.
13
- - A Cursor account.
14
- - The extension dependency `@cursor/sdk` 1.0.40, installed by the workspace.
11
+ ## A restart resumes the agent
15
12
 
16
- ## Install
17
-
18
- ```sh
19
- pi install /path/to/extensions/pi-cursor
20
- ```
13
+ At the end of every clean turn the extension records the agent id with the working folder, prompt and tool hashes, the pi message count and its own hash of that prefix, in `~/.pi/agent/pi-cursor-agents.json`. The next process calls `Agent.resume` when all of those still match and the pending turn is a single new user message. A stale id, a diverged fork, or a turn killed mid tool round falls back to the replay. The ledger keeps the last 20 sessions.
21
14
 
22
- In this repository the workspace already registers the extension in the root `package.json`.
15
+ A message typed while a tool runs goes out with `Run.steer`, so the model reads it before its next step. Images attached to such a message become a one-line note, because steering carries only text.
23
16
 
24
- ## Login
17
+ ## Use
25
18
 
26
19
  ```text
27
- /cursor login
20
+ /model cursor/gpt-5.5
28
21
  ```
29
22
 
30
- The SDK opens the Cursor login page and mints a key when the browser flow finishes. If the browser does not open, the command prints the URL. `/cursor status` shows the account and `/cursor logout` removes the stored key.
23
+ The provider id is `cursor` and model ids are Cursor's own. The list comes from `Cursor.models.list()`, cached after the last successful read in `~/.pi/agent/pi-cursor-models.json` at mode 0600 and keyed by the credential. Startup registers the cache with no network call, session start refreshes it, and a small built-in list is the fallback.
31
24
 
32
- `CURSOR_API_KEY` overrides the stored login. The key is read by the SDK, not copied into Pi's `auth.json`.
25
+ A model that offers several context windows is registered once per window: the plain id uses the smallest, and `cursor/gpt-5.5@1m` asks for 1M. Cursor bills the larger windows as Max Mode, so the small default is the cheap one.
33
26
 
34
- Cursor bills SDK traffic under its own terms. This extension cannot tell you whether a run is plan-included, so check the Cursor dashboard for the account's SDK usage.
27
+ | Command | Effect |
28
+ | --- | --- |
29
+ | `/cursor status` | Account, fast mode, prompt path, models |
30
+ | `/cursor login` | The SDK browser flow |
31
+ | `/cursor logout` | Removes the stored key and the resume ledger |
32
+ | `/cursor models` | Every registered id, per context window |
33
+ | `/cursor fast on\|off` | Cursor's `fast` parameter on every model that exposes it |
34
+ | `/cursor clear` | Drops the resume ledger |
35
35
 
36
- ## Use
36
+ `/cursor fast` is a billing choice, so it stays off until asked.
37
37
 
38
- ```text
39
- /model cursor/gpt-5.5
40
- ```
38
+ Thinking levels map to Cursor model parameters from the live catalog: `thinking` and `effort` for Claude models, `reasoning` for GPT, `effort` for Grok.
41
39
 
42
- The model list comes from `Cursor.models.list()`, cached after the last successful read in `~/.pi/agent/pi-cursor-models.json` (0600, keyed by the credential). Startup registers the cache with no network call, the session start refresh replaces it, and a small built-in list is the fallback when there is no cache yet. A model that offers several context windows is registered once per window: the plain id uses the smallest one, `cursor/gpt-5.5@1m` asks for 1M. Cursor bills the larger windows as Max Mode, so the small default is the cheap one. `/cursor models` prints them.
40
+ ## Wire cost
43
41
 
44
- `/cursor fast on` adds Cursor's `fast` model parameter to every model that exposes it. It is a billing choice, so it stays off until you ask for it. `/cursor status` shows the current setting.
42
+ Measured on the account this extension was built on, gpt-5.5 with auto-smart and thinking off:
45
43
 
46
- ## How it works
44
+ | Call | Input tokens | Wall time |
45
+ | --- | --- | --- |
46
+ | First call of an agent | 11.9k fresh plus 2.6k cached | 4.8 to 5.5s |
47
+ | Plain follow-up turn | 12.9k fresh plus 12.7k cached | 2.2s |
48
+ | Call after a tool round | 36.9k fresh plus 36.0k cached | 4.4 to 13s |
47
49
 
48
- | Pi | Cursor SDK |
49
- | ------------------------- | ------------------------------------------------------------------------------------ |
50
- | Pi system prompt | `AgentOptions.systemPrompt`, replaces the Cursor harness prompt |
51
- | Pi tools | `LocalAgentOptions.customTools`, one in-process callback per Pi tool |
52
- | Cursor built-ins | `AgentOptions.tools: ['mcp']`, so only Pi's custom tools exist |
53
- | Cursor rules, skills, MCP | `local.settingSources: []` |
54
- | Pi tool execution | the custom tool callback parks, Pi runs the tool, the next provider call resolves it |
50
+ The tool-round number is Cursor's, not the tool result. The SDK re-prefills its own context around the custom tool callback, so one tool call costs about three plain calls. The same 32k fresh appears with an empty working directory, so it is not workspace scanning. Fewer, wider tool calls per turn is the lever that exists.
55
51
 
56
- A tool call does not end the Cursor run. The callback waits, Pi executes the named tool through its normal pipeline, and the next `streamSimple` call resolves the callback with the result. The same Cursor run continues, so the model sees the tool result in the same conversation. A message you steer in while that tool is running is delivered with `Run.steer`, so the model reads it before its next step; images attached to such a message become a one-line note because steering carries text only.
52
+ The extension adds no tool, no prompt block and no schema. What it saves on the wire is the replay: a normal turn sends only the new user message, a tool round sends nothing, and a restarted pi process resumes the same agent.
57
53
 
58
- One Cursor agent runs per Pi session. A normal turn sends only the new user message. A tool round resolves parked callbacks and sends nothing. The agent is only replaced when Pi's prompt, tool set or working directory changes, or when the Pi history diverges. That replacement replays the existing Pi conversation once as a single message.
54
+ ## Install
59
55
 
60
- A restarted Pi process resumes the same Cursor agent instead of replaying. At the end of every clean turn the extension records the agent id with the working folder, prompt and tool hashes, the Pi message count and the extension's hash of that prefix, in `~/.pi/agent/pi-cursor-agents.json`. The next process calls `Agent.resume` when all of those still match and the pending turn is a single new user message. A stale id, a fork that diverged, or a turn that was killed mid tool round all fall back to the replay, which is the pre-resume behavior. The ledger keeps the last 20 sessions. `/cursor clear`, `/cursor login` and `/cursor logout` delete it, so those commands really do start from a fresh agent.
56
+ - Pi 1.4 or newer.
57
+ - Node 24 or newer.
58
+ - A Cursor account.
59
+ - `@cursor/sdk` 1.0.40, installed by the workspace as a 25 MB dependency with optional platform packages.
61
60
 
62
- There is no HTTP MCP server, no Hono server and no tool-name rewriting. Cursor's SDK invokes the callback directly.
61
+ ```sh
62
+ pi install npm:@tduyng/pi-cursor
63
+ ```
63
64
 
64
- ## Token and cache behavior
65
+ Local checkout: `pi install /path/to/dotfiles/pi/agent/extensions/pi-cursor`
65
66
 
66
- Cursor's backend owns its own conversation and cache. Pi does not replay a linear conversation on every turn, it does not run a second agent for tool rounds, and a restart resumes the agent rather than replaying. The Pi system prompt is stable for the lifetime of an agent, and the tool list is stable too. A divergence is the only case that pays a replay.
67
+ No Cursor CLI is installed or called. Login is the SDK browser flow, which mints a stored Cursor key under `~/.cursor/sdk/auth.json`:
67
68
 
68
- Thinking levels map to Cursor model parameters. For Claude models the extension sets both `thinking` and `effort`. For GPT models it sets `reasoning`. For Grok it sets `effort`. The mapping comes from the live model catalog.
69
+ ```text
70
+ /cursor login
71
+ ```
69
72
 
70
- What the wire actually costs, measured on the account this extension was built on (gpt-5.5 and auto-smart, thinking off):
73
+ If the browser does not open, the command prints the URL. `CURSOR_API_KEY` overrides the stored login, and the key is read by the SDK rather than copied into pi's `auth.json`.
71
74
 
72
- | Call | Input tokens | Wall time |
73
- | ----------------------- | -------------------------- | --------- |
74
- | first call of an agent | 11.9k fresh + 2.6k cached | 4.8-5.5 s |
75
- | plain follow-up turn | 12.9k fresh + 12.7k cached | 2.2 s |
76
- | call after a tool round | 36.9k fresh + 36.0k cached | 4.4-13 s |
75
+ Cursor bills SDK traffic under its own terms, and this extension cannot tell whether a run is plan-included. Check the Cursor dashboard for the account's SDK usage.
77
76
 
78
- The tool-round number is Cursor's, not the tool result: the SDK re-prefills its own context around the custom tool callback, so one tool call costs about three plain calls. A turn that ends in a tool call is the slow turn, and there is no Pi-side switch for it. The same 32k fresh appears when the working directory is empty, so it is not workspace scanning. Fewer, wider tool calls per turn is the lever that exists.
77
+ `~/.pi/agent/pi-cursor.json` holds the two preferences: `fast`, from `/cursor fast`, and `noSystemPrompt`, once Cursor has refused pi's prompt for this account.
79
78
 
80
- ## Limitations
79
+ ## Limits
81
80
 
82
- - Cursor owns the agent loop and its context management. Pi's compaction does not reach inside a live Cursor agent.
83
- - `AgentOptions.systemPrompt` is server-gated. A rejected prompt comes back as a failed run about 20 seconds in, not from `Agent.create`, so the extension retries that turn with the prompt prepended to the first message. The rejection is recorded as `noSystemPrompt` in `~/.pi/agent/pi-cursor.json` and every later agent skips the doomed attempt. Clear that flag with `/cursor login`, or edit the file. `/cursor status` shows which path is in use. The fallback works but spends more tokens because Cursor's harness prompt remains.
84
- - A failed Cursor run reaches Pi as an error message, so an empty answer now means a broken transport, not a silent backend rejection.
85
- - Usage tokens come from Cursor's `turn-ended` events, plus the run's own total when it ends. Pi records each message's share of the run, so the numbers add up across a tool round instead of keeping only the last step. The message that ends in a tool call shows zero because that step has not ended server-side yet, and the next message carries both steps. Pi shows a zero money cost because Cursor bills outside Pi.
86
- - Images ride with the message that carries them. A replay replaces every earlier image with an `[image: mime]` placeholder and keeps only the pending message's images, so reattach one to ask about it again after a restart.
87
- - A model id that Cursor no longer serves fails at `send`, not at model selection.
88
- - A long Pi tool run is held open by Cursor local runtime. The SDK does not document a timeout for custom tools.
89
- - The Cursor SDK is a 25 MB dependency with optional platform packages.
81
+ - Cursor owns the agent loop and its context management, so pi's compaction does not reach inside a live agent.
90
82
 
91
- ## Configuration
83
+ - `AgentOptions.systemPrompt` is server-gated. A rejected prompt comes back as a failed run about 20 seconds in, not from `Agent.create`, so that turn is retried with the prompt prepended to the first message.
92
84
 
93
- | Variable | Meaning |
94
- | ---------------- | ----------------------------------------------- |
95
- | `CURSOR_API_KEY` | Cursor API key. Overrides the stored SDK login. |
85
+ - The rejection is recorded as `noSystemPrompt`, and every later agent skips the doomed attempt. The fallback works but spends more tokens, because the Cursor harness prompt remains.
96
86
 
97
- `~/.pi/agent/pi-cursor.json` holds the two preferences: `fast` from `/cursor fast`, and `noSystemPrompt` once Cursor has refused the Pi prompt for this account.
87
+ - A failed run reaches pi as an error message, so an empty answer means a broken transport rather than a silent backend rejection.
98
88
 
99
- ## Tests
89
+ - Usage tokens come from Cursor's `turn-ended` events plus the run's own total. A message that ends in a tool call shows zero, because that step has not ended server side, and the next message carries both. Pi shows zero money cost because Cursor bills outside pi.
100
90
 
101
- ```sh
102
- bun test extensions/pi-cursor
103
- bun run typecheck
104
- bun run lint:anti-slop
105
- ```
91
+ - A replay replaces earlier images with an `[image: mime]` placeholder and keeps only the pending message's images, so reattach one to ask about it again after a restart.
92
+
93
+ - A model id Cursor no longer serves fails at `send`, not at selection.
94
+
95
+ - A long pi tool run is held open by the Cursor local runtime, and the SDK documents no timeout for custom tools.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@tduyng/pi-cursor",
3
- "version": "0.0.2",
4
- "description": "Use Cursor models in Pi through the official Cursor SDK, with Pi's own prompt and tools.",
3
+ "version": "0.0.4",
4
+ "description": "Cursor models in Pi through the official Cursor SDK: one warm agent per session, Pi's own prompt and tools, resumed instead of replayed.",
5
5
  "keywords": [
6
6
  "pi",
7
7
  "pi-package",