Skip to content

docs: update for windmill#5685 #935

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

docs: update for windmill#5685 #935

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
06f607b
docs: Add frontmatter to MCP index page
actions-user May 16, 2025
99e2e01
docs: Document MCP integration with Hub scripts
actions-user May 19, 2025
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
16 changes: 11 additions & 5 deletions docs/core_concepts/51_mcp/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Windmill MCP
slug: mcp
---

# Windmill MCP

Windmill supports the [**Model Context Protocol (MCP)**](https://modelcontextprotocol.io/introduction), an open standard that enables seamless interaction between LLMs and tools like Windmill.
Expand All @@ -19,7 +24,7 @@ With MCP, you can connect your favorite LLMs (like [Claude](https://claude.ai/do
### Generate your MCP token and URL

1. Navigate to your **account settings** in Windmill.
2. Create a new **token** under the **Tokens** section, and select **Generate MCP URL**.
2. Create a new **token** under the **Tokens** section. When creating the token, you'll find an option such as "Include Hub Scripts" or similar, allowing you to specify if this token should grant access to scripts from the Windmill Hub. Select this option if you want your LLM to be able to use scripts from the Hub. Finally, select **Generate MCP URL**.

![Generate MCP token](./user_settings.png 'Generate MCP token')

Expand Down Expand Up @@ -70,7 +75,7 @@ To connect with Claude Desktop:
}
```

Once connected, your LLM will be able to run any script or flow in your Windmill workspace.
Once connected, your LLM will be able to run any script or flow in your Windmill workspace. If you enabled Hub script access for your token (as described in the token generation step), your LLM will also be able to discover and run available scripts from the Windmill Hub.

## Example: Triggering a script from Claude

Expand All @@ -94,13 +99,14 @@ Claude will:
- **Not seeing any scripts/flows?**
- Ensure your LLM tool is connected to the correct MCP URL.
- If you chose the "favorites only" option when creating your MCP URL, make sure the script or flow is in your favorites.
- If you intended to use Hub scripts, verify that your MCP token was generated with the option to include Hub scripts enabled.
- **My LLM does not find the correct script/flow to run**
- Ensure the script or flow is deployed and visible in your workspace.
- Choose good titles and descriptions to help the LLM find the correct script/flow.
- Ensure the script or flow (from your workspace or the Hub) is deployed and accessible.
- Choose good titles and descriptions for your workspace scripts/flows to help the LLM find them. Hub scripts are curated, but clear prompts to your LLM are always beneficial.

---

## Learn more

- [MCP official docs](https://modelcontextprotocol.io/introduction)
- [MCP compatible clients](https://modelcontextprotocol.io/clients)
- [MCP compatible clients](https://modelcontextprotocol.io/clients)