Write and read docs
with Claude Code

Revdoku publishes a docs site from a GitHub repository. It reads Markdown and MDX pages, the docs.json navigation and an OpenAPI file. A Mintlify repository works as it is. Claude Code changes these files like the other code in your project.

1. Create a Revdoku account. In the setup, select Connect a GitHub repository.
2. Select the repository, the branch and the folder of your docs. Then publish the site.
3. Ask Claude Code to change the docs, for example: Add a page about webhooks to docs/ and add it to docs.json.
4. Push the change to a new branch. Revdoku builds a preview site of that branch for 24 hours.
5. On GitHub, open the commit. Its Revdoku preview status links to the preview site.
6. Merge the branch into the connected branch. Revdoku publishes the site again.

Revdoku has no command that shows the docs on your computer. To see a change before it goes live, push a branch. Revdoku makes branch previews only while the main site is live.

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. In a terminal, go to your project folder.
2. Add the docs site. Use its address with /mcp at the end: claude mcp add --transport http acme-docs https://docs.example.com/mcp
3. Start Claude Code in the same folder. Ask: Use acme-docs. How do I authenticate to the Acme API?
4. When Claude Code asks for permission, allow the docs tool.

Claude Code 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.

Add your own docs site, and Claude Code can compare your code with the published docs. Add the docs site of an API that you call, if that API publishes its docs with Revdoku.

The scope decides where Claude Code saves a server and who gets it. For example, this command adds the docs site to all your projects: claude mcp add --transport http --scope user acme-docs https://docs.example.com/mcp

The project scope writes this file. The docs server needs no sign-in, so the file holds no secret. Commit it, and each teammate gets the docs server. Claude Code asks each person to approve a server from .mcp.json before it uses it.

{
  "mcpServers": {
    "acme-docs": {
      "type": "http",
      "url": "https://docs.example.com/mcp"
    }
  }
}

To let Claude Code use the docs tools without a prompt, allow them in .claude/settings.json. The rule covers all tools of the acme-docs server, and these tools only read public pages.

{
  "permissions": {
    "allow": [
      "mcp__acme-docs__*"
    ]
  }
}

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

1. In a terminal, run this command: claude mcp add --transport http revdoku https://mcp.revdoku.com
2. Start Claude Code. Type /mcp and select revdoku.
3. Sign in to Revdoku in the browser that opens. Select the buckets and an access level from the table that follows. Then click Connect.
4. Ask Claude Code: 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. To sign in from the shell, run claude mcp login revdoku. To remove the server and its saved sign-in, run claude mcp remove revdoku.

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 Claude Code makes in Revdoku. The edit waits for a person, becomes a commit, or Revdoku refuses it (Read-only).

Connectors that you add on claude.ai also show in Claude Code, for example claude.ai Revdoku. Claude Code loads them only when you sign in with a Claude subscription, not with an API key.

Claude Code has a shell, so it can also run the Revdoku CLI (a command-line program). The CLI uploads docs that do not come from GitHub, publishes a site and makes a preview. To install the skill for Claude Code in all your projects, run:

This install does not add revdoku to your PATH. Claude Code runs the bundled scripts/revdoku.sh from the skill folder, for example with preview --bucket-id bkt_... or publish --bucket-id bkt_.... The CLI page shows how an uploaded folder is named in the bucket. If you are not signed in, the CLI opens a browser sign-in. To run revdoku yourself, follow the CLI installation.

Claude Code reads CLAUDE.md or .claude/CLAUDE.md in your project at the start of each session. Put the rules for your docs there. This example uses a docs/ folder that Revdoku publishes from the main branch. Change the names to match your repository.

## Docs rules
- The docs are in docs/. Revdoku publishes them from the main branch.
- Pages are Markdown or MDX. Give each page a title and a description in its front matter.
- Add each new page to a group in docs/docs.json.
- The API reference comes from docs/openapi.json. Change an endpoint there, not in a page.
- Use only Mintlify components, such as Card, Tabs, Steps, CodeGroup and Accordion.
  Components do not run code. Other components show only their text.
- There is no local preview. Push a branch: Revdoku builds a preview site for 24 hours
  and links it on the commit.
- Do not push to main. Open a pull request.

CLAUDE.md guides what Claude Code tries to do. The permission rules decide what Claude Code allows.

Claude Code MCP documentation · Docs for AI agents · Revdoku MCP guide · Claude on the web and phone