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

Yes, Mintlify requires you to configure your own API key credentials. Once set up, Composio handles secure credential storage and API request handling for you.

Yes! Composio's Tool Router enables agents to use multiple toolkits. Learn more.

Yes. Composio is SOC 2 Type II compliant and is built to keep your Mintlify connection and credentials secure. OAuth tokens and API keys are encrypted, and sensitive customer data is protected at rest and in transit.

Composio also undergoes independent security testing and continuously monitors its systems for security threats. You can review the latest reports and policies in the Composio Trust Center.

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

Create the key in your Mintlify account settings, then paste it once on Composio's connection page. Composio stores it encrypted and uses it only for the Mintlify actions your agent runs. Nobody else in your workspace can read it, and you can revoke it inside Mintlify at any time.

When you connect a Mintlify account through Composio, every action runs under that account, so anything the agent creates, sends, or changes shows up in Mintlify as done by you. Keep an approval step in your prompt for actions with side effects, such as sending or deleting, and have the agent draft first.

Whatever the credentials you connect allow inside Mintlify. If Mintlify lets you scope a key to specific permissions, create a scoped one so the agent can only do what you intend. You can revoke the key inside Mintlify at any time.

Yes. Composio supports multiple connected accounts for the same app, and that works in Claude, ChatGPT, or any other assistant you connect through Composio. Give each Mintlify connection a name such as work or personal, and the assistant uses the one you mention in the request. Each account keeps its own credentials and nothing is merged.

The connection stops working the moment Mintlify rejects the old key. Create a new key in Mintlify and reconnect the account from the Composio dashboard or by asking your agent to reconnect Mintlify. Nothing else changes.

Composio's free Hobby plan includes 100,000 tool calls per month with no credit card, which covers most personal Mintlify use. Paid plans add higher limits and team features. Your Mintlify plan and its API limits still apply as usual.

Built-in connectors usually give one AI access to a limited set of apps. Many people use Composio because it lets their AI connect to more apps than it normally supports, or connect to multiple accounts for the same app (e.g. connect Claude to multiple Mintlify accounts).

With Composio, you connect Mintlify once and then use it across different AI assistants without setting it up separately in each one. Connect your apps to Composio once, then connect Composio to whichever AI you use, whether that's Claude, ChatGPT, Hermes, or your own custom assistant.

Start with Mintlify.It takes 30 seconds.

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

Start building