Connect Mintlify to Your AI Agent

Queue documentation deployments, create branch previews, and inspect deployment status. Ask your connected AI assistant to explain the results or carry out the specified operation.

3 tools API key

Try a Mintlify Task

Copy a prompt into your agent with the oo Skill installed. Add your page links and source notes before running it.

oo Skill Mintlify

Preview a Documentation Branch

Start a preview for a specified Git branch and inspect its status.

/oo Mintlify: Create a Mintlify preview for project [project ID], branch [branch], then check the returned status ID and show the preview URL.

Deploy Production Documentation

Queue a production deployment and report its current state.

/oo Mintlify: Trigger a production deployment for Mintlify project [project ID] and report its status using the returned status ID.

Start Working with Mintlify

  1. Install OOMOL

    Set up oo CLI and the oo Skill in your agent.

    Install OOMOL →
  2. Connect Mintlify

    Provide a Mintlify admin API key and project ID from organization API key settings.

    Connect Mintlify →
  3. Give Your Agent a Task

    Use /oo with the pages to read, the changes to make, and where to save the result.

    Connection Guide →

Choose Your Agent

  • Mintlify organization admin API access and a project ID.
  • Deployment actions return a status ID; inspect it to determine the deployment outcome.

Mintlify Tools

Mintlify connects supported service operations to your AI assistant. Queue documentation deployments, create branch previews, and inspect deployment status.

Deployments

Queue production deployments or branch previews.

Deployment Status

Retrieve status, summary, and available logs for a deployment.

3 tools

Trigger Deployment

Queue a production deployment for a Mintlify documentation project.

mintlify.trigger_deployment

Trigger Preview Deployment

Create or redeploy a Mintlify preview for a specific Git branch.

mintlify.trigger_preview_deployment

Get Deployment Status

Get the current status and details of a Mintlify deployment.

mintlify.get_deployment_status

Frequently Asked Questions

Does a successful trigger mean deployment finished?

No. Use the returned status ID to inspect progress and the outcome.

Can AI edit my documentation through these actions?

These actions deploy existing project content and inspect deployments; they do not edit documentation files.

Can I preview a branch?

Yes. Supply the project ID and Git branch for a preview deployment.

Connect Mintlify

About Mintlify ↗