← Files Mintlify MCPARCHIVED FILE
SKILL.md
2.14 KB · Oct 3, 2026 · 06:05 UTC
---
name: managing-workflows
description: Use when creating, updating, enabling, disabling, triggering, or debugging Mintlify Workflows (scheduled or push-triggered docs automations) through the Admin MCP, or when checking why a workflow run failed.
---
# Managing Workflows
## Overview
Workflows are deployment-level automations managed through code mode (`execute_code`) — no checkout needed, and changes apply to the live deployment immediately.
**REQUIRED BACKGROUND:** read the `using-code-mode` skill first for script return semantics and `{ subdomain }` targeting.
## Methods (namespace `workflows`)
| Method | Notes |
|--------|-------|
| `listWorkflows({})` | All workflows on the deployment |
| `getWorkflow({ workflowSchemaId })` | One workflow |
| `createWorkflow({ name, on, ... })` | Enforces plan limits and trigger validation |
| `updateWorkflow({ workflowSchemaId, ... })` | Dashboard validation path |
| `setWorkflowEnabled({ workflowSchemaId, enabled })` | Enabling re-checks plan limits |
| `triggerWorkflow({ workflowSchemaId })` | Manual run; enforces monthly run limits |
| `deleteWorkflow({ workflowSchemaId })` | Soft delete |
| `listWorkflowRuns({ workflowSchemaId?, status? })` | Run history, filterable |
Triggers (`on`) are either push-based (`{ push: [{ repo, branch?, isDeploymentGitSource? }] }`, max 10 repos) or cron (`{ cron: '0 9 * * 1' }`). Fetch the exact current schema with `search_code_operations { query: 'create workflow', namespace: 'workflows' }` before creating — the full `inputSchema` comes back in the hit.
## Example: find why runs are failing
```
const wfs = await workflows.listWorkflows({});
const runs = await workflows.listWorkflowRuns({ status: 'failed' });
({ workflows: wfs, failedRuns: runs });
```
## Common mistakes
- Guessing the `createWorkflow` payload — it is a large validated union; pull the schema via `search_code_operations` first.
- Forgetting these writes are live — disabling or deleting a workflow takes effect immediately.
- Triggering repeatedly to "retry" — manual triggers count against monthly run limits.
- Checking out an editor session first — workflows are code-mode, not session-scoped.
SHA-256: 298c5c7b535a1d4c1b42050492d0db002d38a53757af45a9df2b87b62220def3