Skip to main content

Mintlify

Shanone’s Mintlify integration gives your agent 16 tools spanning deploys, the docs AI agent/assistant, content search, and site analytics.

Getting Started

1

Get Mintlify API keys

In your Mintlify dashboard, generate an Admin API key (deploys, analytics) and, if you use the docs AI assistant, an Assistant API key as well.
2

Add the keys in Shanone

Go to Integrations > Mintlify in the Shanone dashboard and paste in whichever key(s) you have — most tools only need the Admin key.
3

Retry your request

Once saved, shanone_execute_tool calls for mintlify_* tools will succeed.

Available Tools

Shanone provides 16 tools for Mintlify, organized into these categories:
mintlify_trigger_preview, mintlify_trigger_deploy, mintlify_get_deploy_status
mintlify_create_agent_job, mintlify_get_agent_job, mintlify_send_agent_message — run background jobs against the Mintlify docs AI agent, e.g. to review or update content
mintlify_search, mintlify_get_page, mintlify_chat
mintlify_get_page_views, mintlify_get_visitors, mintlify_get_searches, mintlify_get_feedback, mintlify_get_feedback_by_page, mintlify_get_conversations, mintlify_get_caller_stats

Common Use Cases

Docs deploy automation

Trigger a preview deploy after content changes, then promote to production

Content gap analysis

Pull top searches and feedback to find pages that need improvement

AI-assisted editing

Kick off an agent job to review a section of docs against style guidelines

Usage reporting

Summarize page views and visitor trends for a weekly docs report

Troubleshooting

Poll mintlify_get_deploy_status — deploys are asynchronous and can take a minute or more; the tool call returning doesn’t mean the build finished.
Confirm the page path matches exactly what’s registered in docs.json, including leading slash and no trailing .mdx extension.
Agent job tools (mintlify_create_agent_job, etc.) require the Assistant API key specifically — the Admin key alone won’t authorize them.