Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions ai/mintlify-mcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
| :-- | :-- | :-- |
| **Audience** | Your end users | Your team |
| **Access** | Read and search published pages | Read, edit, restructure, save |
| **Endpoints** | `/mcp` on your site domain | Hosted by Mintlify, scoped to your project |

Check warning on line 23 in ai/mintlify-mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L23

Use 'endpoints?' instead of 'Endpoints'.
| **Output** | Search results and page content | Content edits, navigation changes, pull requests |

## Connect to the Mintlify MCP
Expand Down Expand Up @@ -99,6 +99,10 @@
Calling `checkout` again during an active session switches the session to the new branch. Use this to abandon an in-progress draft and start fresh without ending the conversation.
</Tip>

<Note>
Workflow management tools operate at the project level and do not require a `checkout`. You can list, create, update, enable, or trigger [workflows](/workflows/index) without binding the session to a branch.
</Note>

## What the Mintlify MCP can do

### Content
Expand All @@ -110,7 +114,7 @@

### Navigation

- **`list_nodes`** — Walk the navigation tree with optional filters. Filter by `parentId` (use `recursive: true` to include all descendants), one or more node types, or any division scope: `language`, `version`, `tab`, `dropdown`, `anchor`, `product`, or `item`. Results are paginated through an opaque `cursor`.

Check warning on line 117 in ai/mintlify-mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L117

In general, use active voice instead of passive voice ('are paginated').
- **`create_node`** — Add a new page, group, tab, anchor, version, language, product, or dropdown.
- **`update_node`** — Update a node's properties in place (rename a group, change an icon, set a default version).
- **`move_node`** — Move a node, including renaming a page's path.
Expand All @@ -120,6 +124,20 @@

- **`update_config`** — Modify `docs.json` (theme, navigation roots, integrations, SEO settings).

### Workflows

Manage [workflows](/workflows/index) and inspect their runs at the project level. These tools do not require `checkout`.

- **`list_workflows`** — List workflows for the project. Filter by `status` (`active`, `disabled`, or `deleted`) and `type` (for example, `changelog`, `translations`, `typo-check`). Deleted workflows are omitted unless you pass `status: "deleted"`.

Check warning on line 131 in ai/mintlify-mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L131

In general, use active voice instead of passive voice ('are omitted').
- **`get_workflow`** — Fetch a single workflow by `workflowSchemaId`.
- **`create_workflow`** — Create a workflow with `name`, `on` (cron, push, or Composio trigger), and an optional `prompt`, `type`, `context`, `config`, `tools`, `automerge`, and `notify`. Enforces plan limits and required integrations such as Slack or Composio.
- **`update_workflow`** — Update a workflow by `workflowSchemaId` with the same fields as `create_workflow`. Composio trigger registrations refresh automatically when the trigger changes.
- **`delete_workflow`** — Soft-delete a workflow by `workflowSchemaId`. Composio triggers are unregistered when no other live workflow uses them.

Check warning on line 135 in ai/mintlify-mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L135

In general, use active voice instead of passive voice ('are unregistered').
- **`set_workflow_enabled`** — Enable or disable a workflow with `{ workflowSchemaId, enabled }`. Enabling re-checks plan limits and refreshes `nextRunAt` for cron workflows.
- **`trigger_workflow`** — Manually start a run for a cron-based or translations workflow. Subject to the monthly workflow run limit.
- **`list_workflow_runs`** — List runs for the project. Optionally filter by `workflowSchemaId` and by `statuses` (`review-needed`, `merged`, `failed`, `closed`, `no-action`, `running`).
- **`get_workflow_run`** — Fetch a single run by `workflowInstanceId`, including its parent workflow schema.

### Session

- **`checkout`** — Bind the session to a branch.
Expand All @@ -134,8 +152,9 @@
After you connect the Mintlify MCP, you can drive it with natural-language prompts. For example:

- _"Check out a branch called `add-billing-faq` and create a new page under the FAQ group titled 'Billing'. Draft answers for the five questions in this Linear issue."_
- _"Find every page that mentions the deprecated `legacy_token` field and update the example to use `api_key` instead. Save as a PR titled 'docs: replace legacy\_token references'."_

Check warning on line 155 in ai/mintlify-mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L155

Did you really mean 'legacy_token'?
- _"Reorganize the API reference: move the webhooks pages into a new group called 'Webhooks' and update the icons to match the rest of the section."_

Check warning on line 156 in ai/mintlify-mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L156

Use 'REST' instead of 'rest'.
- _"List my active workflows, then trigger the weekly typo-check run and show me the results."_

Check warning on line 157 in ai/mintlify-mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L157

Avoid first-person pronouns such as 'my'.

Check warning on line 157 in ai/mintlify-mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L157

Avoid first-person pronouns such as 'me'.

## Best practices

Expand Down
Loading