# Mintlify

```json
{
  "name": "Mintlify",
  "slug": "mintlify",
  "url": "https://composio.dev/toolkits/mintlify",
  "markdown_url": "https://composio.dev/toolkits/mintlify.md",
  "logo_url": "https://logos.composio.dev/api/mintlify",
  "categories": [
    "developer tools & devops"
  ],
  "is_composio_managed": false,
  "updated_at": "2026-07-28T11:13:31.886Z"
}
```

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

## Description

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.

## Summary

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.

## Categories

- developer tools & devops

## Toolkit Details

- Tools: 14

## Images

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

## Authentication

- **Api Key**
  - Type: `api_key`
  - Description: Api Key authentication for Mintlify.
  - Setup:
    - Configure Api Key credentials for Mintlify.
    - Use the credentials when creating an auth config in Composio.

## Suggested Prompts

- Trigger Mintlify production docs deployment
- Export Mintlify search analytics this week
- Create preview for documentation updates

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `MINTLIFY_CREATE_AGENT_JOB` | Create Agent Job | Start a background documentation agent job from a natural-language prompt. The agent edits the connected docs repo and OPENS A PULL REQUEST if it changes files (DESTRUCTIVE; consumes credits). Returns an AgentJob; poll its id with MINTLIFY_GET_AGENT_JOB for progress. Rate limit: 100 jobs per project per hour. |
| `MINTLIFY_GET_AGENT_JOB` | Get Agent Job | Retrieve the status and details (status, PR link, model, source repo/ref) of a docs agent job. Poll this until status is completed, archived or failed. No pagination. |
| `MINTLIFY_GET_ASSISTANT_CALLER_STATS` | Get Assistant Caller Stats | Get assistant query counts broken down by caller type (web, api, other, total) for a date range. Returns a single aggregate object; no pagination. |
| `MINTLIFY_GET_ASSISTANT_CONVERSATIONS` | Get Assistant Conversations | Export the AI assistant conversation history (question, answer, cited sources, resolution status) for a Mintlify project, optionally filtered by date. Returns one page of conversations plus a cursor to fetch the next page. |
| `MINTLIFY_GET_FEEDBACK` | Get Feedback | Export a project's user feedback (thumbs / contextual comments / agent feedback), optionally filtered by date, source and status. Returns one page plus a cursor to fetch the next. |
| `MINTLIFY_GET_FEEDBACK_BY_PAGE` | Get Feedback By Page | Get feedback counts (thumbs up/down, code, total) aggregated per documentation page path for a date range. Single page of results — this endpoint exposes no pagination cursor, so only the first page is available. |
| `MINTLIFY_GET_PAGE_VIEWS` | Get Page Views | Export per-path and site-wide content view counts split by human vs AI traffic. Offset-paginated: returns one page of rows plus site-wide totals, the hasMore flag as has_more, and a next_offset to fetch the following page. |
| `MINTLIFY_GET_SEARCH_QUERIES` | Get Search Queries | Export documentation search terms ordered by hit count (with CTR and top clicked page). Returns one page plus a cursor to fetch the next; there is no more-flag, so stop paging once next_cursor is null. |
| `MINTLIFY_GET_UNIQUE_VISITORS` | Get Unique Visitors | Export per-path and site-wide approximate distinct visitor counts split by human vs AI traffic. Offset-paginated: returns one page plus a `has_more` flag and the effective `next_offset` to fetch the following page. |
| `MINTLIFY_GET_UPDATE_STATUS` | Get Update Status | Get the status and details (queued / in_progress / success / failure, logs, commit, screenshot) of a triggered deployment update by its statusId. Poll this with the statusId returned by MINTLIFY_TRIGGER_UPDATE. |
| `MINTLIFY_SEND_AGENT_MESSAGE` | Send Agent Message | Send a follow-up instruction to an existing, in-progress docs agent job (asynchronous). Use to refine or continue work on a job created by create_agent_job. Returns the updated AgentJob; poll get_agent_job for progress. No pagination. |
| `MINTLIFY_TRIGGER_AUTOMATION` | Trigger Automation | Trigger a custom-schedule automation (workflow) to run immediately. Returns the schemaId, instanceId and jobId of the launched run. Only custom-schedule automations are triggerable (others return 400). Requires a Mintlify plan that includes automations (otherwise the API returns 401 'Please upgrade to access this route.'). |
| `MINTLIFY_TRIGGER_PREVIEW` | 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). Returns a statusId to poll with MINTLIFY_GET_UPDATE_STATUS and a previewUrl. Requires a Mintlify plan that includes preview deployments (plan gating may return 401 or 403). |
| `MINTLIFY_TRIGGER_UPDATE` | Trigger Update | Queue a production deployment of the docs project from its configured branch. Returns a statusId to poll with MINTLIFY_GET_UPDATE_STATUS. Requires a Mintlify plan that includes deployments (otherwise the API returns 401 'Please upgrade to access this route.'). |

