@ai-sdk/harness-cursor 0.0.0 → 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# @ai-sdk/harness-cursor
+
+## 1.0.0
+
+### Major Changes
+
+- ac1384b: feat(harness-cursor): implement Cursor harness adapter
+
+### Patch Changes
+
+- Updated dependencies [79186d1]
+- Updated dependencies [b6396ff]
+- Updated dependencies [8a15038]
+  - @ai-sdk/harness-acp@1.0.25
+  - @ai-sdk/harness@1.0.87
+  - @ai-sdk/provider-utils@5.0.30

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2023 Vercel, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -1,3 +1,45 @@
-# @ai-sdk/harness-cursor
+# AI SDK - Cursor Harness
 
-AI SDK harness adapter for Cursor.
+The **[@ai-sdk/harness-cursor](https://www.npmjs.com/package/@ai-sdk/harness-cursor)** package adapts [Cursor CLI](https://cursor.com/cli) to the AI SDK harness abstraction through the Agent Client Protocol (ACP).
+
+## Setup
+
+```bash
+npm install @ai-sdk/harness @ai-sdk/harness-cursor @ai-sdk/sandbox-vercel
+```
+
+Create a Cursor user API key and set `CURSOR_API_KEY`. The key authenticates Cursor CLI in the sandbox regardless of how Cursor is configured to authenticate to the model provider.
+
+## Usage
+
+```ts
+import { HarnessAgent } from '@ai-sdk/harness/agent';
+import { cursor } from '@ai-sdk/harness-cursor';
+import { createVercelSandbox } from '@ai-sdk/sandbox-vercel';
+
+const agent = new HarnessAgent({
+  harness: cursor,
+  sandbox: createVercelSandbox({
+    runtime: 'node24',
+    ports: [4000],
+  }),
+});
+
+const session = await agent.createSession();
+
+try {
+  const result = await agent.generate({
+    session,
+    prompt: 'Inspect this project and summarize its purpose.',
+  });
+  console.log(result.text);
+} finally {
+  await session.destroy();
+}
+```
+
+The adapter installs Cursor CLI inside the sandbox with Cursor's official installer. The sandbox must provide network access and at least one exposed TCP port.
+
+Cursor controls model-provider authentication in its own settings. For AI Gateway, configure Cursor's OpenAI API key with an AI Gateway key and set **Override OpenAI Base URL** to `https://ai-gateway.vercel.sh/cursor/v1`. The `auth` setting accepts the shared ACP modes `auto`, `direct`, and `ai-gateway`; explicit `direct` and `ai-gateway` values emit a configuration reminder, while `auto` does not. The setting cannot change Cursor's account configuration.
+
+See the [Cursor harness documentation](https://ai-sdk.dev/providers/ai-sdk-harnesses/cursor) for settings, tools, and limitations.