Quick setup (Cursor)
1
Create a PAT
In the Console, go to access token settings and create a PAT with scopes
workflow:read, workflow:run, and mcp:execute as needed. Copy the token — it is shown once.2
Add the MCP server
In Cursor, open MCP settings and add a remote server:
3
Verify connection
Ask the assistant to call
ar_health_summary or workflows_list to confirm the PAT resolves to your workspace.Authentication model
- Send your PAT as
Authorization: Bearer pat_...on every MCP request - The BFF infers tenant, project, and user from PAT introspection — do not set
X-Tenant-Idmanually - Your PAT must map to a user with the required project role (project_contributor for writes)
Tool groups
Tools are organized into groups. Production deployments may disable sensitive groups.
Tools marked risk return secrets (vault values, PAT plaintext, webhook signing secrets, LLM API keys). These are hidden in production when the
risk group is disabled.
Core tools (workflows and runs)
Human task tools (approvals)
Runs blocked on ahuman_task step stay running until a task is completed. Use these tools instead of inferring state from run events alone.
After
workflows_execute_command, save run_id from the response and poll runs_get_summary until the run completes, fails, or blocks. Call tasks_list_pending_run (or tasks_list_pending) to detect approval gates before reporting success.
Analytics tools
Catalog passthrough
catalog_bff_request is a generic tool for any /v1/mcp/* BFF route — list servers, create instances, validate bindings, list tools, and more. Pass method, path, optional query, and body.
Example paths:
GET /v1/mcp/instancesPOST /v1/mcp/instances/{id}/validateGET /v1/mcp/platform-catalog
/credentials require the risk group to be enabled.
Memory tools
Live run streaming
workflows_stream_websocket opens a bounded WebSocket read on /v1/workflows/{workflow_id}/stream and returns collected frames. Defaults cap duration, message count, and total bytes to prevent runaway reads.
Example assistant prompts
- “List my workflows and show the three most recent runs”
- “Validate workflow
{id}and start a run with params{\"env\": \"staging\"}” - “How many credits did my project consume this week?”
- “Search memory for decisions about the Q2 pricing workflow”
Security practices
- Use the minimum PAT scopes needed for your workflow
- Prefer a dedicated PAT for IDE use — revoke it without affecting production automation
- Do not enable risk tools unless you need vault, PAT, or credential management from the IDE
- Rotate PATs if they appear in logs or shared configs
Related docs
- API authentication — PAT scopes and creation
- MCP instances — connector tools for workflow runs (different from Platform MCP)
- API reference — full REST endpoint catalog