## Supported Triggers

None listed.

## Installation and MCP Setup

### Path 1: SDK Installation

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

Install the Composio SDK
```python
pip install composio_openai
```

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

#### Path 1, Step 2: Initialize Composio and Create Tool Router Session

Import and initialize Composio client, then create a Tool Router session
```python
from openai import OpenAI
from composio import Composio
from composio_openai import OpenAIResponsesProvider

composio = Composio(provider=OpenAIResponsesProvider())
openai = OpenAI()
session = composio.create(user_id='your-user-id')
```

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

const composio = new Composio({
  provider: new OpenAIResponsesProvider(),
});
const openai = new OpenAI({});
const session = await composio.create('your-user-id');
```

#### Path 1, Step 3: Execute Mintlify Tools via Tool Router with Your Agent

Get tools from Tool Router session and execute Mintlify actions with your Agent
```python
tools = session.tools
response = openai.responses.create(
  model='gpt-4.1',
  tools=tools,
  input=[{
    'role': 'user',
    'content': 'Trigger a Mintlify preview deployment for the latest documentation changes'
  }]
)
result = composio.provider.handle_tool_calls(
  response=response,
  user_id='your-user-id'
)
print(result)
```

```typescript
const tools = session.tools;
const response = await openai.responses.create({
  model: 'gpt-4.1',
  tools: tools,
  input: [{
    role: 'user',
    content: 'Trigger a Mintlify preview deployment for the latest documentation changes'
  }],
});
const result = await composio.provider.handleToolCalls(
  'your-user-id',
  response.output
);
console.log(result);
```

### Path 2: MCP Server Setup

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

Install the Composio SDK for Python or TypeScript
```python
pip install composio claude-agent-sdk
```

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

#### Path 2, Step 2: Initialize Client and Create Tool Router Session

Import and initialize the Composio client, then create a Tool Router session for Mintlify
```python
from composio import Composio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions

composio = Composio(api_key='your-composio-api-key')
session = composio.create(user_id='your-user-id')
url = session.mcp.url
```

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

const composio = new Composio({ apiKey: 'your-api-key' });
const session = await composio.create('your-user-id');
console.log(`Tool Router session created: ${session.mcp.url}`);
```

#### Path 2, Step 3: Connect to AI Agent

Use the MCP server with your AI agent (Anthropic Claude or Mastra)
```python
import asyncio

options = ClaudeAgentOptions(
    permission_mode='bypassPermissions',
    mcp_servers={
        'tool_router': {
            'type': 'http',
            'url': url,
            'headers': {
                'x-api-key': 'your-composio-api-key'
            }
        }
    },
    system_prompt='You are a helpful assistant with access to Mintlify tools.',
    max_turns=10
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query('Export Mintlify search analytics for the last 7 days')
        async for message in client.receive_response():
            if hasattr(message, 'content'):
                for block in message.content:
                    if hasattr(block, 'text'):
                        print(block.text)

asyncio.run(main())
```

```typescript
import { openai } from '@ai-sdk/openai';
import { experimental_createMCPClient as createMCPClient } from '@ai-sdk/mcp';
import { generateText } from 'ai';

const client = await createMCPClient({
  transport: {
    type: 'http',
    url: session.mcp.url,
    headers: {
      'x-api-key': 'your-composio-api-key',
    },
  },
});

const tools = await client.tools();
const { text } = await generateText({
  model: openai('gpt-4o'),
  tools,
  messages: [{
    role: 'user',
    content: 'Export Mintlify search analytics for the last 7 days'
  }],
  maxSteps: 5,
});

console.log(`Agent: ${text}`);
```

## Why Use Composio?

### 1. 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

### 2. 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

### 3. 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

### 4. 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

## Use Mintlify with any AI Agent Framework

Choose a framework you want to connect Mintlify with:

