Authoring MCP Server

Connect AI tools to Documentation.AI for read/write documentation workflows, authoring, review, and deployment tasks.

Overview

Use the Authoring MCP Server to let an MCP-compatible AI client work directly in your documentation project. It provides read and write access for editing pages, updating documentation.json, managing branches, reviewing changes, and deploying through your normal documentation workflow.

The Authoring MCP Server and the Documentation.AI REST API cover largely the same documentation-management tasks, but they expose them through different interfaces. Choose the Authoring MCP Server when you want an MCP-compatible AI client or agent to do the work for you, and choose the REST API when you want direct HTTP access from your own scripts, services, or CI/CD. For endpoint details, see the API reference overview.

Use this server for authoring and documentation operations through an MCP client. If you need direct REST API access instead, use the Documentation.AI REST API. If your AI tool only needs read-only access to published content, use the Docs MCP Server.

This server uses your Documentation.AI account permissions and can modify live documentation. Connect it only to AI tools and workflows you trust, and use branches when you want review before deployment.

Setup and authentication

Connect your MCP client to the server URL, then sign in with OAuth 2.1 through your Documentation.AI account.

https://api.documentationai.app/mcp

Start the connection from your MCP client

Open your MCP-compatible client and add the Authoring MCP Server using the URL in the next section.

Your client discovers the OAuth endpoints and opens a browser window for authentication.

Approve access

After you approve the consent screen, the client receives tokens and completes the connection.

A successful connection shows the server as available in your MCP client.

No API keys or manual token management are required.

Configure your MCP client

Claude Desktop

Add this to your Claude Desktop MCP configuration, claude_desktop_config.json:

{
  "mcpServers": {
    "documentationai": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "https://api.documentationai.app/mcp",
        "--timeout",
        "120000"
      ]
    }
  }
}

Claude Code

Add the server from your terminal:

claude mcp add documentationai \
  --transport http \
  --url https://api.documentationai.app/mcp

Or add a .mcp.json file to your project root:

{
  "mcpServers": {
    "documentationai": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "https://api.documentationai.app/mcp",
        "--timeout",
        "120000"
      ]
    }
  }
}

Cursor

In Cursor settings, add a new MCP server:

Name: documentationai
Type: command
Command: npx mcp-remote https://api.documentationai.app/mcp --timeout 120000

Select a project

After authentication, select the documentation project you want to work on before using any documentation tools.

List available projects

Call list_projects to see every organization and documentation project your account can access.

Set the active project

Call select_project with the organization and documentation IDs returned by list_projects.

Run read or write operations

Once a project is selected, use the tools below to inspect files, update content, manage branches, and deploy changes.

A successful selection makes the current project available for subsequent tool calls in the same session.

You can switch projects at any time by calling select_project again.

Tools and capabilities

The server exposes project selection, read, and write tools for repository workflows.

Project selection

These tools are available immediately after authentication.

Lists all organizations and documentation projects you have access to, along with your role in each.

Parameters: None

Returns: A list of organizations, each containing their documentation projects and your role, such as admin, editor, or viewer.

Sets the active organization and documentation project for the current session.

organizationIdstring

Required

Organization ID from list_projects

documentationIdstring

Required

Documentation ID from list_projects

Read tools

Available to all roles, including viewer, editor, and admin. Use these when your workflow needs repository context, source files, or project configuration.

Returns the complete documentation.json, including navigation, branding, SEO, and integrations.

branchstring

Branch name. Defaults to the deployment branch.

Lists all files in the documentation repository with their paths and sizes.

branchstring

Branch name. Defaults to the deployment branch.

Returns the full content of a documentation page.

pathstring

Required

File path relative to repository root, for example getting-started/introduction.mdx

branchstring

Branch name. Defaults to the deployment branch.

Performs a hybrid search that combines semantic understanding and keyword matching.

querystring

Required

Search query

limitinteger

Maximum results from 1 to 50. Defaults to 10.

Write tools

Require editor or admin role. These tools make the Authoring MCP Server the right choice for authoring, automation, and deployment workflows.

Creates, updates, or deletes documentation files in a single Git commit. Supports up to 20 operations per request.

operationsarray

Required

Array of file operations. Each operation includes type, path, and content. content is required for create and update operations.

commitMessagestring

Required

Git commit message with a maximum length of 500 characters

branchstring

Target branch. Defaults to the deployment branch.

Creates a new Git branch.

branchNamestring

Required

Name for the new branch

sourceBranchstring

Branch to create from. Defaults to the deployment branch.

Lists all branches in the repository.

Parameters: None

Deletes a branch. The deployment branch cannot be deleted.

branchNamestring

Required

Branch name to delete

Merges one branch into another. Merging into the deployment branch triggers a live deployment.

basestring

Required

Target branch to merge into

headstring

Required

Source branch to merge from

commitMessagestring

Merge commit message

Lists pull requests in the repository.

statestring

Filter by state: open, closed, or all. Defaults to open.

Resources

The MCP server also exposes reference resources for automation and authoring workflows:

Resource	URI	Description
Components Reference	`docs://components`	All available MDX components with props and usage examples
Config Schema	`docs://config-schema`	Complete `documentation.json` schema reference
Project Config	`docs://project/config`	The current project's `documentation.json`

Role-based access

Your access level is determined by your role in the selected organization.

Role	Permissions
Viewer	Read tools only: `get_site_config`, `list_pages`, `get_page`, `search_documentation`
Editor	Read and write tools, including `update_documentation`, branch operations, merges, and pull requests
Admin	All tools

If your team wants an AI client to read documentation without any ability to change it, use the Docs MCP Server instead.

Docs MCP Server

MCP overview

Was this page helpful?

Last updated 1 day ago

Built with Documentation.AI