developer-toolsapi_key

Mintlify

Mintlify is a documentation platform. This toolkit exposes the Admin API for managing docs programmatically — trigger deployments and previews, run automations, drive the docs-editing agent, and export analytics (feedback, searches, views, visitors and assistant conversations).

Verdict

Mintlify's MCP lets your team query documentation analytics, export user feedback, and trigger AI documentation agents — all from a Switchy Project. @Mention it to pull search trends, conversation logs, or page-view breakdowns without leaving chat. The standout tool is Create Agent Job: it edits your docs repo and opens a pull request based on a natural-language prompt, but it's destructive and burns credits, so use it deliberately. Best for engineering teams who maintain public docs and want analytics or automated edits in their workflow. Requires an API key with appropriate scopes; some endpoints return only the first page of results when pagination cursors are missing.

Common use cases

  • Surface top search queries and click-through rates
  • Export user feedback to prioritize doc improvements
  • Trigger AI agent to update stale API examples
  • Track human vs bot traffic across doc pages
  • Review assistant conversation logs for support insights

Integration

Vendor
Mintlify
Category
developer-tools
Auth
API_KEY
Tools
14
Composio slug
mintlify

Tools

  • 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

    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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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

  • 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 i

  • 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 a

Setup

Setup guide

  1. 11. In Switchy, navigate to Settings → Integrations → Developer Tools and click Connect next to Mintlify. 2. You'll be prompted to paste a Mintlify API key; generate one from your Mintlify dashboard under API Settings. 3. Grant the key read access to analytics endpoints and write access if you plan to use the agent job tool. 4. Click Save and wait for the green Connected badge. 5. Open any Project, type @Mintlify in the chat, and select it from the autocomplete menu. 6. Test the connection by asking '@Mintlify show me page views for the last 7 days' — you should see a table of paths and traffic counts. 7. To invoke the agent job tool, write '@Mintlify create an agent job to fix broken links in the API reference' and confirm the prompt; Mintlify will return a job ID you can poll with Get Agent Job.

What teammates see: by default, memories from Mintlify are scoped to the Project (PROJECT visibility) - you can mark any memory PRIVATE or share it ORG-wide.

Works well with

Top models

Compatibility data appears once enough Projects have used this MCP together with a given model.

How Switchy teams use it

Not enough Projects yet to publish anonymised usage stats (we require ≥ 50 Projects per week).

Starter prompts

Top Search Terms

@Mintlify get search queries for the last 30 days and show me the top 10 by hit count with their click-through rates

Feedback Triage

@Mintlify fetch all unresolved feedback from the past two weeks and group it by page path

Traffic Breakdown

@Mintlify get page views for the last 7 days and show me the split between human and AI traffic for each path

Agent PR for Outdated Docs

@Mintlify create an agent job to update all code snippets in the authentication guide to use the new SDK version

Assistant Conversation Audit

@Mintlify get assistant conversations from the past 14 days and summarize the most common unresolved questions

Example outputs

Illustrative - representative of the model's voice and quality, not literal recordings.

Prompt

@mintlify show me the top 10 search queries from the last 30 days and their click-through rates

Output

Here are the top searches from your docs in the past month: 1. "authentication setup" — 847 searches, 68% CTR, top page: /guides/auth 2. "API rate limits" — 612 searches, 71% CTR, top page: /api-reference/limits 3. "webhook configuration" — 489 searches, 54% CTR, top page: /webhooks/setup 4. "error codes" — 423 searches, 62% CTR, top page: /troubleshooting/errors 5. "SDK installation" — 391 searches, 77% CTR, top page: /sdks/getting-started (5 more entries follow) This data reflects what users are actively looking for. The lower CTR on "webhook configuration" suggests that page may need clearer headings or better search optimization.

Notes

This example uses Get Search Queries to surface content gaps. The MCP returns paginated results ordered by search volume; you'll need to specify a date range. No destructive side-effects. Useful for identifying documentation blind spots before investing in agent-driven rewrites.

Prompt

@mintlify create an agent job to add a troubleshooting section to the authentication guide covering common OAuth errors

Output

Agent job created successfully (ID: job_8x3k9m2p). The documentation agent is now analyzing your authentication guide and drafting a troubleshooting section for common OAuth errors. Status: running Target repo: your-org/docs Branch: main Model: gpt-4 The agent will open a pull request when complete. You can review changes before merging. Estimated completion: 3-5 minutes. I'll poll the job status and notify you when the PR is ready.

Notes

This example demonstrates Create Agent Job, which is DESTRUCTIVE and consumes Mintlify credits. The agent autonomously edits your docs repository and opens a PR — always review before merging. Requires write access to the connected repo. Use Get Agent Job to poll for completion and retrieve the PR link.

