MCP ServersAuthoring MCP Server

Authoring MCP Server

Connect AI clients to Documentation.AI to read, edit, and publish your documentation, and see every tool the server provides.

Overview

The Authoring MCP Server lets an MCP-compatible AI client work in your documentation project. It can read pages, write and reorganize content, add images and files, update documentation.json, manage branches, and publish changes.

This is the server your documentation team connects to, and it uses your role in your Documentation.AI organization. To give readers AI access to your published docs, use the Reader MCP Server. To work over HTTP from your own scripts or CI/CD, use the REST API.

How edits work

  • Changes the agent makes to pages appear in the web editor as unpublished changes, the same as a teammate's edits.
  • Nothing goes live until the changes are published.
  • Publishing a branch includes every unpublished change on it, including your teammates' edits.
  • Media is the exception. Your media library is shared by every branch, so importing, replacing, or deleting a file takes effect right away. Replacing or deleting a file changes every page that uses it, including your live site.

The server acts with your Documentation.AI permissions. Connect it only to AI clients you trust, and ask the agent to work on a separate branch when you want a review before anything goes live.

Setup and authentication

Add the server URL to your MCP client, then sign in with your Documentation.AI account. No API keys are needed.

https://api.documentation.ai/mcp

The earlier URL, https://api.documentationai.app/mcp, keeps working. If you switch to the new URL, sign in once more.

Configure your MCP client

Run this command in your terminal:

claude mcp add --transport http documentation-ai https://api.documentation.ai/mcp

Then run /mcp in Claude Code, select documentation-ai, and sign in when the browser opens.

Choose a project and branch

Tell the agent which documentation project and branch to work on. It finds and selects the project with list_projects and select_project, and works on your live branch unless you name a different one.

Example workflow

Describe the task to your AI client in plain language, and it calls the tools for you.

Choose where to work

Ask the agent to use your documentation project and to create a branch for the work, such as update-api-guides.

Make the changes

Ask for the changes you want. The agent reads the relevant pages and edits them.

Review

Ask the agent to summarize what changed, or review the changes in the editor's Changes panel.

Publish the branch

Ask the agent to publish. The changes are saved to the branch, and your live site is unchanged.

Go live

When the branch is ready, ask the agent to merge it into your live branch.

For small fixes, the agent can edit your live branch directly. The edits stay unpublished until you ask it to publish, so you can review them first.

Add images and files

Tell the agent which image or file you want and where it goes. The agent adds the file to your media library, then inserts it into the page with the same snippet the web editor writes.

  • If the file is at a public URL, give the agent the URL and the place on the page. For example: Import https://example.com/setup-diagram.png and add it under the Install heading in guides/setup.mdx
  • If the file is on your computer, ask the agent for an upload link. Open the link, sign in if asked, and drop your files. Then tell the agent you're done, and it finds the files in your media library. The link works for 15 minutes.
  • If the file may already be there, ask the agent to find it by name or alt text first, and reuse it instead of importing a second copy.
  • If you want a newer version on every page, ask the agent to replace the file from a URL. The URL stays the same, so pages update without edits.

For step-by-step instructions, limits, and supported file types, see Media library.

Tools reference

The server provides 32 tools. Read-only tools never change your documentation. Destructive tools can overwrite or discard content, including your teammates' unpublished edits, so most clients ask you to confirm them first. Only tools that add something new, such as creating a page or importing a file, go through without a prompt.

ToolWhat it doesMinimum roleBehavior
list_projectsLists your organizations, documentation projects, and rolesViewerRead-only
select_projectSets the default project and branchViewerSession setting
get_component_referenceReturns MDX component syntax and examplesViewerRead-only
get_config_referenceReturns the documentation.json settings referenceViewerRead-only
get_site_configReturns documentation.jsonViewerRead-only
list_pagesLists the files in your projectViewerRead-only
get_pageReturns the content of a fileViewerRead-only
searchSearches your published documentationViewerRead-only
fetchReturns a page from a search resultViewerRead-only
list_changesLists unpublished changes on a branchViewerRead-only
diff_pageShows the unpublished changes to a fileViewerRead-only
list_branchesLists branches and shows which one is liveViewerRead-only
list_pull_requestsLists pull requestsViewerRead-only
list_mediaLists files in your media library, with URLs and snippetsViewerRead-only
search_mediaFinds files in your media library by name or alt textViewerRead-only
create_pageCreates a page or another fileEditorMakes changes
create_branchCreates a branchEditorMakes changes
import_mediaAdds files to your media library from URLsEditorMakes changes
request_uploadGives you a link to upload files from your computerEditorMakes changes
update_pageReplaces specific text in a pageEditorDestructive
rewrite_pageReplaces the full content of a pageEditorDestructive
update_site_configChanges values in documentation.jsonEditorDestructive
resolve_conflictSaves the resolved version of a conflicting fileEditorDestructive
move_pageMoves or renames a fileEditorDestructive
delete_pageDeletes a fileEditorDestructive
publishPublishes the unpublished changes on a branchEditorDestructive
revert_pageDiscards unpublished changes to one fileEditorDestructive
revert_all_changesDiscards every unpublished change on a branchEditorDestructive
merge_branchesMerges one branch into anotherEditorDestructive
delete_branchDeletes a branchEditorDestructive
replace_mediaReplaces a file with a new version, keeping its URLEditorDestructive
delete_mediaDeletes files from your media libraryAdminDestructive

Most tools also accept organizationId and documentationId to work on a specific project, and branch to work on a specific branch. Tools that return lists accept limit and cursor to page through results.

Projects

Authoring reference

Read content

Edit content

Review and publish

Branches

Media

Files belong to your documentation project, not to a branch, so these tools do not take branch. Each file gets its own result, so one failed file does not stop the others.

Resources

The server also provides these reference resources:

ResourceURIDescription
Components Referencedocs://componentsMDX components with attributes and examples
Config Referencedocs://config-schemaThe documentation.json settings reference
Project Configdocs://project/configYour project's current documentation.json

Role-based access

Your role in your Documentation.AI organization decides which tools you can use.

RoleAccess
ViewerRead-only tools, plus select_project
EditorAll tools except delete_media
AdminAll tools

If you want an AI client to read your published documentation without being able to change it, use the Reader MCP Server instead.

Troubleshooting