@tduyng/pi-cursor 0.0.0-stage → 0.0.1

package/LICENSE

@@ -0,0 +1,178 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+Use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2026 tduyng

package/README.md

@@ -1,3 +1,88 @@
-# Temporary Holding Version
+# pi-cursor
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+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.
+
+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`.
+
+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.
+
+## Requirements
+
+- Pi 1.4 or newer.
+- Node 24 or newer.
+- A Cursor account.
+- The extension dependency `@cursor/sdk` 1.0.40, installed by the workspace.
+
+## Install
+
+```sh
+pi install /path/to/extensions/pi-cursor
+```
+
+In this repository the workspace already registers the extension in the root `package.json`.
+
+## Login
+
+```text
+/cursor login
+```
+
+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.
+
+`CURSOR_API_KEY` overrides the stored login. The key is read by the SDK, not copied into Pi's `auth.json`.
+
+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.
+
+## Use
+
+```text
+/model cursor/gpt-5.5
+```
+
+The first model list is a small fallback so `/model` is usable before login. After login, or on the next session start, the extension reads `Cursor.models.list()` and registers every model the account can reach. `/cursor models` prints them.
+
+## How it works
+
+| Pi                        | Cursor SDK                                                                           |
+| ------------------------- | ------------------------------------------------------------------------------------ |
+| Pi system prompt          | `AgentOptions.systemPrompt`, replaces the Cursor harness prompt                      |
+| Pi tools                  | `LocalAgentOptions.customTools`, one in-process callback per Pi tool                 |
+| Cursor built-ins          | `AgentOptions.tools: ['mcp']`, so only Pi's custom tools exist                       |
+| Cursor rules, skills, MCP | `local.settingSources: []`                                                           |
+| Pi tool execution         | the custom tool callback parks, Pi runs the tool, the next provider call resolves it |
+
+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.
+
+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.
+
+There is no HTTP MCP server, no Hono server and no tool-name rewriting. Cursor's SDK invokes the callback directly.
+
+## Token and cache behavior
+
+Cursor's backend owns its own conversation and cache. Pi does not replay a linear conversation on every turn, and it does not run a second agent for tool rounds. 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.
+
+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.
+
+## Limitations
+
+- Cursor owns the agent loop and its context management. Pi's compaction does not reach inside a live Cursor agent.
+- `AgentOptions.systemPrompt` is server-gated. If Cursor rejects it, the extension recreates the agent without it and prepends Pi's prompt to the first message. That fallback works but spends more tokens because Cursor's harness prompt remains.
+- Usage tokens come from Cursor's `turn-ended` events. Pi shows a zero money cost because Cursor bills outside Pi.
+- Images work in new messages. Replayed history carries images without their original message labels.
+- A model id that Cursor no longer serves fails at `send`, not at model selection.
+- A long Pi tool run is held open by Cursor local runtime. The SDK does not document a timeout for custom tools.
+- The Cursor SDK is a 25 MB dependency with optional platform packages.
+
+## Configuration
+
+| Variable         | Meaning                                         |
+| ---------------- | ----------------------------------------------- |
+| `CURSOR_API_KEY` | Cursor API key. Overrides the stored SDK login. |
+
+## Tests
+
+```sh
+bunx vitest run extensions/pi-cursor
+bun run typecheck
+bun run lint:anti-slop
+```

package/package.json

@@ -1,6 +1,44 @@
 {
   "name": "@tduyng/pi-cursor",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.0.1",
+  "description": "Use Cursor models in Pi through the official Cursor SDK, with Pi's own prompt and tools.",
+  "keywords": [
+    "pi",
+    "pi-package",
+    "pi-extension",
+    "pi-coding-agent",
+    "cursor",
+    "cursor-sdk",
+    "models"
+  ],
+  "license": "Apache-2.0",
+  "author": "tduyng",
+  "type": "module",
+  "files": [
+    "src",
+    "!src/**/*.test.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "@cursor/sdk": "1.0.40",
+    "ata-validator": "^1.62.1",
+    "zod": "^4.0.0"
+  },
+  "peerDependencies": {
+    "@earendil-works/pi-ai": "*",
+    "@earendil-works/pi-coding-agent": "*"
+  },
+  "pi": {
+    "extensions": [
+      "./src/index.ts"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.com/tduyng/pi-agent.git",
+    "directory": "extensions/pi-cursor"
+  },
+  "homepage": "https://gitlab.com/tduyng/pi-agent/-/tree/main/extensions/pi-cursor#readme",
+  "bugs": "https://gitlab.com/tduyng/pi-agent/-/issues"
+}

package/src/index.ts

@@ -0,0 +1,165 @@
+import type { SdkLoginOptions } from '@cursor/sdk'
+import type { ExtensionAPI, ExtensionCommandContext } from '@earendil-works/pi-coding-agent'
+
+import { fallbackModels, rememberModels, toPiModels, type PiModelEntry } from './models.js'
+import { cursorApiKey, cursorSdk } from './sdk.js'
+import { allSessions, dropSessions, sweep } from './session.js'
+import { createRuntime, streamCursor } from './turn.js'
+
+const PROVIDER_ID = 'cursor'
+const API_ID = 'cursor'
+const IDLE_MS = 20 * 60_000
+
+export default function piCursor(pi: ExtensionAPI): void {
+    const runtime = createRuntime()
+    let models: PiModelEntry[] = fallbackModels()
+    let refreshing: Promise<PiModelEntry[]> | undefined
+    let refreshed = false
+    let sweeper: ReturnType<typeof setInterval> | undefined
+
+    function register(next: PiModelEntry[]): void {
+        models = next
+        pi.registerProvider(PROVIDER_ID, {
+            name: 'Cursor (SDK)',
+            baseUrl: 'cursor://local',
+            apiKey: 'cursor-sdk',
+            api: API_ID,
+            models: next,
+            streamSimple: (model, context, options) => streamCursor(runtime, model, context, options),
+            refreshModels: () => refresh()
+        })
+    }
+
+    async function refresh(): Promise<PiModelEntry[]> {
+        refreshing ??= (async () => {
+            try {
+                const { Cursor } = await cursorSdk()
+                const items = await Cursor.models.list({ apiKey: cursorApiKey() })
+                rememberModels(items)
+                const next = toPiModels(items)
+                if (next.length > 0) register(next)
+                return models
+            } catch {
+                return models
+            } finally {
+                refreshing = undefined
+            }
+        })()
+        return refreshing
+    }
+
+    register(models)
+
+    if (!sweeper) {
+        sweeper = setInterval(() => sweep(runtime.sessions, IDLE_MS), 60_000)
+        sweeper.unref()
+    }
+
+    pi.on('session_start', () => {
+        if (refreshed) return
+        refreshed = true
+        void refresh().catch(() => undefined)
+    })
+
+    pi.on('session_shutdown', () => {
+        dropSessions(runtime.sessions)
+        if (sweeper) clearInterval(sweeper)
+        sweeper = undefined
+    })
+
+    process.once('exit', () => dropSessions(runtime.sessions))
+
+    const show = (text: string) =>
+        pi.sendMessage({ customType: 'cursor', display: true, content: text }, { triggerTurn: false })
+
+    async function login(ctx: ExtensionCommandContext): Promise<void> {
+        const { Cursor } = await cursorSdk()
+        const options: SdkLoginOptions = {
+            apiKeyName: 'pi-cursor',
+            onLoginUrl: (url) => {
+                void show(`Cursor login. Open this URL if the browser did not:\n${url}`)
+            }
+        }
+        if (ctx.signal) options.signal = ctx.signal
+        const result = await Cursor.auth.login(options)
+        await refresh()
+        await show(
+            `Cursor: logged in${result.email ? ` as ${result.email}` : ''}. ${models.length} model(s) available.`
+        )
+    }
+
+    pi.registerCommand('cursor', {
+        description: 'Cursor SDK login, status and model list',
+        getArgumentCompletions: (prefix: string) =>
+            [
+                { value: 'status', label: 'status', description: 'login state, models and live agents' },
+                { value: 'login', label: 'login', description: 'browser login, no Cursor CLI' },
+                { value: 'logout', label: 'logout', description: 'forget the SDK credential' },
+                { value: 'models', label: 'models', description: 'every Cursor model the provider exposes' },
+                { value: 'clear', label: 'clear', description: 'close every warm Cursor agent' },
+                { value: 'help', label: 'help', description: 'usage' }
+            ].filter((item) => item.value.startsWith(prefix.trim())),
+        handler: async (args: string, ctx: ExtensionCommandContext) => {
+            const sub = args.trim().split(/\s+/).filter(Boolean)[0] ?? 'status'
+            if (sub === 'login') {
+                await login(ctx)
+                return
+            }
+            if (sub === 'logout') {
+                const { Cursor } = await cursorSdk()
+                await Cursor.auth.logout()
+                rememberModels([])
+                register(fallbackModels())
+                await show('Cursor: logged out. The SDK credential is gone.')
+                return
+            }
+            if (sub === 'clear') {
+                dropSessions(runtime.sessions)
+                await show('Cursor: closed every warm agent.')
+                return
+            }
+            if (sub === 'models') {
+                await show(
+                    [
+                        `${models.length} model(s), provider id ${PROVIDER_ID}:`,
+                        ...models.map((model) => `  ${PROVIDER_ID}/${model.id}`)
+                    ].join('\n')
+                )
+                return
+            }
+            if (sub === 'help') {
+                await show(
+                    [
+                        'Usage: /cursor [status|login|logout|models|clear|help]',
+                        '',
+                        'Login uses the official Cursor SDK browser flow and mints a stored API key.',
+                        'No Cursor CLI is installed or called.',
+                        'Pick a model with /model, for example cursor/gpt-5.5.',
+                        'CURSOR_API_KEY overrides the stored SDK login.'
+                    ].join('\n')
+                )
+                return
+            }
+            let authLine = 'unknown'
+            try {
+                const { Cursor } = await cursorSdk()
+                const auth = await Cursor.auth.status()
+                authLine =
+                    auth.status === 'logged-in' ? `logged-in${auth.email ? ` (${auth.email})` : ''}` : auth.status
+            } catch (error) {
+                authLine = `unavailable: ${error instanceof Error ? error.message : String(error)}`
+            }
+            const sessions = allSessions(runtime.sessions)
+            const parked = sessions.reduce((count, session) => count + session.parked.size, 0)
+            await show(
+                [
+                    `auth: ${authLine}`,
+                    `credential: ${cursorApiKey() ? 'CURSOR_API_KEY' : 'stored SDK login'}`,
+                    `models: ${models.length}`,
+                    `live agents: ${sessions.length}, parked tool calls: ${parked}`,
+                    'prompt: Pi system prompt and Pi tools only; Cursor built-in tools disabled'
+                ].join('\n')
+            )
+        }
+    })
+}

package/src/json.ts

@@ -0,0 +1,74 @@
+import { createHash } from 'node:crypto'
+
+import { Validator } from 'ata-validator'
+import { t } from 'ata-validator/t'
+
+const isStringArray = new Validator(t.array(t.string())).isValidObject
+const isString = new Validator(t.string()).isValidObject
+const isNumber = new Validator(t.number()).isValidObject
+const isBoolean = new Validator(t.boolean()).isValidObject
+
+export type JsonValue = null | boolean | number | string | JsonValue[] | JsonObject
+export type JsonObject = { [key: string]: JsonValue }
+
+const ObjectSchema = t.object({}, { additionalProperties: true })
+const isObjectSchema = new Validator(ObjectSchema).isValidObject
+const ArraySchema = t.array(t.any())
+const isArraySchema = new Validator(ArraySchema).isValidObject
+
+function isJsonObject<V>(value: V): value is V & JsonObject {
+    return isObjectSchema(value) && !Array.isArray(value)
+}
+
+export function jsonObject(value: JsonValue | undefined): JsonObject | undefined {
+    return isJsonObject(value) ? value : undefined
+}
+
+export function jsonArray(value: JsonValue | undefined): JsonValue[] | undefined {
+    if (!isArraySchema(value)) return undefined
+    return value
+}
+
+export function jsonStrings(value: JsonValue | undefined): string[] | undefined {
+    if (!isStringArray(value)) return undefined
+    return value
+}
+
+export function jsonText(object: JsonObject, key: string): string | undefined {
+    const value = object[key]
+    return isString(value) ? value : undefined
+}
+
+export function jsonNumber(object: JsonObject, key: string): number | undefined {
+    const value = object[key]
+    return isNumber(value) ? value : undefined
+}
+
+export function jsonBoolean(object: JsonObject, key: string): boolean | undefined {
+    const value = object[key]
+    return isBoolean(value) ? value : undefined
+}
+
+export function jsonFlag(object: JsonObject, key: string): boolean {
+    return jsonBoolean(object, key) === true
+}
+
+export function stableStringify(value: JsonValue): string {
+    return JSON.stringify(sortValue(value))
+}
+
+function sortValue(value: JsonValue): JsonValue {
+    if (Array.isArray(value)) return value.map(sortValue)
+    const object = jsonObject(value)
+    if (!object) return value
+    const sorted: JsonObject = {}
+    for (const key of Object.keys(object).toSorted()) {
+        const item = object[key]
+        if (item !== undefined) sorted[key] = sortValue(item)
+    }
+    return sorted
+}
+
+export function sha(value: string): string {
+    return createHash('sha256').update(value).digest('base64url')
+}

package/src/sdk.ts

@@ -0,0 +1,14 @@
+type CursorSdk = typeof import('@cursor/sdk')
+
+let loading: Promise<CursorSdk> | undefined
+
+export function cursorSdk(): Promise<CursorSdk> {
+    loading ??= import('@cursor/sdk')
+    return loading
+}
+
+export function cursorApiKey(): string | undefined {
+    const value = process.env['CURSOR_API_KEY']
+    const trimmed = value?.trim()
+    return trimmed && trimmed.length > 0 ? trimmed : undefined
+}