- [ChatGPT Work](https://composio.dev/toolkits/mintlify/framework/chatgpt)
- [Claude Cowork](https://composio.dev/toolkits/mintlify/framework/claude-cowork)

## Related Toolkits

- [Supabase](https://composio.dev/toolkits/supabase) - Supabase is an open-source backend platform offering scalable Postgres databases, authentication, storage, and real-time APIs. It lets developers build modern apps without managing infrastructure.
- [Codeinterpreter](https://composio.dev/toolkits/codeinterpreter) - Codeinterpreter is a Python-based coding environment with built-in data analysis and visualization. It lets you instantly run scripts, plot results, and prototype solutions inside supported platforms.
- [GitHub](https://composio.dev/toolkits/github) - GitHub is a code hosting platform for version control and collaborative software development. It streamlines project management, code review, and team workflows in one place.
- [1password](https://composio.dev/toolkits/_1password) - 1Password is a password manager and digital vault for storing logins, secrets, notes, and secure documents. It helps individuals and teams protect credentials, share access safely, and reduce password risk.
- [Ably](https://composio.dev/toolkits/ably) - Ably is a real-time messaging platform for live chat and data sync in modern apps. It offers global scale and rock-solid reliability for seamless, instant experiences.
- [Abuselpdb](https://composio.dev/toolkits/abuselpdb) - Abuselpdb is a central database for reporting and checking IPs linked to malicious online activity. Use it to quickly identify and report suspicious or abusive IP addresses.
- [Alchemy](https://composio.dev/toolkits/alchemy) - Alchemy is a blockchain development platform offering APIs and tools for Ethereum apps. It simplifies building and scaling Web3 projects with robust infrastructure.
- [Algolia](https://composio.dev/toolkits/algolia) - Algolia is a hosted search API that powers lightning-fast, relevant search experiences for web and mobile apps. It helps developers deliver instant, typo-tolerant, and scalable search without complex infrastructure.
- [Anchor browser](https://composio.dev/toolkits/anchor_browser) - Anchor browser is a developer platform for AI-powered web automation. It transforms complex browser actions into easy API endpoints for streamlined web interaction.
- [Apiflash](https://composio.dev/toolkits/apiflash) - Apiflash is a website screenshot API for programmatically capturing web pages. It delivers high-quality screenshots on demand for automation, monitoring, or reporting.
- [Apiverve](https://composio.dev/toolkits/apiverve) - Apiverve delivers a suite of powerful APIs that simplify integration for developers. It's designed for reliability and scalability so you can build faster, smarter applications without the integration headache.
- [Appcircle](https://composio.dev/toolkits/appcircle) - Appcircle is an enterprise-grade mobile CI/CD platform for building, testing, and publishing mobile apps. It streamlines mobile DevOps so teams ship faster and with more confidence.
- [Appdrag](https://composio.dev/toolkits/appdrag) - Appdrag is a cloud platform for building websites, APIs, and databases with drag-and-drop tools and code editing. It accelerates development and iteration by combining hosting, database management, and low-code features in one place.
- [Appveyor](https://composio.dev/toolkits/appveyor) - AppVeyor is a cloud-based continuous integration service for building, testing, and deploying applications. It helps developers automate and streamline their software delivery pipelines.
- [Backendless](https://composio.dev/toolkits/backendless) - Backendless is a backend-as-a-service platform for mobile and web apps, offering database, file storage, user authentication, and APIs. It helps developers ship scalable applications faster without managing server infrastructure.
- [Baserow](https://composio.dev/toolkits/baserow) - Baserow is an open-source no-code database platform for building collaborative data apps. It makes it easy for teams to organize data and automate workflows without writing code.
- [Bench](https://composio.dev/toolkits/bench) - Bench is a benchmarking tool for automated performance measurement and analysis. It helps you quickly evaluate, compare, and track your systems or workflows.
- [Better stack](https://composio.dev/toolkits/better_stack) - Better Stack is a monitoring, logging, and incident management solution for apps and services. It helps teams ensure application reliability and performance with real-time insights.
- [Bitbucket](https://composio.dev/toolkits/bitbucket) - Bitbucket is a Git-based code hosting and collaboration platform for teams. It enables secure repository management and streamlined code reviews.
- [Blazemeter](https://composio.dev/toolkits/blazemeter) - Blazemeter is a continuous testing platform for web and mobile app performance. It empowers teams to automate and analyze large-scale tests with ease.

## Frequently Asked Questions

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

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.

### 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)