SuperAPI AI 工具集

cursor-sdk

编程与开发

查看项目

更新于 10-16 08:07

技能介绍

用途:Cursor TypeScript SDK(@cursor/sdk)让开发者以编程方式运行 Cursor 智能体,适用于构建应用、脚本、CI 流水线与自动化。同一套接口可驱动本地运行时(智能体在调用者机器上针对本地文件运行)和云端运行时(在 Cursor 托管或自托管基础设施上针对克隆的仓库运行并可开 PR)。官方文档见 https://cursor.com/docs/api/sdk/typescript。

主要能力与用法:常见集成有三种调用形态。一是 Agent.prompt(...) 一次性调用,适合发一条提示取结果即退出的脚本或 GitHub Actions 步骤;二是 Agent.create(...) 配合 agent.send(...),支持流式输出、多轮对话与生命周期操作(取消、状态监听),适合较复杂的集成;三是 Agent.resume(...) 跨进程恢复已有智能体,如定时任务续跑、Webhook 扩展用户智能体。认证通过 CURSOR_API_KEY 环境变量或显式传入 apiKey,用户密钥与团队服务账号密钥均可用于本地和云端运行。模型可用 Cursor.models.list() 查询,composer-2 为多数集成的当前默认,{ id: "auto" } 由服务端选择;本地运行必须指定模型,云端可选。

注意事项与限制:省略 local 与 cloud 会静默回退到本地运行时,需要云端时应显式传 cloud: { repos }。启动失败(抛出 CursorAgentError,涉及认证、配置、网络)与运行中失败(result.status === "error")是两类不同问题,应分别处理。务必在 finally 中调用 agentSymbol.asyncDispose 释放资源,或使用 Agent.prompt()。run.wait() 几乎必须调用,否则无法判断运行结果并会泄漏内部监听器;调用 stream、cancel、conversation 前应先用 run.supports(...) 判断运行时是否支持。resume 不会保留内联 mcpServers,需重新传入。本技能不覆盖 Cloud Agents REST API、.cursor/hooks.json 钩子、私有 worker 及非 TypeScript SDK(目前无官方其他语言 SDK,REST 为可移植方案)。