---
title: Cursor
description: "Set up Cursor IDE to write Jamdesk documentation with MDX formatting rules, component autocompletion, and MCP server access for live docs context."
---
[Cursor](https://cursor.com) is an AI code editor built on VS Code. Its inline editing (Cmd+K) and chat (Cmd+L) work well for iterative MDX writing — select a paragraph, describe what you want, and Cursor rewrites it in place.
## Quick Setup
Open your Jamdesk docs directory in Cursor.
Create `.cursor/rules/jamdesk-docs.mdc` with documentation standards so Cursor's AI follows your conventions.
Add your docs MCP endpoint to `.cursor/mcp.json` so Cursor can search your published documentation.
## Cursor Rules Template
Create `.cursor/rules/jamdesk-docs.mdc` in your project root:
```markdown .cursor/rules/jamdesk-docs.mdc
---
description: Rules for writing Jamdesk documentation in MDX
globs: "**/*.mdx"
---
# Jamdesk MDX Rules
## Page Structure
Every page follows this pattern — no exceptions:
1. Frontmatter with `title` and `description`
2. Opening paragraph (no heading before it)
3. Content sections with ## headings
4. "What's Next?" section at the end with Card links inside Columns
## Components
Only use these — do not invent others:
Layout: Card, Columns, Tabs, Tab, Accordion, AccordionGroup, Steps, Step, Expandable, Frame, CodeGroup
Callouts: Note, Info, Warning, Tip, Check, Danger
| Use | For |
|-----|-----|
| Tabs | Mutually exclusive choices (npm/yarn, OS variants) |
| Steps | Ordered procedures the reader follows |
| Accordion | Optional detail that would clutter the page |
| Card + Columns | Navigation links and feature grids |
| Note/Tip/Warning | Important context — use sparingly |
Cards always go inside Columns: ``
Icons are Font Awesome Light names: "rocket", "code", "terminal", "book-open"
## Style
- Active voice: "Run this command" not "This command should be run"
- Start with why, then how
- One idea per paragraph
- Code examples must be complete and copy-pasteable
- Write like a person — no filler ("It's important to note"), no hedging ("you might want to consider"). If it sounds like a chatbot, rewrite it shorter.
## Common Mistakes
- ``, ``, `` don't exist — use the components listed above
- `` without `` wrapper won't render correctly
- Missing `description` in frontmatter breaks search and link previews
- Raw HTML tags should be MDX components instead
## New Pages
When creating a page, add it to `docs.json` navigation. Without this, the page won't appear in the sidebar. Read `docs.json` first to understand the group structure.
```
## MCP Configuration
Create `.cursor/mcp.json` to connect your published docs:
```json .cursor/mcp.json
{
"mcpServers": {
"my-docs": {
"url": "https://your-project.jamdesk.app/_mcp"
}
}
}
```
Replace `your-project` with your Jamdesk subdomain. See [MCP Server](/ai/mcp-server) for endpoint details and custom domain setup.
## Workflows
Select text in an MDX file and press **Cmd+K** to describe what you want changed. Works well for:
- Rewriting a section for clarity
- Adding a code example
- Converting text into a component (e.g., wrapping steps in ``)
Open chat with **Cmd+L** and ask questions with your docs as context:
- "What components are available for this page?"
- "Write a troubleshooting section for [feature]"
- "Review this page against our writing standards"
Use Composer for multi-file documentation tasks:
- Generate a new section with multiple pages
- Restructure navigation across files
- Bulk-update component usage patterns
## The /update-jamdesk Skill
For automated documentation updates when code changes, install the `/update-jamdesk` skill:
```bash
npx skills add jamdesk/skills --skill update-jamdesk -a cursor
```
See [Automated Updates](/ai/automated-updates) for the full guide.
## What's Next?
CLAUDE.md template and full-project context workflows
Effective prompts, review checklists, and common pitfalls