Create a custom workflow

Create a custom workflow with a trigger, context repositories, and agent prompt.

Prerequisites

• A Mintlify project connected to a GitHub or GitLab repository
• For GitHub: the Mintlify GitHub App installed on every repository you plan to use in the workflow
• For GitLab: a connected GitLab account (see GitLab setup below)

Create a custom workflow

The agent runs in an isolated sandbox with restricted internet access. The agent cannot install additional packages or tools at runtime. Prompts that reference unavailable tools may produce unexpected results or fail.

1. Open the Workflows page in your dashboard.
2. Click Create a custom workflow.
3. Configure the workflow name, when it runs, instructions, and how it makes updates.
4. Click Create workflow.

Best practices

Effective workflow instructions focus on a single task and define a clear, verifiable outcome. Workflows have some variance because agents are nondeterministic, but consistent instructions produce consistent results.

• Describe the outcome. Tell the agent what the result should look like. Describe what done looks like.
• Write a procedure. Give the agent a step-by-step guide to follow.
• Specify context. Reference the files, directories, or repositories the agent should use.
• Keep scope narrow. Split complex tasks across multiple workflows rather than combining them into one prompt.

Review the output of your custom workflows to ensure they are working as expected. Update your instructions to improve the results.

GitLab setup

To use GitLab repositories in a workflow, connect each project through the GitLab OAuth settings page. Connect every repository the workflow touches—your documentation repository and any trigger or context repositories. You must have at least the Maintainer role on each project.

Workflows require a paid GitLab tier. The agent uses short-lived project access tokens for repository access, which GitLab’s Free plan does not support.