docs/mcp/overview.mdx
Activepieces includes a built-in MCP server that lets AI assistants build flows, manage tables, test automations, and more — all through natural language.
Add the URL to your MCP client config. Authentication is handled via OAuth — your client will open a browser to authenticate on first use.
{
"mcpServers": {
"activepieces": {
"url": "https://your-instance.com/mcp"
}
}
}
| Client | Config Location |
|---|---|
| Cursor | .cursor/mcp.json (project) or ~/.cursor/mcp.json (global) |
| Claude Desktop | ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows) |
| Windsurf | MCP settings in editor preferences |
| Claude.ai | Organization Settings → Connectors → Add → Custom connector |
Once connected, ask your AI assistant things like:
Tools are organized into categories. Discovery tools are always available. Other categories can be enabled or disabled per-project in the MCP Server settings.
| Category | Description |
|---|---|
| Discovery | Read-only tools for exploring flows, pieces, connections, tables, runs, and validation |
| Flow Management | Create, duplicate, rename, publish, and enable/disable flows |
| Flow Building | Add, update, and delete steps and triggers |
| Router & Branching | Add, update, and delete conditional branches |
| Annotations | Manage canvas notes |
| Tables | Full CRUD for tables, fields, and records |
| Testing & Runs | Test flows, inspect results, retry failures |
See the Tools Reference for the complete catalog with input schemas.
The MCP server and its OAuth endpoints are reachable both at the host root (https://your-instance.com/mcp) and under a path prefix (https://your-instance.com/<prefix>/mcp) when your reverse proxy routes https://host/<prefix>/* to Activepieces.
For a subpath deployment to work, set AP_FRONTEND_URL to the full public URL including the prefix (e.g. https://your-instance.com/activepieces). Activepieces then advertises its OAuth issuer, authorization/token endpoints, protected-resource metadata, and the WWW-Authenticate discovery header under that prefix, so the entire handshake stays inside your proxy rule.
ap_setup_guide returns instructions for the user to configure connections in the UI, rather than handling secrets through MCP