diff --git a/ai/mintlify-mcp.mdx b/ai/mintlify-mcp.mdx index 740670544..a36c10451 100644 --- a/ai/mintlify-mcp.mdx +++ b/ai/mintlify-mcp.mdx @@ -99,6 +99,10 @@ Every Mintlify MCP session binds to a single Git branch. The flow is: 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. + + 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. + + ## What the Mintlify MCP can do ### Content @@ -120,6 +124,20 @@ Every Mintlify MCP session binds to a single Git branch. The flow is: - **`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"`. +- **`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. +- **`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. @@ -136,6 +154,7 @@ After you connect the Mintlify MCP, you can drive it with natural-language promp - _"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'."_ - _"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."_ +- _"List my active workflows, then trigger the weekly typo-check run and show me the results."_ ## Best practices