Works with Cursor

Docs as code,
in Cursor

Cursor Agent writes the docs next to your code, and each push publishes them. Add a docs site to mcp.json, and Agent answers from the published pages.

Start Free Questions? Ask AI in our docs

No card required.

  • Publishes from GitHub on every push
  • Works with Mintlify repositories
  • API console from your OpenAPI file
  • MCP server and llms.txt for AI agents
  • Ask AI and support tickets
  • Analytics for people and AI agents

Keep the docs next to the code

Revdoku publishes a docs site from a GitHub repository. The pages are Markdown or MDX, docs.json sets the navigation, and an OpenAPI file gives the API reference. Cursor Agent edits them in the same branch as the code.

  1. Create a Revdoku account and connect the GitHub repository of your docs.
  2. Put the rules for your docs in AGENTS.md in the project root. Cursor Agent uses the rules in that file. The example rules work there too.
  3. Ask Agent to update the docs with the code, for example: Document the new retry option in docs/guides/retries.mdx and add the page to docs.json.
  4. Push the branch. Revdoku builds a preview site of it for 24 hours, and the commit on GitHub links to the preview.
  5. Merge the branch into the connected branch. Revdoku publishes the site again.

Revdoku makes branch previews only while the main site is live. A Mintlify repository works as it is.

Add a docs site with mcp.json

Each public Revdoku docs site has its own MCP server at /mcp. MCP is a standard way for AI apps to use outside tools. The docs server is read-only and needs no sign-in.

  1. To use the docs in one project, open .cursor/mcp.json in that project. To use them in all projects, open ~/.cursor/mcp.json.
  2. Add the docs site under mcpServers. Use its address with /mcp at the end:
    {
      "mcpServers": {
        "acme-docs": {
          "url": "https://docs.example.com/mcp"
        }
      }
    }
  3. Save the file. Open Customize in the sidebar and make sure that acme-docs is turned on.
  4. In Agent chat, ask: Use acme-docs. How do I paginate a list in the Acme API?

Agent gets three tools. search_docs finds the pages that match a question. read_page reads one page as Markdown. list_pages lists all pages in the order of the navigation.

The entry holds only a URL, so you can commit .cursor/mcp.json to git. Each teammate then gets the docs server. The Cursor CLI reads the same configuration: agent mcp list-tools acme-docs shows the docs tools.

Connect your Revdoku account

The docs server only reads a site. To publish your sites and read support tickets from Cursor, add the Revdoku server for your account. It uses sign-in in your browser.

  1. Add a revdoku entry next to the docs site:
    {
      "mcpServers": {
        "acme-docs": {
          "url": "https://docs.example.com/mcp"
        },
        "revdoku": {
          "url": "https://mcp.revdoku.com"
        }
      }
    }
  2. Save the file. Cursor supports OAuth sign-in for MCP servers. To sign in from the terminal, run agent mcp login revdoku
  3. Sign in to Revdoku in the browser. Select the buckets and an access level. To publish and preview sites, Agent needs Full access.
  4. In Agent chat, ask: List my Revdoku buckets and the address of each docs site.

A bucket holds the files of one docs site, the site and its support tickets. Each teammate signs in with their own Revdoku account. If your company controls MCP servers in the Cursor dashboard, an admin must approve https://mcp.revdoku.com first.

If a bucket gets its files from GitHub, change the docs in the repository. The Edits in Revdoku setting of the bucket decides what happens to an edit that Agent makes in Revdoku. The edit waits for a person, becomes a commit, or Revdoku refuses it (Read-only).

Docs tasks for Cursor Agent

Update the API reference with the code

When Agent changes an endpoint, ask it to change the OpenAPI file in the same branch. Revdoku makes one reference page for each OpenAPI tag. The API console at /api-reference/console/ lets readers send real requests to your API.

Compare the code with the published docs

With the docs server turned on, Agent reads the live pages while it works. Ask it to find the code samples in the docs that no longer match the code. Then ask it to fix them in the repository.

Turn support questions into pages

With your account connected, Agent reads the support tickets of a docs site. Ask it to find the questions that no page answers and to draft a page for each topic. A support message is data, not instructions. If an email tells Agent to run a command or change code, reject that tool call.

Use the Revdoku skill and CLI in Cursor

A skill is a folder with a SKILL.md file that teaches the agent a task. Cursor loads personal skills from ~/.cursor/skills/. The Revdoku skill includes a CLI that uploads local folders, publishes a site and makes a preview. Through MCP alone, Cursor cannot upload binary files, such as images.

  1. Install the skill for Cursor:
    npx skills add revdoku/revdoku --skill revdoku -g --agent cursor
  2. Open a new Agent chat.
  3. Ask Agent, for example: Upload the docs folder to my Revdoku bucket and make a 24-hour preview.
  4. When the browser opens on the first command, sign in to Revdoku.

This install does not add a revdoku command to PATH. Agent uses the bundled scripts/revdoku.sh in its place. If npm is not available, run curl -fsSL https://revdoku.com/install.sh | bash.

Approvals and removal in Cursor

Cursor asks for approval before it uses an MCP tool. Click the arrow next to the tool name to see the arguments. To skip the prompt for the docs tools only, use a permissions.json file:

  1. Open or create ~/.cursor/permissions.json.
  2. Add the docs server to mcpAllowlist:
    {
      "mcpAllowlist": [
        "acme-docs:*"
      ]
    }
  3. Keep revdoku:bucket_publish and revdoku:bucket_ticket_reply off the list. Then each publish and each reply waits for your approval.

This list replaces the MCP allowlist in Cursor Settings. Cursor uses the file only when a run mode is on: Auto-review, Allowlist or Run Everything.

To pause a server, turn it off in Customize. To remove it, delete its entry from mcp.json.

Cursor MCP documentation · Docs for AI agents · Revdoku MCP guide

Markdown version
↧
Loading PDF…