Mintlify MCP server for AI agents and assistants

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with Mintlify MCP or direct API to trigger docs deployments, create previews, run documentation automations, and export analytics through natural language.

Mintlify logoMintlify
Api Key

Mintlify is a documentation platform for building, hosting, and maintaining modern product docs. It helps teams ship polished docs faster with previews, deployments, automation, and analytics.

14 Tools

Try Mintlify now

Type what you want done — sign in and watch it run live in the Tool Router playground.

TOOL ROUTER PLAYGROUND
Mintlify
Try asking
TOOLS

Supported Tools

Every Mintlify action and event your agent gets out of the box.

Create Agent Job

Start a background documentation agent job from a natural-language prompt.

Get Agent Job

Retrieve the status and details (status, PR link, model, source repo/ref) of a docs agent job.

Get Assistant Caller Stats

Get assistant query counts broken down by caller type (web, api, other, total) for a date range.

Get Assistant Conversations

Export the AI assistant conversation history (question, answer, cited sources, resolution status) for a Mintlify project, optionally filtered by date.

Get Feedback

Export a project's user feedback (thumbs / contextual comments / agent feedback), optionally filtered by date, source and status.

Get Feedback By Page

Get feedback counts (thumbs up/down, code, total) aggregated per documentation page path for a date range.

Get Page Views

Export per-path and site-wide content view counts split by human vs AI traffic.

Get Search Queries

Export documentation search terms ordered by hit count, with CTR and top clicked page.

Get Unique Visitors

Export per-path and site-wide approximate distinct visitor counts split by human vs AI traffic.

Get Update Status

Get the status and details (queued / in_progress / success / failure, logs, commit, screenshot) of a triggered deployment update by its statusId.

Send Agent Message

Send a follow-up instruction to an existing, in-progress docs agent job (asynchronous).

Trigger Automation

Trigger a custom-schedule automation (workflow) to run immediately.

Trigger Preview

Create or update a preview deployment of the docs project for a Git branch (redeploys if a preview already exists for that branch).

Trigger Update

Queue a production deployment of the docs project from its configured branch.

SETUP GUIDE

Connect Mintlify MCP Tool with your Agent

1

Install Composio

typescript
npm install @composio/core ai @ai-sdk/mcp @ai-sdk/openai
Install the Composio SDK and your agent framework
2

Create a session with MCP enabled

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

const composio = new Composio();
const { mcp } = await composio.create("your-user-id", {
  toolkits: ["mintlify"],
  mcp: true,
});
Create a session scoped to Mintlify and read its MCP URL and headers
3

Connect your agent to the MCP server

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: "Trigger a Mintlify preview deployment for the latest documentation changes",
  stopWhen: stepCountIs(10),
});

console.log(text);
await client.close();
Pass the session's MCP URL and headers to your agent and run a Mintlify request
SETUP GUIDE

Connect Mintlify API Tool with your Agent

1

Install Composio

typescript
npm install @composio/core @composio/openai openai
Install the Composio SDK, the OpenAI provider, and the OpenAI SDK
2

Create a Composio session

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"] });
const tools = await session.tools();
Initialize Composio with the OpenAI Responses provider and create a session scoped to Mintlify
3

Run Mintlify tools with your agent

typescript
let response = await client.responses.create({
  model: "gpt-5.6-sol",
  tools,
  input: [{ role: "user", content: "Trigger a Mintlify preview deployment for the latest documentation changes" }],
});

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);
Send a request, execute the Mintlify tool calls through the session, and print the final answer

Why Use Composio?

AI Native Mintlify Integration

  • Supports both Mintlify MCP and direct API based integrations
  • Structured, LLM-friendly schemas for reliable deployment, preview, automation, and analytics actions
  • Rich coverage for managing documentation workflows without writing bespoke Mintlify Admin API code

Managed Auth

  • Securely store and route Mintlify API keys without hard-coding secrets in your agent code
  • Use auth_configs.create(), connected_accounts.link(), and mcp.create() in lower-level setups when you need direct control
  • Manage Mintlify access per user and environment from one place

Agent Optimized Design

  • Mintlify tools are shaped so language models can pick the right action for docs deployments, previews, and analytics
  • Comprehensive execution logs help you see what the agent ran, when it ran, and which Mintlify workspace it touched

Enterprise Grade Security

  • Fine-grained RBAC so you control which agents and users can access Mintlify actions
  • Scoped, least privilege access for sensitive documentation operations
  • Full audit trail of agent-triggered Mintlify deployments, previews, automations, and exports
FRAMEWORKS

Use Mintlify with any AI Agent Framework

Choose a Framework you want to connect Mintlify with

Rolling this out across your team?

Give your team centralized access control across every framework with Composio’s MCP Gateway.

EXPLORE MCP GATEWAY
FAQ

Frequently asked questions

Start with Mintlify.It takes 30 seconds.

Managed auth, hosted MCP servers, and every Mintlify tool your agent needs.Free to start.

Start building