Menu
Entry point for the Cursor TypeScript SDK โ install, auth, and the Agent.create / Agent.resume / Agent.prompt lifecycle. Use when starting any Cursor SDK integration or wiring durable agent IDs.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
| name | cursor-sdk |
| description | Entry point for the Cursor TypeScript SDK โ install, auth, and the Agent.create / Agent.resume / Agent.prompt lifecycle. Use when starting any Cursor SDK integration or wiring durable agent IDs. |
| metadata | {"internal":false,"source":"https://cursor.com/docs/sdk/typescript"} |
Map of Content for the Cursor TypeScript SDK. Start here, then follow [[wikilinks]] to the atomic concept you need. Sibling skills (cursor-runs, cursor-cloud, cursor-mcp, cursor-subagents, cursor-models, cursor-hooks, cursor-errors) are part of the same graph โ link across with [[../cursor-runs/references/stream]].
@cursor/sdknpm install @cursor/sdk, Node 20+, CURSOR_API_KEYapiKey, service account keys, Team Admin caveatCursor.me(), Cursor.repositories.list()Agent.create(options) full option surfaceAgent.resume(agentId, partialOptions) and what is not persistedAgent.prompt(message, options) one-shot helperAgent.list, Agent.get, Agent.archive, Agent.unarchive, Agent.deleteawait using, Symbol.asyncDispose, agent.close()local.cwd, settingSources, sandboxOptionsThe `agent` CLI โ install, interactive modes (Agent / Plan / Ask), headless `-p` mode for CI, GitHub Actions integration, and how it relates to the TypeScript SDK. Use when scripting Cursor in shell pipelines or workflows instead of (or alongside) the SDK.
Cloud runtime for Cursor SDK โ dedicated VMs, repo-bound runs, auto-PR creation, artifacts, and reattachment. Use when running long, review-oriented, or repo-modifying agents off the local machine.
CursorAgentError class hierarchy, isRetryable, and recovery patterns. Use when classifying SDK failures, building retry logic, or surfacing actionable messages.
File-based agent loop hooks via `.cursor/hooks.json` โ pre/post commands, governance gates. Use when enforcing policy without modifying agent prompts.
Configure MCP servers on Cursor SDK agents โ stdio subprocess, HTTP, and SSE transports, inline vs file-based config, and per-run overrides. Use when extending an agent's tools beyond the built-ins.
Model discovery and selection on Cursor SDK โ Cursor.models.list, ModelSelection, parameters (e.g. thinking levels), per-run sticky overrides.