# Mintlify MCP

```json
{
  "name": "Mintlify MCP",
  "slug": "mintlify_mcp",
  "url": "https://composio.dev/toolkits/mintlify_mcp",
  "markdown_url": "https://composio.dev/toolkits/mintlify_mcp.md",
  "logo_url": "https://logos.composio.dev/api/mintlify_mcp",
  "categories": [
    "document & file management"
  ],
  "is_composio_managed": false,
  "updated_at": "2026-09-24T15:33:43.437Z"
}
```

![Mintlify MCP logo](https://logos.composio.dev/api/mintlify_mcp)

## Description

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with Mintlify MCP or direct API to search docs, retrieve pages, extract code examples, and summarize sections through natural language.

## Summary

Mintlify MCP is a documentation platform for projects and developer docs.
Access and search your project docs with fast, contextual results.

## Categories

- document & file management

## Toolkit Details

- Tools: 19

## Images

- Logo: https://logos.composio.dev/api/mintlify_mcp

## Authentication

- **Dcr Oauth**
  - Type: `custom`
  - Description: Dcr Oauth authentication for Mintlify MCP.
  - Setup:
    - Configure Dcr Oauth credentials for Mintlify MCP.
    - Use the credentials when creating an auth config in Composio.

## Suggested Prompts

- Search docs for API rate limits
- Find authentication code examples in docs
- List pages referencing onboarding developer guide

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `MINTLIFY_MCP_CHECKOUT` | Checkout | Select a deployment and open its editor session in one call. This is an org-wide connection, so `subdomain` is required to choose which deployment to open. Subsequent editor tools act on the active session. Required before editor branch tools; deployment-level operations (workflows, deployment, members, billing, integrations, analytics) are reached via `execute_code` and do not require checkout. Calling checkout on another subdomain switches the active session without losing the others; re-checking-out an already-open deployment just re-activates it. Pass `branch` to work on a specific branch — if it already exists in git, the session attaches to it as-is; if not, it is created from `from` (defaults to the deploy branch). Omit `branch` to auto-generate a fresh `admin-mcp/-` branch from `from` (uses `slug` when provided, otherwise the session id); if that branch already exists (e.g. a retried task) the session resumes it. Returns `{ branchName, sessionId, baseBranch, baseSha, created, note?, editorUrl, toolkit }`. `toolkit` groups the tools you should load next (`explore`, `editContent`, `editNavigation`, `editConfig`, `codemode`, `ship`) so you can call them without further discovery. Surface `editorUrl` to the user so they can follow along in the dashboard editor as the agent works. |
| `MINTLIFY_MCP_CREATE_NODE` | Create node | Insert a node into the navigation tree under `parentId` (null = root). `order` is clamped into siblings and defaults to append. `data` is discriminated by `type`: `page` seeds a Y.Doc from `{ path, content }` (MDX is validated), while `group`, `tab`, `anchor`, `version`, `language`, and `product` take their own name-shaped fields. Parent/child compatibility is enforced against an allowed-children table (e.g. groups cannot contain tabs; pages have no children). |
| `MINTLIFY_MCP_DELETE_NODE` | Delete node | Remove a node and its subtree from the navigation tree by `nodeId`. For pages in the removed set, the hocuspocus room, document S3 blob, and baseline (Redis + S3) are cleaned up. To add a redirect for a removed page, use `update_config` with `add_redirect`. Returns `{ deletedNodeIds }`. |
| `MINTLIFY_MCP_DIFF` | Diff | Returns the list of changes between current session and main. |
| `MINTLIFY_MCP_DISCARD_SESSION` | Discard session | End the session without creating a PR |
| `MINTLIFY_MCP_EDIT_PAGE` | Edit page | String-replace edit on a page Y.Doc body. Use this for MDX content edits only — do NOT use it to change frontmatter fields (`title`, `sidebarTitle`, `description`, `icon`, `tag`, `canonical`, `og:*`, `keywords`, `noindex`, `hidden`, etc.); those round-trip through structured node metadata and must be set via `update_node` with `data.type='page'`. For the site-level `description` in `docs.json`, use `update_config`. Edits are broadcast live to connected collaborators: plain inline-text edits inside a single paragraph stream character-by-character (typing effect); structural edits apply atomically. The returned `mode` reports which path ran (`inline-stream` or `rebuild`). |
| `MINTLIFY_MCP_EXECUTE_CODE` | Execute code | Run TypeScript/JavaScript against the Admin MCP dashboard SDK inside a sandboxed Cloudflare isolate. The script body has access to top-level namespace proxies (workflows, deployment, members, billing, integrations, analytics, deployments) plus console. No outbound fetch, no bindings, no secrets. The OAuth scopes on the calling token gate each individual SDK call through the gateway. **Targeting deployments**: every namespace method takes an optional second argument `{ subdomain }` to target a specific deployment in the org — e.g. `workflows.listWorkflows({}, { subdomain: 'acme' })`; omit it to use the token's default deployment. You can target different deployments in a single run. `deployments.list()` enumerates the org's deployments (org-wide; requires the `deployment:read` scope) and returns `{ deployments: [{ _id, subdomain }, ...] }`. **Return semantics**: the script is wrapped in an async function and the value of the LAST expression statement becomes the result — `await workflows.listWorkflows();` on its own line works, but a bare `return X;` at top level is dropped (no enclosing function), and `export default async function() { return X; }` returns the function object, not `X`. To return a structured value either end with an expression (`({ a, b });` or just `x`) or assign to a variable and reference it on the last line. Returns a tagged-union envelope: { ok: true, result, logs, truncated, durationMs } \| { ok: false, error: { code, message }, logs, truncated, durationMs }. `truncated: true` signals the result or logs hit the size cap. Error codes: unauthorized, invalid_json, invalid_request, misconfigured, timeout (30s wall-clock), sandbox_error (anything thrown inside the script), execution_failed (worker plumbing failure). |
| `MINTLIFY_MCP_GET_SESSION_STATE` | Get session state | Get current session state including branch name, edited files, and nav diff |
| `MINTLIFY_MCP_LIST_BRANCHES` | List branches | List all git branches available for a deployment before or after checkout. Pass `subdomain` to target a deployment; it defaults to the active session and is required before checkout on this org-wide connection. Optionally filter with `query` to only return matching branch names. Returns `{ branches, total, deployBranch }`. |
| `MINTLIFY_MCP_LIST_DEPLOYMENTS` | List deployments | List the deployments this connection is authorized for, returning each `{ subdomain, name }`. On an org-wide connection this is every main (non-preview) deployment in your organization; on a connection scoped to specific deployments it returns only those. Use this to discover which subdomain to `checkout` before editing. Hidden when the connection is pinned to a single deployment. |
| `MINTLIFY_MCP_LIST_NODES` | List nodes | List navigation nodes with optional filters over the current branch nav tree. `parentId: null` returns root-level nodes; a string returns direct children of that node; omit for no filter. `recursive: true` extends the parent filter to all descendants of `parentId` — pair with `parentId: null` (or omit) to dump the entire tree in a single call. `type` accepts a single type or array (e.g. "group"). `language`, `version`, and `tab` are scope filters: a node passes only if its ancestor chain (including itself) contains a matching division node — filtering by a value not present in the tree returns empty. `limit` defaults to 500 (max 500). `cursor` is an opaque pagination token returned as `nextCursor`, stable across inserts. Returns { nodes, nextCursor } where nextCursor is null when exhausted. |
| `MINTLIFY_MCP_MOVE_NODE` | Move node | Reposition a node in the navigation tree by nodeId. `parentId: null` moves to root; omit to keep the current parent. `order` is 0-based among the new siblings; omit to append. At least one of `parentId` or `order` is required. Parent/child compatibility is enforced against the allowed-children table. Cross-boundary moves (across version, tab, language, or product ancestors) are allowed; the response flags them via `crossedBoundary`. |
| `MINTLIFY_MCP_READ` | Read | Read the full MDX content of a single page on the current branch. Reflects in-session edits made via edit_page/write_page, not just the published version. `path` is the page href (e.g. "/quickstart" or "guides/setup"), with or without a leading slash or trailing .mdx. Returns `{ content, filePath }` on success, or `{ error: "read_failed", reason }` on failure (`reason` carries the human-readable diagnostic such as "No valid pageId found for page" or a hocuspocus connection error). |
| `MINTLIFY_MCP_SAVE` | Save | Flush branch to git. With mode="auto" (default) opens a PR if none exists, otherwise commits to the existing PR branch; it only auto-merges when this deployment's agent review setting is push-to-main. With mode="pr" opens a PR if none exists, otherwise commits to the existing PR branch, and never auto-merges. With mode="commit" commits directly to the branch without opening a PR. |
| `MINTLIFY_MCP_SEARCH` | Search | Find lines matching a substring or regex across every page on the current branch. Returns { matches, truncated } where each match is { path, lineNumber, line }, sorted by path. Reflects in-session edits: pages edited in this session are scanned even before indexing catches up. `query` is treated as a literal fixed string by default; pass `regex: true` for regex syntax. `caseSensitive` defaults to false. `limit` caps results (default 100, max 500). The response is bounded to 30KB — `truncated: true` indicates results were dropped and you should refine the query. |
| `MINTLIFY_MCP_SEARCH_CODE_OPERATIONS` | Search code operations | Lexical (BM25) search over the Admin MCP code-mode SDK. Use this to find the right SDK method for a task before writing an `execute_code` script. `query` is matched against method names, namespaces, parameter names, and JSDoc descriptions (camelCase tokens like `createWorkflow` are split, so `create workflow` also matches). Pass `namespace` (one of workflows, deployment, members, billing, integrations, analytics) to scope results to a single namespace — this also enumerates that namespace (every method in it, best query matches first), e.g. to confirm whether a getter exists. Returns up to `limit` hits (default 5, max 20), each `{ operationId, namespace, method, requiredScope, description, inputSchema, score }`. `inputSchema` is the full JSON Schema for the method’s parameters — no extra lookup needed before calling `execute_code`. Returns `{ hits: [] }` when nothing matches. |
| `MINTLIFY_MCP_UPDATE_CONFIG` | Update config | Update any top-level `docs.json` field except `navigation` (use the navigation tree tools for that). This is the ONLY way to change the site-level `description` (the SEO/social description for the whole docs site) — do not use `edit_page` (which targets page body) or `update_node` (which targets a single page's frontmatter description). `op` selects the operation: `set` ({ docsConfig }) shallow-merges any partial `docs.json` (e.g. `{ theme, name, description, colors, logo, favicon, api, appearance, background, navbar, footer, fonts, search, contextual, banner, interaction, errors, seo, styling, integrations, metadata, ... }` — see https://www.mintlify.com/docs.json); `add_redirect` ({ redirect: { source, destination, permanent? } }) appends to `redirects` (rejects on duplicate source); `remove_redirect` ({ source }) removes by source (rejects if missing). `set` rejects `navigation` and `$schema` keys. Set a top-level key to `null` in `docsConfig` to unset (remove) it entirely. The merged config is validated against the @mintlify/validation schema — any violation rejects the call with no partial writes. Returns `{ diff }` of only the changed fields: array-valued fields (e.g. `redirects`, `navbar.links`) report `{ added, removed }`, nested objects recurse under `{ changed }`, and scalar leaves report `{ before, after }`. |
| `MINTLIFY_MCP_UPDATE_NODE` | Update node | Update a navigation node's properties in place by nodeId — no repositioning. `data` is a discriminated union on `type` carrying partial, type-specific fields that are merged into existing `node.data`. For `type:'page'`, this is the correct tool for editing the page's frontmatter (`title`, `sidebarTitle`, `description`, `icon`, `tag`, `canonical`, `og:title`, `og:url`, `keywords`, `noindex`, `hidden`, `deprecated`, etc.) — the merged fields are serialized back into the MDX `---` block on save; do not use `edit_page` for these. `data.type` must match the stored node type. Immutable fields (`href`/`pageId` on pages, internal flags) are rejected — use `move_node` to rename a page path. Page updates emit an `update` pending action with source `metadata`; structural node updates emit an `update-navigation` action. Emits `editor_nav_updated`. Examples: set a page's frontmatter description (`{type:'page', description:'…'}`), rename a group (`{type:'group', group:'New Name'}`), change a tab icon, set a version as default. |
| `MINTLIFY_MCP_WRITE_PAGE` | Write page | Full overwrite of a page Y.Doc content |

## Supported Triggers

None listed.

## Installation and MCP Setup

### Path 1: SDK Installation

#### Path 1, Step 1: Install Composio

Install the Composio SDK, the OpenAI provider, and the OpenAI SDK
```python
pip install composio composio_openai openai
```

```typescript
npm install @composio/core @composio/openai openai
```

#### Path 1, Step 2: Create a Composio session

Initialize Composio with the OpenAI Responses provider and create a session scoped to Mintlify MCP
```python
import json
from openai import OpenAI
from composio import Composio
from composio_openai import OpenAIResponsesProvider

composio = Composio(provider=OpenAIResponsesProvider())
client = OpenAI()

session = composio.create(user_id="your-user-id", toolkits=["mintlify_mcp"])
tools = session.tools()
```

```typescript
import OpenAI from "openai";
import { Composio } from "@composio/core";
import { OpenAIResponsesProvider } from "@composio/openai";

const composio = new Composio({ provider: new OpenAIResponsesProvider() });
const client = new OpenAI();

const session = await composio.create("your-user-id", { toolkits: ["mintlify_mcp"] });
const tools = await session.tools();
```

#### Path 1, Step 3: Run Mintlify MCP tools with your agent

Send a request, execute the Mintlify MCP tool calls through the session, and print the final answer
```python
response = client.responses.create(
    model="gpt-5.6-sol",
    tools=tools,
    input=[{"role": "user", "content": "Search docs for API rate limits"}],
)

while True:
    tool_calls = [o for o in response.output if o.type == "function_call"]
    if not tool_calls:
        break
    results = composio.provider.handle_tool_calls(response=response, session=session)
    response = client.responses.create(
        model="gpt-5.6-sol",
        tools=tools,
        previous_response_id=response.id,
        input=[
            {"type": "function_call_output", "call_id": call.call_id, "output": json.dumps(results[i])}
            for i, call in enumerate(tool_calls)
        ],
    )

print(response.output_text)
```

```typescript
let response = await client.responses.create({
  model: "gpt-5.6-sol",
  tools,
  input: [{ role: "user", content: "Search docs for API rate limits" }],
});

while (response.output.some((o) => o.type === "function_call")) {
  const outputs = await composio.provider.handleToolCalls(session, response.output);
  response = await client.responses.create({
    model: "gpt-5.6-sol",
    tools,
    previous_response_id: response.id,
    input: outputs,
  });
}

console.log(response.output_text);
```

### Path 2: MCP Server Setup

#### Path 2, Step 1: Install Composio

Install the Composio SDK and your agent framework
```python
pip install composio claude-agent-sdk
```

```typescript
npm install @composio/core ai @ai-sdk/mcp @ai-sdk/openai
```

#### Path 2, Step 2: Create a session with MCP enabled

Create a session scoped to Mintlify MCP and read its MCP URL and headers
```python
from composio import Composio

composio = Composio()
session = composio.create(user_id="your-user-id", toolkits=["mintlify_mcp"], mcp=True)
```

```typescript
import { Composio } from "@composio/core";

const composio = new Composio();
const { mcp } = await composio.create("your-user-id", {
  toolkits: ["mintlify_mcp"],
  mcp: true,
});
```

#### Path 2, Step 3: Connect your agent to the MCP server

Pass the session's MCP URL and headers to your agent and run a Mintlify MCP request
```python
import asyncio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions, AssistantMessage, TextBlock

options = ClaudeAgentOptions(
    mcp_servers={
        "composio": {
            "type": "http",
            "url": session.mcp.url,
            "headers": session.mcp.headers,
        }
    },
    system_prompt="You are a helpful assistant with access to Mintlify MCP tools.",
    tools=[],
    allowed_tools=["mcp__composio__*"],
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query("Search docs for API rate limits")
        async for message in client.receive_response():
            if isinstance(message, AssistantMessage):
                for block in message.content:
                    if isinstance(block, TextBlock):
                        print(block.text)

asyncio.run(main())
```

```typescript
import { createMCPClient } from "@ai-sdk/mcp";
import { openai } from "@ai-sdk/openai";
import { generateText, stepCountIs } from "ai";

const client = await createMCPClient({
  transport: { type: "http", url: mcp.url, headers: mcp.headers },
});

const { text } = await generateText({
  model: openai("gpt-5.6-sol"),
  tools: await client.tools(),
  prompt: "Search docs for API rate limits",
  stopWhen: stepCountIs(10),
});

console.log(text);
await client.close();
```

## Why Use Composio?

### 1. AI Native Mintlify MCP Integration

- Supports both Mintlify MCP and direct API based integrations
- Structured, LLM-friendly schemas for reliable tool execution
- Rich coverage for reading, writing, and querying your Mintlify MCP data

### 2. Managed Auth

- Built-in OAuth handling with automatic token refresh and rotation
- Central place to manage, scope, and revoke Mintlify MCP access
- Per user and per environment credentials instead of hard-coded keys

### 3. Agent Optimized Design

- Tools are tuned using real error and success rates to improve reliability over time
- Comprehensive execution logs so you always know what ran, when, and on whose behalf

### 4. Enterprise Grade Security

- Fine-grained RBAC so you control which agents and users can access Mintlify MCP
- Scoped, least privilege access to Mintlify MCP resources
- Full audit trail of agent actions to support review and compliance

## Use Mintlify MCP with any AI Agent Framework

Choose a framework you want to connect Mintlify MCP with:

- [ChatGPT](https://composio.dev/toolkits/mintlify_mcp/framework/chatgpt)
- [Claude Cowork](https://composio.dev/toolkits/mintlify_mcp/framework/claude-cowork)
- [Hermes](https://composio.dev/toolkits/mintlify_mcp/framework/hermes-agent)
- [Atomic Agent](https://composio.dev/toolkits/mintlify_mcp/framework/atomic-agent)

## Related Toolkits

- [Google Drive](https://composio.dev/toolkits/googledrive) - Google Drive is a cloud storage platform for uploading, sharing, and collaborating on files. It's perfect for keeping your documents accessible and organized across devices.
- [Google Docs](https://composio.dev/toolkits/googledocs) - Google Docs is a cloud-based word processor that enables document creation and real-time collaboration. Its seamless sharing and version history make team editing and content management a breeze.
- [Google Super](https://composio.dev/toolkits/googlesuper) - Google Super is an all-in-one suite combining Gmail, Drive, Calendar, Sheets, Analytics, and more. It gives you a unified platform to manage your digital life, boosting productivity and organization.
- [ActiveMerge](https://composio.dev/toolkits/active_merge) - ActiveMerge is a document automation platform for generating documents, images, merged files, and e-signature workflows. It helps teams turn templates and stored files into finished, shareable documents faster.
- [Affinda](https://composio.dev/toolkits/affinda) - Affinda is an AI-powered document processing platform that automates data extraction from resumes, invoices, and more. It streamlines document-heavy workflows by turning files into structured, actionable data.
- [Agility cms](https://composio.dev/toolkits/agility_cms) - Agility CMS is a headless content management system for building and managing digital experiences across platforms. It lets teams update content quickly and deliver omnichannel experiences with ease.
- [Airparser](https://composio.dev/toolkits/airparser) - Airparser is an AI-powered parser for extracting structured data from emails, documents, PDFs, and files. It turns messy inbound content into clean fields your apps and workflows can use.
- [Algodocs](https://composio.dev/toolkits/algodocs) - Algodocs is an AI-powered platform that automates data extraction from business documents. It delivers fast, secure, and accurate processing without templates or manual training.
- [Api2pdf](https://composio.dev/toolkits/api2pdf) - Api2Pdf is a REST API for generating PDFs from HTML, URLs, and documents using powerful engines like wkhtmltopdf and Headless Chrome. It streamlines document conversion and automation for developers and businesses.
- [Archive.org](https://composio.dev/toolkits/archive_org) - Archive.org is the Internet Archive's digital library of websites, books, audio, video, and images. Use it to preserve, explore, and access historical web captures and public-domain media.
- [Aryn](https://composio.dev/toolkits/aryn) - Aryn is an AI-powered platform for parsing, extracting, and analyzing data from unstructured documents. Use it to automate document processing and unlock actionable insights from your files.
- [Boldsign](https://composio.dev/toolkits/boldsign) - Boldsign is a digital eSignature platform for sending, signing, and tracking documents online. Organizations use it to automate agreements and manage legally binding workflows efficiently.
- [Boloforms](https://composio.dev/toolkits/boloforms) - BoloForms is an eSignature platform built for small businesses, offering unlimited signatures, templates, and forms. It simplifies digital document signing and team collaboration at a predictable, fixed price.
- [Box](https://composio.dev/toolkits/box) - Box is a cloud content management and file sharing platform for businesses. It helps teams securely store, organize, and collaborate on files from anywhere.
- [Box MCP](https://composio.dev/toolkits/box_mcp) - Box MCP is Box's hosted MCP server that exposes enterprise files, folders, and metadata. It provides secure, centralized access to corporate content for search and management.
- [Carbone](https://composio.dev/toolkits/carbone) - Carbone is a blazing-fast report generator that turns JSON data into PDFs, Word docs, spreadsheets, and more using flexible templates. It lets you automate document creation at scale with minimal code.
- [Castingwords](https://composio.dev/toolkits/castingwords) - CastingWords is a transcription service specializing in human-powered, accurate transcripts via a simple API. Get seamless audio-to-text conversion for interviews, meetings, podcasts, and more.
- [CertSeal](https://composio.dev/toolkits/cert_seal) - CertSeal is an API platform for issuing and managing verifiable digital certificates. Use it to automate trusted certificate workflows for recipients, batches, designs, and webhooks.
- [Cloudconvert](https://composio.dev/toolkits/cloudconvert) - CloudConvert is a powerful file conversion service supporting over 200 file formats. It streamlines converting, compressing, and managing documents, media, and more, all in one place.
- [Cloudlayer](https://composio.dev/toolkits/cloudlayer) - Cloudlayer is a document and asset generation service for creating PDFs and images via API or SDKs. It lets you automate high-quality doc creation, saving dev time and reducing manual work.

## Frequently Asked Questions

### Do I need my own developer credentials to use Mintlify MCP with Composio?

Yes, Mintlify MCP requires you to configure your own Dcr Oauth credentials. Once set up, Composio handles secure credential storage and management for you.

### Can I use multiple toolkits together?

Yes! Composio's Tool Router enables agents to use multiple toolkits. [Learn more](https://docs.composio.dev/tool-router/overview).

### Is Composio secure?

Composio is SOC 2 and ISO 27001 compliant with all data encrypted in transit and at rest. [Learn more](https://trust.composio.dev).

### What if the API changes?

Composio maintains and updates all toolkit integrations automatically, so your agents always work with the latest API versions.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)