Cursor Docs
Local mirror of Cursor documentation, kept fresh by a 3-hour GitHub Action. The cleaned Markdown lives in references/; the auto-generated topic list lives in references/INDEX.md; the per-file manifest with upstream URLs lives in references/docs_manifest.json.
Scope
Use this skill for Cursor-specific product and configuration questions, including the agent and its tools, Agent Skills, Rules, Hooks, Model Context Protocol (MCP), Subagents, Plugins, the Cursor CLI, cloud agents, models and pricing, the SDK, integrations, and account, team, and reference documentation. If the question is about Claude Code, OpenAI Codex, the Anthropic API, or another non-Cursor product, this skill does not apply. Cursor enterprise administration docs are intentionally not mirrored.
Workflow
- If the user supplied a topic, normalize it to a slug:
- lowercase, strip leading
https://cursor.com/docs/ or /docs/, strip surrounding slashes
- join nested segments with
__ (e.g. agent overview -> agent__overview, reference permissions -> reference__permissions)
- If
references/<slug>.md exists, read that file directly. Do NOT grep the whole references/ tree first - the index plus targeted reads is faster and uses less context.
- If no exact match, read
references/INDEX.md and pick the closest topic. If still ambiguous, list the candidates and ask.
- If the user supplied no topic, read
references/INDEX.md and present the available topics.
Answer format
- Lead with a direct answer to the user's question grounded in the file you read.
- Quote short snippets (commands, config keys) when they appear verbatim in the doc.
- End with
Source: <upstream URL> using the source value from the file frontmatter or original_url from references/docs_manifest.json.
Freshness and fallback
The mirror is refreshed every 3 hours by upstream CI, which fails rather than committing frozen content. If the local content looks stale, contradicted by the user, or empty:
- Suggest the user run
npx skills update cursor-docs.
- Check the file's entry in
references/docs_manifest.json: a status of stale means upstream could not be reached on the last run.
- Cross-check the canonical URL via
original_url in references/docs_manifest.json and offer it as a follow-up source.
Examples
| Invocation |
Reads |
/cursor-docs hooks |
references/hooks.md |
/cursor-docs mcp |
references/mcp.md |
/cursor-docs skills |
references/skills.md |
/cursor-docs agent overview |
references/agent__overview.md |
/cursor-docs reference permissions |
references/reference__permissions.md |
/cursor-docs (no argument) |
references/INDEX.md |
1---2name: cursor-docs3description: Local mirror of Cursor product documentation (cursor.com/docs): Agent, Agent Skills, Rules, Hooks, MCP, Subagents, Plugins, CLI, cloud agents, models and pricing, SDK, integrations, account and team settings, and Cursor configuration reference. Use whenever the user asks how Cursor behaves, how to install or configure Cursor, or what a Cursor feature, flag, model, or settings key does. Read this skill's references/ before generic web search for Cursor product questions. Do NOT use for Claude Code, OpenAI Codex, Anthropic API docs, or general coding-agent questions.4---56# Cursor Docs78Local mirror of Cursor documentation, kept fresh by a 3-hour GitHub Action. The cleaned Markdown lives in `references/`; the auto-generated topic list lives in `references/INDEX.md`; the per-file manifest with upstream URLs lives in `references/docs_manifest.json`.910## Scope1112Use this skill for Cursor-specific product and configuration questions, including the agent and its tools, Agent Skills, Rules, Hooks, Model Context Protocol (MCP), Subagents, Plugins, the Cursor CLI, cloud agents, models and pricing, the SDK, integrations, and account, team, and reference documentation. If the question is about Claude Code, OpenAI Codex, the Anthropic API, or another non-Cursor product, this skill does not apply. Cursor enterprise administration docs are intentionally not mirrored.1314## Workflow15161. If the user supplied a topic, normalize it to a slug:17 - lowercase, strip leading `https://cursor.com/docs/` or `/docs/`, strip surrounding slashes18 - join nested segments with `__` (e.g. `agent overview` -> `agent__overview`, `reference permissions` -> `reference__permissions`)192. If `references/<slug>.md` exists, read that file directly. Do NOT grep the whole `references/` tree first - the index plus targeted reads is faster and uses less context.203. If no exact match, read `references/INDEX.md` and pick the closest topic. If still ambiguous, list the candidates and ask.214. If the user supplied no topic, read `references/INDEX.md` and present the available topics.2223## Answer format2425- Lead with a direct answer to the user's question grounded in the file you read.26- Quote short snippets (commands, config keys) when they appear verbatim in the doc.27- End with `Source: <upstream URL>` using the `source` value from the file frontmatter or `original_url` from `references/docs_manifest.json`.2829## Freshness and fallback3031The mirror is refreshed every 3 hours by upstream CI, which fails rather than committing frozen content. If the local content looks stale, contradicted by the user, or empty:32331. Suggest the user run `npx skills update cursor-docs`.342. Check the file's entry in `references/docs_manifest.json`: a `status` of `stale` means upstream could not be reached on the last run.353. Cross-check the canonical URL via `original_url` in `references/docs_manifest.json` and offer it as a follow-up source.3637## Examples3839| Invocation | Reads |40| --- | --- |41| `/cursor-docs hooks` | `references/hooks.md` |42| `/cursor-docs mcp` | `references/mcp.md` |43| `/cursor-docs skills` | `references/skills.md` |44| `/cursor-docs agent overview` | `references/agent__overview.md` |45| `/cursor-docs reference permissions` | `references/reference__permissions.md` |46| `/cursor-docs` (no argument) | `references/INDEX.md` |
mehmetbaykar