Prompt

@mintlify compare AI assistant usage versus human page views for our API reference section over the last quarter

Output

Here's the traffic breakdown for /api-reference/* from the past 90 days: **Human visitors:** 12,847 page views across 23 pages - Top page: /api-reference/authentication (2,103 views) - Average time on page: 2m 14s **AI assistant queries:** 8,492 questions answered - 71% resolution rate (user marked as helpful) - Most cited pages: /api-reference/rate-limits, /api-reference/webhooks **Insight:** AI traffic represents 40% of total API reference engagement. The assistant is heavily citing rate-limit docs, but human visitors spend more time on authentication — consider surfacing rate-limit context earlier in the auth flow.

Notes

This example combines Get Page Views (which splits human vs AI traffic) with Get Assistant Conversations to synthesize usage patterns. Requires date-range filtering on both endpoints. The MCP returns raw data; the AI performs the comparative analysis and surfaces actionable recommendations.

Use-case deep-dives

Docs sprint for API launch

When the agent job beats hiring a tech writer for launch week

A 6-person startup shipping a new API endpoint in 5 days needs reference docs written and merged before Friday. The Create Agent Job tool takes a natural-language prompt ("document the /v2/webhooks endpoint with code samples in Python and Node"), edits the connected repo, and opens a PR—all in one background job. You review the diff, request changes in plain English via a second agent job, and merge. This works when your docs repo is already Mintlify-structured and the endpoint surface is under 20 methods; beyond that, the agent starts hallucinating parameter types. If you're launching a 60-endpoint platform rewrite, hire the writer. For a 3-endpoint feature drop, the agent job closes the docs gap in an afternoon and your API key covers the credits.

Support triage with search analytics

Why search query export matters more than conversation logs

A 12-person SaaS support team sees the same integration questions every week but can't pinpoint which doc pages are failing. The Get Search Queries tool exports the top 50 search terms with click-through rates and the pages users land on after searching. You discover "webhook retry logic" has 340 searches and a 12% CTR—people aren't finding the answer. You rewrite that section, ship it, and watch CTR climb to 68% over two weeks. The Get Assistant Conversations tool gives you the raw Q&A transcripts, but search queries tell you what's missing before users even ask the AI. If your docs get under 500 searches a month, the signal is too noisy. Above that threshold, this becomes your quarterly content roadmap.

Quarterly content health review

When feedback-by-page data drives the rewrite backlog

A 20-person product org reviews docs health every quarter and needs to rank pages by user dissatisfaction. The Get Feedback By Page tool returns thumbs-up/down counts per URL, so you sort by negative feedback density and surface the 10 pages with the worst ratios. You cross-reference Get Page Views to confirm those pages also have high traffic (a page with 3 downvotes and 8 views isn't the priority; one with 40 downvotes and 2,000 views is). This two-tool combo builds the rewrite backlog in 20 minutes. The Get Feedback tool gives you the raw comment text, but that's a second pass—you triage by aggregate scores first. If your docs get under 100 feedback events per quarter, the sample size is too small to trust the ratios.

Frequently asked

What does the Mintlify MCP let me do in Switchy?

It connects your Mintlify documentation project so AI agents can pull analytics (page views, search queries, feedback), read conversation history from your AI assistant, and trigger documentation agent jobs that open pull requests against your docs repo. The Create Agent Job tool is destructive and consumes Mintlify credits, so treat it like a production deployment action.

Do I need admin access to connect Mintlify?

You need an API key from your Mintlify dashboard, which typically requires project-owner or admin permissions. The key grants full read access to analytics and conversation data, plus write access to trigger agent jobs. If your team restricts who can burn credits or open PRs, limit who gets the key.

Can the Mintlify MCP edit my documentation directly?

No. The Create Agent Job tool tells Mintlify's hosted agent to make edits, and that agent opens a pull request against your connected repo. The MCP itself never writes to your Git repository. You still review and merge the PR through your normal workflow, so you keep final approval over what ships.

Should I use this MCP or just query Mintlify's API directly?

Use the MCP when you want an AI agent to answer questions like "which pages got the most feedback last week" or "what are users searching for" without writing code. Use the API directly if you're building a custom dashboard or need to paginate through thousands of rows — the MCP handles one page at a time and stops when cursors run out.

Who on my team should connect the Mintlify integration?

Whoever owns your documentation analytics and has budget authority for Mintlify credits. The person who connects it can trigger agent jobs that cost money and open PRs, so this shouldn't be your entire engineering team. One docs lead or DevRel manager per Switchy workspace is typical.

More developer tools MCPs

See all developer tools MCPs →

Data last verified 61 hours ago.Sources aggregated hourly to weekly. See docs/architecture/model-directory.md.