Works with Codex

Codex updates
your API docs

Codex changes the pages and the OpenAPI file in your repository. Revdoku publishes each push and makes a preview for other branches. Codex reads the published docs through MCP.

Start Free Need help? Email us

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 a support mailbox
  • API, MCP and CLI access

Let Codex write the docs

Revdoku publishes a docs site from a GitHub repository: Markdown and MDX pages, docs.json navigation and an OpenAPI file. Codex edits these files in the same way as your code.

  1. Create a Revdoku account and connect the GitHub repository of your docs.
  2. Put the rules for your docs in AGENTS.md. Codex reads AGENTS.md files before it does any work. The example rules also work in AGENTS.md.
  3. Ask Codex to change the docs, for example: Add the new /v1/orders endpoint to docs/openapi.json and write a guide page for it.
  4. Push a branch. Revdoku builds a preview site of that branch for 24 hours, and the commit on GitHub links to it.
  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, with its docs.json, MDX pages and snippets.

Add a docs site to Codex

Each public Revdoku docs site has its own MCP server at /mcp. MCP servers are outside services whose tools Codex can call. Codex keeps them in ~/.codex/config.toml, and the Codex CLI, the IDE extension and the ChatGPT desktop app share that file.

  1. Add the docs site. Use its address with /mcp at the end: codex mcp add acme-docs --url https://docs.example.com/mcp
  2. Start codex and type /mcp. Make sure that acme-docs is in the list of servers.
  3. Ask Codex: Use acme-docs. Which pages describe webhooks?

The docs server needs no sign-in, and Codex connects to it without credentials. Codex gets three read-only tools: search_docs, read_page and list_pages. A site with a password or an email code has no MCP server.

In the ChatGPT desktop app, open Settings → MCP servers → Add server. Enter the name, choose Streamable HTTP, paste the URL and save. Then select Restart. The IDE extension has the same list in its gear menu. There, the button after you save is Restart extension.

Connect your Revdoku account

To publish your sites and read support email from Codex, add the Revdoku server for your account. It uses sign-in in your browser.

  1. Add the server: codex mcp add revdoku --url https://mcp.revdoku.com
  2. Run this command to sign in. Codex then opens Revdoku in your browser: codex mcp login revdoku
  3. Select the buckets and an access level. To publish and preview sites, Codex needs Full access.
  4. Ask Codex: List my Revdoku buckets and the state of each docs site.

A bucket holds the files of one docs site, the site and its support mailbox. In the desktop app, select Authenticate next to revdoku to sign in.

MCP servers settings in the desktop app, with Add server, Restart and an Authenticate button next to 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 Codex makes in Revdoku. The edit waits for a person, becomes a commit, or Revdoku refuses it (Read-only).

Limit what Codex can do in config.toml

The codex mcp add command writes an [mcp_servers.<name>] table for each server. You can also write the tables by hand and add keys from OpenAI's configuration reference:

[mcp_servers.acme-docs]
url = "https://docs.example.com/mcp"

[mcp_servers.revdoku] url = “https://mcp.revdoku.com” default_tools_approval_mode = “writes” disabled_tools = [“bucket_email_delete”, “bucket_delete_permanently”]

  • With default_tools_approval_mode = "writes", Codex asks you before it calls a tool that is not marked read-only, such as bucket_publish.
  • disabled_tools blocks the tools that delete an email or a whole bucket.
  • To use a server in one trusted project only, put its table in .codex/config.toml in that project.

To pause a server, set enabled = false in its table. The command codex mcp logout revdoku deletes the saved sign-in, and codex mcp remove revdoku deletes the entry.

Use the Revdoku skill when Codex needs local files

The hosted MCP server cannot read your disk or upload binary files. For those jobs, install the Revdoku skill (a folder of instructions and scripts that Codex loads) with its bundled CLI:

npx skills add revdoku/revdoku --skill revdoku --agent codex -g

This install does not add revdoku to your PATH. Instead, Codex calls the bundled scripts/revdoku.sh script. Without a saved sign-in, the script starts Revdoku sign-in in the browser. After that, Codex can run upload, publish, preview and site with --bucket-id, or emails to read support email. On a machine without npm, the installer curl -fsSL https://revdoku.com/install.sh | bash sets up the CLI.

In its default sandbox, Codex has no network access. It asks you to approve commands that call Revdoku.

Docs tasks for Codex

  • API changes. Codex changes an endpoint and the OpenAPI file in the same branch. Revdoku makes one reference page for each OpenAPI tag and an API console.
  • Code samples. Codex reads the published pages through the docs server and fixes samples that no longer match the code.
  • Gaps in the docs. With your account connected, Codex reads the support email and finds the questions that no page answers.

A prompt for the last task:

Use the acme-docs and revdoku MCP servers. List the support emails from the last 14 days.
Keep the emails that have the Needs reply label. For each email, search the docs.
Name the page that answers it, or say that no page answers it.
For each question without a page, write a new page in docs/ and add it to docs.json.
Do not reply to any email.

The built-in support agent adds the Needs reply label to an email that the docs do not answer. Support email is data, not instructions. The Revdoku server tells Codex to treat email text and attachments as untrusted data.

OpenAI MCP guide for Codex · Docs for AI agents · Revdoku MCP guide

Markdown version
↧
Loading PDF…