XY Logo
Developer hub
Model Context Protocol

Bring XY tools into your AI client.

Connect a Streamable HTTP MCP client to catalog agents, custom requests, workflow authoring, browser development, Knowledge Bases, schedules, and governed operations through one scoped endpoint.

Quick start

Choose interactive sign-in or an API key.

Human-operated OAuth-capable clients can connect without copying a long-lived key. Service automation and clients without browser authorization can use an organization-scoped API key at the same endpoint.

Interactive OAuth

Recommended for people using an MCP client

  1. Add the production MCP URL without an Authorization header.
  2. Your client discovers XY authorization and opens a secure browser page.
  3. Sign in to XY, confirm the selected organization, review the effective access, and approve or deny it.
  4. Return to the client. It completes the connection and refreshes access as needed without exposing an API key to you.

Interactive sign-in and user access must be enabled for your organization. Contact XY if an OAuth-capable client cannot begin authorization.

Claude Code
claude mcp add --transport http --scope user xy 'https://mcp.xy.ai/mcp'
OAuth-capable client configuration
{
  "mcpServers": {
    "xy": {
      "type": "http",
      "url": "https://mcp.xy.ai/mcp"
    }
  }
}

Personal or service API key

For services and noninteractive clients

Create a key under Organization settings → API Keys, grant only the scopes this job needs, and resolve the complete value from a private process environment.

Choose a Personal key when a person is operating the client. Calls remain bound to that user's current membership and workflow permissions.

Choose a Service key for unattended automation. Calls identify the service credential and organization rather than a human user.

API-key client configuration
{
  "mcpServers": {
    "xy": {
      "type": "http",
      "url": "https://mcp.xy.ai/mcp",
      "headers": {
        "Authorization": "Bearer ${XY_API_KEY}"
      }
    }
  }
}

When using the API-key path, do not place the key in a shared configuration file. ResolveXY_API_KEYfrom an OS keychain, secret manager, or private process environment.

Do not paste portal passwords, TOTP seeds, or PINs into an AI conversation. An authorized person can add them directly in Password Vault, or a trusted backend can provision an API-managed entry through REST with organization-service access. Grant MCP credentials:read to discover only safe visible metadata, then use the exact returned credential ID. If zero or multiple entries match, the client must ask instead of guessing. See the Credentials and MFA guide.

Capabilities

Tools are discovered from the live server.

Your client negotiates the current tool catalog and input schemas through MCPtools/liston connection. That live response includes only tools whose required scopes are present on the current OAuth grant or API key, so the model does not spend context on operations it cannot call.

Catalog agents

Discover and install catalog agents, start hosted authorization handoffs, inspect installation readiness, and execute agents.

Knowledge Base

Add, inspect, complete, and delete indexed sources, then run evidence-backed questions.

Integration Factory

Extend an organization-owned integration, inspect durable runs, explicitly test generated read or write capabilities, and advance validation and organization-only promotion. Brand-new creation and private uploads start through REST.

Planner agent

Build, review, test, export, and explicitly promote reusable workflows.

Browser Studio

Develop browser steps in retained authoring sessions with scoped controls.

Queue UI Designer

Release preview: not yet available in production. Once the required routes and tools are deployed, design eligible workflow queues and publish saved versions after human review or explicitly scoped system approval. Check the live contract before use.

Analytics

Query existing analytics with dashboards:read. Release preview: dashboards:propose separately enables exact-workflow dashboard proposals using registered governed query refs, stopping at PREVIEW_READY for human review in XY. No MCP approval or publication.

Schedules

Inspect and operate recurring compiled-workflow schedules.

Run observability

Read safe execution phases. Shared planner progress release preview adds ordered durable phase, tool, artifact, and approval events. Save each cursor with its run identity; bounded polling works even when a host does not display progress notifications.

Runtime credentials

Discover safe metadata for visible Password Vault references and bind exact IDs without returning stored values. Add secrets in the UI or through trusted REST, not an AI conversation.

For the shared progress release preview, long-running starts return run_idimmediately. Use bounded event polling from the live catalog; notifications are optional. Reconstruct snapshot, replay, then tail in sequence order, discard duplicates, and save the last applied cursor with its exact run/stream identity. A disconnected client does not cancel the worker. Read existing state after ambiguous output instead of repeating a mutation. See durable Planner progress.

dashboard_proposal_start and dashboard_proposal_get are a release preview for proposals bound to one active workflow and, for edits, both the base dashboard and immutable base version. dashboards:propose is an explicit opt-in, separate from dashboards:read; retired dashboards:writegrants nothing. Personal keys and OAuth use the current human's analytics seat, both dashboard capability grants, exact workflow configure permission, and edit-time dashboard view permission. System keys act as managed organization service principals and are bounded by organization feature flags plus their explicitly selected scope, not human grants. Neither can approve or publish an analytics dashboard through public MCP proposal tools.

Compose only registered governed query refs. Missing metrics return GOVERNED_QUERY_REQUIRED, not permission to author arbitrary queries. Proposals stop at PREVIEW_READY; use the returned review_version_idto open the exact version for human approval and publication in XY. Queue UI has a separate lifecycle; its system approval tool cannot approve analytics dashboards. See REST examples and governance requirements.

Common workflows

Connect tools in resource order.

MCP exposes primitives, not an invisible second lifecycle. These sequences show which resource must exist before the next tool can run; inspect every returned state and schema instead of assuming the happy path.

For queue previews, human review or system approval, publication, and rollback, follow the Queue UI Designer guide. This workflow is a release preview, not yet available in production. Verify the required routes and tools in the live references before attempting it. Automated system approval is recorded separately from human review. Use a system API key, not personal OAuth, for approval automation.

1 common workflow sequence is temporarily hidden because the required tools are not all present in the current catalog. Use the live tool reference below for the available contract.

Run a catalog agent

catalog_list_agents → catalog_get_agent → agent_install → installation_get → agent_execution_start → agent_execution_get

If installation_get returns an authorization action, complete that hosted handoff before execution.

Create a Knowledge Base from a URL

catalog_get_agent → agent_install → knowledge_source_add_url → knowledge_sources_list → installation_get → agent_execution_start → agent_execution_get

Add a public HTTPS source, wait for indexing to finish, then execute a question.

Create a Knowledge Base from a file

catalog_get_agent → agent_install → knowledge_source_create_file_upload → knowledge_source_complete_upload → knowledge_sources_list → installation_get → agent_execution_start → agent_execution_get

Upload the file bytes to the signed URL directly, complete the upload, then wait for indexing before execution.

Build a browser workflow

planner_start_build → planner_get_events → planner_get_build → planner_respond_to_plan → planner_get_events → browser_create_session → browser_prompt / browser_run_command → browser_apply_draft → planner_test_step → planner_accept_step → planner_promote → workflow_execute

Whole-plan approval requires API 1.4.0; confirm the operation in your environment's API reference or MCP catalog. Read the build: status awaiting_input plus planner_state.awaiting_plan_approval means review the plan. With planner:write, call planner_respond_to_plan with build_id, action APPROVE or REJECT, state_version, and idempotency_key; REJECT also requires a nonblank comment. MCP state_version maps to REST expected_state_version. Poll the same build/events for the queued command's outcome before generating or testing steps. After ambiguous output, read instead of repeating the mutation; reuse a key only for an exact request replay, and re-read a stale version. Optionally pass an organization-owned recording as context.recorded_task_id to planner_start_build. Browser Studio authors one proposed browser step; Planner tests and accepts it separately. Personal or system keys can approve an accessible build's plan, without publication authority. Promotion needs planner:promote through a system API key or a separately authorized personal MCP OAuth grant. Personal API keys cannot hold that scope. Queue UI publication is separate and requires prior human review or explicitly scoped system approval; personal OAuth cannot grant Queue UI API approval.

Reconnect to an existing Planner build

planner_get_build → planner_get_events / planner_wait_for_events

Read the same public build after an interrupted command. Replay and tail with the cursor for that exact stream; shared progress uses per-run sequences, not interchangeable build cursors. Apply ordered events once and save the cursor after applying them. Use bounded polling even when the host omits progress notifications. Do not restart work or repeat ACCEPT to reconnect; a completed turn is not approval or publication.

Render metrics for one production workflow

workflow_metric_dashboards_list → workflow_metric_dashboard_get

XY must first grant the API identity analytics-only view access to that exact workflow definition. The returned tile data and visualization metadata are for rendering in your own UI.

Design an existing workflow queue

queue_ui_list_targets → queue_ui_start_design → queue_ui_get_design → queue_ui_get_events → queue_ui_list_versions → queue_ui_get_version → queue_ui_send_message → queue_ui_publish

Use personal Queue UI access with explicit workflow permissions or a system key with organization authorization. For human review, a person approves the exact design version and hash in the web app. Publish takes that DESIGN version ID and compares expected_live_version_id with the PUBLICATION receipt in session.publication.live_version_id. Publish cannot approve. Send a message only when another revision is needed.

Approve and publish a queue with a system key

queue_ui_get_design → queue_ui_get_version → queue_ui_approve → queue_ui_publish

System API-key access only: explicitly grant queue_ui:read, queue_ui:approve, and queue_ui:publish. Inspect the version and validation, then approve its exact design ID and returned resolved_yaml_hash with the observed live publication receipt. Publish separately with that receipt. Approval is audited as a system decision, never human review; stop on a conflict. Personal OAuth cannot use the approval stage.

Ask XY to deliver an agent

custom_agent_request_create → custom_agent_request_get → custom_agent_request_message

The partner completes the hosted specification form; the MCP tool does not answer the form on their behalf.

Live reference

Current MCP tools and input schemas.

This catalog is read from the production MCP registry at request time and refreshed every minute. Tool additions and schema changes appear here after the MCP deployment without a website release.

This public reference shows every available tool contract. An authenticatedtools/listresponse is narrower: it omits tools the current OAuth grant or API key cannot call.

MCP covers catalog discovery, installations, starting and inspecting hosted authorization handoffs, Knowledge Base sources, agent executions, custom-agent requests, the Planner agent, Browser Studio, credentials, on-demand promoted workflow executions, schedules, run phases, usage, and read-only analytics. Dashboard proposals and shared durable Planner progress are release previews; confirm their tools in the live catalog. Analytics dashboard approval and publication remain human web actions. Review-item decisions and approved agent or installation metrics remain direct REST operations. Explicitly granted workflow definitions also expose approved metric views throughworkflow_metric_dashboards_listandworkflow_metric_dashboard_get.

106 live tools

Showing 106 of 106 tools

agent_execution_getPoll one catalog-agent execution for status and its stable result.
Input schema
{
  "properties": {
    "execution_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Execution Id",
      "type": "string"
    }
  },
  "required": [
    "execution_id"
  ],
  "title": "agent_execution_getArguments",
  "type": "object"
}
agent_execution_startStart an asynchronous run of an installed catalog agent.
Input schema
{
  "properties": {
    "installation_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Installation Id",
      "type": "string"
    },
    "input": {
      "additionalProperties": true,
      "title": "Input",
      "type": "object"
    },
    "metadata": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Metadata"
    },
    "idempotency_key": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Idempotency Key"
    }
  },
  "required": [
    "installation_id",
    "input"
  ],
  "title": "agent_execution_startArguments",
  "type": "object"
}
agent_executions_listList organization-scoped catalog-agent executions.
Input schema
{
  "properties": {
    "status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status"
    },
    "agent_id": {
      "anyOf": [
        {
          "maxLength": 500,
          "minLength": 1,
          "pattern": "^[A-Za-z0-9_.:-]+$",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Agent Id"
    },
    "installation_id": {
      "anyOf": [
        {
          "maxLength": 500,
          "minLength": 1,
          "pattern": "^[A-Za-z0-9_.:-]+$",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Installation Id"
    },
    "limit": {
      "default": 25,
      "maximum": 100,
      "minimum": 1,
      "title": "Limit",
      "type": "integer"
    },
    "offset": {
      "default": 0,
      "minimum": 0,
      "title": "Offset",
      "type": "integer"
    }
  },
  "title": "agent_executions_listArguments",
  "type": "object"
}
agent_installInstall an entitled catalog agent using its returned setup schema.
Input schema
{
  "properties": {
    "agent_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Agent Id",
      "type": "string"
    },
    "configuration": {
      "additionalProperties": true,
      "title": "Configuration",
      "type": "object"
    },
    "agent_version": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Agent Version"
    },
    "idempotency_key": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Idempotency Key"
    }
  },
  "required": [
    "agent_id",
    "configuration"
  ],
  "title": "agent_installArguments",
  "type": "object"
}
browser_api_map_buildBuild or update this organization's OpenAPI-style map from captured calls.
Input schema
{
  "properties": {
    "session_id": {
      "maxLength": 128,
      "minLength": 5,
      "pattern": "^bas_[A-Za-z0-9_-]+$",
      "title": "Session Id",
      "type": "string"
    },
    "host": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Host"
    },
    "url_contains": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Url Contains"
    },
    "method": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Method"
    }
  },
  "required": [
    "session_id"
  ],
  "title": "browser_api_map_buildArguments",
  "type": "object"
}
browser_api_map_getRead this organization's saved endpoint map as a tree, OpenAPI, or both.
Input schema
{
  "properties": {
    "session_id": {
      "maxLength": 128,
      "minLength": 5,
      "pattern": "^bas_[A-Za-z0-9_-]+$",
      "title": "Session Id",
      "type": "string"
    },
    "host": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Host"
    },
    "format": {
      "default": "both",
      "enum": [
        "tree",
        "openapi",
        "both"
      ],
      "title": "Format",
      "type": "string"
    }
  },
  "required": [
    "session_id"
  ],
  "title": "browser_api_map_getArguments",
  "type": "object"
}
browser_apply_draftSend the Browser Studio draft through the existing Planner step test path.
Input schema
{
  "properties": {
    "session_id": {
      "maxLength": 128,
      "minLength": 5,
      "pattern": "^bas_[A-Za-z0-9_-]+$",
      "title": "Session Id",
      "type": "string"
    },
    "edited_code": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Edited Code"
    }
  },
  "required": [
    "session_id"
  ],
  "title": "browser_apply_draftArguments",
  "type": "object"
}
browser_cancel_promptCancel the current Browser Copilot authoring turn.
Input schema
{
  "properties": {
    "session_id": {
      "maxLength": 128,
      "minLength": 5,
      "pattern": "^bas_[A-Za-z0-9_-]+$",
      "title": "Session Id",
      "type": "string"
    }
  },
  "required": [
    "session_id"
  ],
  "title": "browser_cancel_promptArguments",
  "type": "object"
}
browser_cdp_commandRun raw page-target CDP; it may expose cookies or page secrets.
Input schema
{
  "properties": {
    "session_id": {
      "maxLength": 128,
      "minLength": 5,
      "pattern": "^bas_[A-Za-z0-9_-]+$",
      "title": "Session Id",
      "type": "string"
    },
    "method": {
      "title": "Method",
      "type": "string"
    },
    "params": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Params"
    },
    "tab_id": {
      "anyOf": [
        {
          "exclusiveMinimum": 0,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Tab Id"
    }
  },
  "required": [
    "session_id",
    "method"
  ],
  "title": "browser_cdp_commandArguments",
  "type": "object"
}
browser_close_sessionClose a retained browser session and release its capacity allocation.
Input schema
{
  "properties": {
    "session_id": {
      "maxLength": 128,
      "minLength": 5,
      "pattern": "^bas_[A-Za-z0-9_-]+$",
      "title": "Session Id",
      "type": "string"
    }
  },
  "required": [
    "session_id"
  ],
  "title": "browser_close_sessionArguments",
  "type": "object"
}
browser_create_sessionCreate a retained Browser Studio session; returns scoped noVNC links.
Input schema
{
  "properties": {
    "build_id": {
      "maxLength": 200,
      "minLength": 6,
      "pattern": "^pbld_[A-Za-z0-9_-]+$",
      "title": "Build Id",
      "type": "string"
    },
    "step_number": {
      "exclusiveMinimum": 0,
      "title": "Step Number",
      "type": "integer"
    },
    "url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Url"
    },
    "credential_id": {
      "anyOf": [
        {
          "maxLength": 128,
          "minLength": 1,
          "pattern": "^[A-Za-z0-9_-]+$",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Credential Id"
    },
    "recorded_task_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Recorded Task Id"
    },
    "existing_code": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Existing Code"
    }
  },
  "required": [
    "build_id",
    "step_number"
  ],
  "title": "browser_create_sessionArguments",
  "type": "object"
}
browser_endpoint_observer_setStart or stop capturing API requests made by this browser session.
Input schema
{
  "properties": {
    "session_id": {
      "maxLength": 128,
      "minLength": 5,
      "pattern": "^bas_[A-Za-z0-9_-]+$",
      "title": "Session Id",
      "type": "string"
    },
    "enabled": {
      "default": true,
      "title": "Enabled",
      "type": "boolean"
    },
    "tab_id": {
      "anyOf": [
        {
          "exclusiveMinimum": 0,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Tab Id"
    }
  },
  "required": [
    "session_id"
  ],
  "title": "browser_endpoint_observer_setArguments",
  "type": "object"
}
browser_get_draftRead the reusable browser activity draft from a retained session.
Input schema
{
  "properties": {
    "session_id": {
      "maxLength": 128,
      "minLength": 5,
      "pattern": "^bas_[A-Za-z0-9_-]+$",
      "title": "Session Id",
      "type": "string"
    }
  },
  "required": [
    "session_id"
  ],
  "title": "browser_get_draftArguments",
  "type": "object"
}
browser_get_sessionRead session state and refreshed viewer/controller capabilities.
Input schema
{
  "properties": {
    "session_id": {
      "maxLength": 128,
      "minLength": 5,
      "pattern": "^bas_[A-Za-z0-9_-]+$",
      "title": "Session Id",
      "type": "string"
    }
  },
  "required": [
    "session_id"
  ],
  "title": "browser_get_sessionArguments",
  "type": "object"
}
browser_list_toolsList safe Browser Studio authoring commands.
Input schema
{
  "properties": {},
  "title": "browser_list_toolsArguments",
  "type": "object"
}
browser_observed_endpoint_getRead one captured request and response after secret-field redaction.
Input schema
{
  "properties": {
    "session_id": {
      "maxLength": 128,
      "minLength": 5,
      "pattern": "^bas_[A-Za-z0-9_-]+$",
      "title": "Session Id",
      "type": "string"
    },
    "storage_path": {
      "maxLength": 200,
      "minLength": 35,
      "pattern": "^local://observed-endpoint/ep_[A-Za-z0-9_-]+$",
      "title": "Storage Path",
      "type": "string"
    }
  },
  "required": [
    "session_id",
    "storage_path"
  ],
  "title": "browser_observed_endpoint_getArguments",
  "type": "object"
}
browser_observed_endpoints_listList a compact, redacted index of API requests captured in this session.
Input schema
{
  "properties": {
    "session_id": {
      "maxLength": 128,
      "minLength": 5,
      "pattern": "^bas_[A-Za-z0-9_-]+$",
      "title": "Session Id",
      "type": "string"
    },
    "url_contains": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Url Contains"
    },
    "method": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Method"
    },
    "status_code": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status Code"
    },
    "start_time": {
      "anyOf": [
        {
          "minimum": 0,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Start Time"
    },
    "end_time": {
      "anyOf": [
        {
          "minimum": 0,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "End Time"
    },
    "limit": {
      "default": 25,
      "maximum": 25,
      "minimum": 1,
      "title": "Limit",
      "type": "integer"
    }
  },
  "required": [
    "session_id"
  ],
  "title": "browser_observed_endpoints_listArguments",
  "type": "object"
}
browser_promptAsk Browser Studio to author or revise reusable browser activity code.
Input schema
{
  "properties": {
    "session_id": {
      "maxLength": 128,
      "minLength": 5,
      "pattern": "^bas_[A-Za-z0-9_-]+$",
      "title": "Session Id",
      "type": "string"
    },
    "prompt": {
      "title": "Prompt",
      "type": "string"
    }
  },
  "required": [
    "session_id",
    "prompt"
  ],
  "title": "browser_promptArguments",
  "type": "object"
}
browser_run_commandRun one safe Browser Studio command in a retained session.
Input schema
{
  "properties": {
    "session_id": {
      "maxLength": 128,
      "minLength": 5,
      "pattern": "^bas_[A-Za-z0-9_-]+$",
      "title": "Session Id",
      "type": "string"
    },
    "tool": {
      "title": "Tool",
      "type": "string"
    },
    "input": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Input"
    },
    "tab_id": {
      "anyOf": [
        {
          "exclusiveMinimum": 0,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Tab Id"
    },
    "url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Url"
    }
  },
  "required": [
    "session_id",
    "tool"
  ],
  "title": "browser_run_commandArguments",
  "type": "object"
}
browser_set_controlSwitch a browser session between human and shared control.
Input schema
{
  "properties": {
    "session_id": {
      "maxLength": 128,
      "minLength": 5,
      "pattern": "^bas_[A-Za-z0-9_-]+$",
      "title": "Session Id",
      "type": "string"
    },
    "mode": {
      "enum": [
        "human",
        "shared"
      ],
      "title": "Mode",
      "type": "string"
    }
  },
  "required": [
    "session_id",
    "mode"
  ],
  "title": "browser_set_controlArguments",
  "type": "object"
}
catalog_get_agentInspect one catalog agent, including exact setup and input schemas.
Input schema
{
  "properties": {
    "agent_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Agent Id",
      "type": "string"
    }
  },
  "required": [
    "agent_id"
  ],
  "title": "catalog_get_agentArguments",
  "type": "object"
}
catalog_list_agentsList published agent versions entitled to this organization.
Input schema
{
  "properties": {},
  "title": "catalog_list_agentsArguments",
  "type": "object"
}
credentials_createCreate a secure credential reference without echoing secrets.
Input schema
{
  "properties": {
    "domain": {
      "title": "Domain",
      "type": "string"
    },
    "site_name": {
      "title": "Site Name",
      "type": "string"
    },
    "username": {
      "title": "Username",
      "type": "string"
    },
    "password": {
      "title": "Password",
      "type": "string"
    },
    "login_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Login Url"
    },
    "totp": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Totp"
    },
    "pin": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Pin"
    },
    "sms_phone_type": {
      "default": "voip",
      "enum": [
        "voip",
        "real_sim"
      ],
      "title": "Sms Phone Type",
      "type": "string"
    },
    "notes": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Notes"
    }
  },
  "required": [
    "domain",
    "site_name",
    "username",
    "password"
  ],
  "title": "credentials_createArguments",
  "type": "object"
}
credentials_getRead one visible Password Vault reference without secret material.
Input schema
{
  "properties": {
    "credential_id": {
      "maxLength": 128,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_-]+$",
      "title": "Credential Id",
      "type": "string"
    }
  },
  "required": [
    "credential_id"
  ],
  "title": "credentials_getArguments",
  "type": "object"
}
credentials_listList visible Password Vault references without secrets. Match on site_name, domain, and username, then pass the exact credential_id to Planner. Integration Factory still requires an API-managed reference created through credentials_create. Ask the user when zero or multiple entries match; never guess a credential.
Input schema
{
  "properties": {},
  "title": "credentials_listArguments",
  "type": "object"
}
credentials_revokeRevoke a credential, delete its vault secret, and invalidate sessions.
Input schema
{
  "properties": {
    "credential_id": {
      "maxLength": 128,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_-]+$",
      "title": "Credential Id",
      "type": "string"
    }
  },
  "required": [
    "credential_id"
  ],
  "title": "credentials_revokeArguments",
  "type": "object"
}
credentials_rotateReplace a stored secret and revoke sessions using the old version.
Input schema
{
  "properties": {
    "credential_id": {
      "maxLength": 128,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_-]+$",
      "title": "Credential Id",
      "type": "string"
    },
    "password": {
      "title": "Password",
      "type": "string"
    },
    "site_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Site Name"
    },
    "username": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Username"
    },
    "login_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Login Url"
    },
    "totp": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Totp"
    },
    "pin": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Pin"
    },
    "sms_phone_type": {
      "anyOf": [
        {
          "enum": [
            "voip",
            "real_sim"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Sms Phone Type"
    },
    "notes": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Notes"
    }
  },
  "required": [
    "credential_id",
    "password"
  ],
  "title": "credentials_rotateArguments",
  "type": "object"
}
custom_agent_request_createCreate a hosted partner form for an agent XY will build.
Input schema
{
  "properties": {
    "name": {
      "title": "Name",
      "type": "string"
    },
    "specification": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Specification"
    },
    "systems": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Systems"
    },
    "trigger": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Trigger"
    },
    "expected_output": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Expected Output"
    },
    "completion_criteria": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Completion Criteria"
    },
    "sample_inputs": {
      "anyOf": [
        {
          "items": {},
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Sample Inputs"
    },
    "idempotency_key": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Idempotency Key"
    }
  },
  "required": [
    "name"
  ],
  "title": "custom_agent_request_createArguments",
  "type": "object"
}
custom_agent_request_getRead hosted-form, review, clarification, and delivery state.
Input schema
{
  "properties": {
    "request_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Request Id",
      "type": "string"
    }
  },
  "required": [
    "request_id"
  ],
  "title": "custom_agent_request_getArguments",
  "type": "object"
}
custom_agent_request_messageAnswer an XY clarification or add context to a submitted request.
Input schema
{
  "properties": {
    "request_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Request Id",
      "type": "string"
    },
    "message": {
      "title": "Message",
      "type": "string"
    },
    "idempotency_key": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Idempotency Key"
    }
  },
  "required": [
    "request_id",
    "message"
  ],
  "title": "custom_agent_request_messageArguments",
  "type": "object"
}
dashboard_agent_queryAsk the governed dashboard agent a read-only analytics question.
Input schema
{
  "properties": {
    "prompt": {
      "title": "Prompt",
      "type": "string"
    },
    "workflow_definition_id": {
      "anyOf": [
        {
          "maxLength": 500,
          "minLength": 1,
          "pattern": "^[A-Za-z0-9_.:-]+$",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Workflow Definition Id"
    },
    "workflow_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Workflow Name"
    },
    "session_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Session Id"
    }
  },
  "required": [
    "prompt"
  ],
  "title": "dashboard_agent_queryArguments",
  "type": "object"
}
execution_get_phasesRead safe phase status for a catalog-agent execution.
Input schema
{
  "properties": {
    "execution_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Execution Id",
      "type": "string"
    }
  },
  "required": [
    "execution_id"
  ],
  "title": "execution_get_phasesArguments",
  "type": "object"
}
installation_getRead provisioning, connection, source, and readiness state.
Input schema
{
  "properties": {
    "installation_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Installation Id",
      "type": "string"
    }
  },
  "required": [
    "installation_id"
  ],
  "title": "installation_getArguments",
  "type": "object"
}
installation_list_authorizationsList authorization actions and their current states.
Input schema
{
  "properties": {
    "installation_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Installation Id",
      "type": "string"
    }
  },
  "required": [
    "installation_id"
  ],
  "title": "installation_list_authorizationsArguments",
  "type": "object"
}
installation_start_authorizationCreate a short-lived hosted authorization link for a required connection.
Input schema
{
  "properties": {
    "installation_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Installation Id",
      "type": "string"
    },
    "connection": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Connection"
    }
  },
  "required": [
    "installation_id"
  ],
  "title": "installation_start_authorizationArguments",
  "type": "object"
}
integration_factory_capability_test_getRead one durable generated-capability test and its redacted result.
Input schema
{
  "properties": {
    "run_id": {
      "maxLength": 128,
      "minLength": 8,
      "pattern": "^ifrun_[A-Za-z0-9_-]+$",
      "title": "Run Id",
      "type": "string"
    },
    "test_id": {
      "title": "Test Id",
      "type": "string"
    }
  },
  "required": [
    "run_id",
    "test_id"
  ],
  "title": "integration_factory_capability_test_getArguments",
  "type": "object"
}
integration_factory_extendDiscover capabilities to add to an org-owned factory integration.
Input schema
{
  "properties": {
    "type_key": {
      "maxLength": 80,
      "minLength": 1,
      "pattern": "^[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*$",
      "title": "Type Key",
      "type": "string"
    },
    "documentation_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Documentation Url"
    },
    "documentation": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Documentation"
    },
    "upload_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Upload Id"
    },
    "custom_instructions": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Custom Instructions"
    },
    "idempotency_key": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Idempotency Key"
    }
  },
  "required": [
    "type_key"
  ],
  "title": "integration_factory_extendArguments",
  "type": "object"
}
integration_factory_generateGenerate selected discovered endpoints into a new integration draft.
Input schema
{
  "properties": {
    "run_id": {
      "maxLength": 128,
      "minLength": 8,
      "pattern": "^ifrun_[A-Za-z0-9_-]+$",
      "title": "Run Id",
      "type": "string"
    },
    "endpoints": {
      "items": {
        "type": "string"
      },
      "maxItems": 20,
      "minItems": 1,
      "title": "Endpoints",
      "type": "array"
    },
    "state_version": {
      "exclusiveMinimum": 0,
      "title": "State Version",
      "type": "integer"
    },
    "base_path": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Base Path"
    },
    "auth_type": {
      "anyOf": [
        {
          "enum": [
            "NONE",
            "API_KEY",
            "BASIC_AUTH",
            "BEARER_TOKEN",
            "CLIENT_CREDENTIALS"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Auth Type"
    }
  },
  "required": [
    "run_id",
    "endpoints",
    "state_version"
  ],
  "title": "integration_factory_generateArguments",
  "type": "object"
}
integration_factory_promoteMake a validated, explicitly tested draft live only for this organization.
Input schema
{
  "properties": {
    "run_id": {
      "maxLength": 128,
      "minLength": 8,
      "pattern": "^ifrun_[A-Za-z0-9_-]+$",
      "title": "Run Id",
      "type": "string"
    },
    "state_version": {
      "exclusiveMinimum": 0,
      "title": "State Version",
      "type": "integer"
    }
  },
  "required": [
    "run_id",
    "state_version"
  ],
  "title": "integration_factory_promoteArguments",
  "type": "object"
}
integration_factory_run_getRead discovery, generation, validation, or promotion state for a run.
Input schema
{
  "properties": {
    "run_id": {
      "maxLength": 128,
      "minLength": 8,
      "pattern": "^ifrun_[A-Za-z0-9_-]+$",
      "title": "Run Id",
      "type": "string"
    }
  },
  "required": [
    "run_id"
  ],
  "title": "integration_factory_run_getArguments",
  "type": "object"
}
integration_factory_test_capabilityDurably test one generated capability before organization promotion. Set confirm_side_effects=true only after accepting that the upstream API call may create, update, trigger, or delete real external data.
Input schema
{
  "properties": {
    "run_id": {
      "maxLength": 128,
      "minLength": 8,
      "pattern": "^ifrun_[A-Za-z0-9_-]+$",
      "title": "Run Id",
      "type": "string"
    },
    "capability_key": {
      "title": "Capability Key",
      "type": "string"
    },
    "state_version": {
      "exclusiveMinimum": 0,
      "title": "State Version",
      "type": "integer"
    },
    "params": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Params"
    },
    "credential_id": {
      "anyOf": [
        {
          "maxLength": 128,
          "minLength": 1,
          "pattern": "^[A-Za-z0-9_-]+$",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Credential Id"
    },
    "confirm_side_effects": {
      "default": false,
      "title": "Confirm Side Effects",
      "type": "boolean"
    },
    "idempotency_key": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Idempotency Key"
    }
  },
  "required": [
    "run_id",
    "capability_key",
    "state_version"
  ],
  "title": "integration_factory_test_capabilityArguments",
  "type": "object"
}
integration_factory_validateValidate a generated draft with an org-owned encrypted credential.
Input schema
{
  "properties": {
    "run_id": {
      "maxLength": 128,
      "minLength": 8,
      "pattern": "^ifrun_[A-Za-z0-9_-]+$",
      "title": "Run Id",
      "type": "string"
    },
    "state_version": {
      "exclusiveMinimum": 0,
      "title": "State Version",
      "type": "integer"
    },
    "credential_id": {
      "anyOf": [
        {
          "maxLength": 128,
          "minLength": 1,
          "pattern": "^[A-Za-z0-9_-]+$",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Credential Id"
    }
  },
  "required": [
    "run_id",
    "state_version"
  ],
  "title": "integration_factory_validateArguments",
  "type": "object"
}
integration_getRead one live integration and its current executable capabilities.
Input schema
{
  "properties": {
    "type_key": {
      "maxLength": 80,
      "minLength": 1,
      "pattern": "^[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*$",
      "title": "Type Key",
      "type": "string"
    }
  },
  "required": [
    "type_key"
  ],
  "title": "integration_getArguments",
  "type": "object"
}
knowledge_source_add_urlAttach and index a public website in a Knowledge Base installation.
Input schema
{
  "properties": {
    "installation_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Installation Id",
      "type": "string"
    },
    "url": {
      "title": "Url",
      "type": "string"
    },
    "crawl_limit": {
      "default": 50,
      "maximum": 500,
      "minimum": 1,
      "title": "Crawl Limit",
      "type": "integer"
    },
    "idempotency_key": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Idempotency Key"
    }
  },
  "required": [
    "installation_id",
    "url"
  ],
  "title": "knowledge_source_add_urlArguments",
  "type": "object"
}
knowledge_source_batch_cancelCancel queued creation work for a Knowledge Base source batch.
Input schema
{
  "properties": {
    "installation_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Installation Id",
      "type": "string"
    },
    "batch_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Batch Id",
      "type": "string"
    }
  },
  "required": [
    "installation_id",
    "batch_id"
  ],
  "title": "knowledge_source_batch_cancelArguments",
  "type": "object"
}
knowledge_source_batch_completeQueue completion checks for uploaded file items in a source batch.
Input schema
{
  "properties": {
    "installation_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Installation Id",
      "type": "string"
    },
    "batch_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Batch Id",
      "type": "string"
    }
  },
  "required": [
    "installation_id",
    "batch_id"
  ],
  "title": "knowledge_source_batch_completeArguments",
  "type": "object"
}
knowledge_source_batch_createQueue bulk creation of Knowledge Base file and URL sources.
Input schema
{
  "properties": {
    "installation_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Installation Id",
      "type": "string"
    },
    "sources": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Sources",
      "type": "array"
    },
    "max_concurrency": {
      "default": 5,
      "maximum": 10,
      "minimum": 1,
      "title": "Max Concurrency",
      "type": "integer"
    },
    "idempotency_key": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Idempotency Key"
    }
  },
  "required": [
    "installation_id",
    "sources"
  ],
  "title": "knowledge_source_batch_createArguments",
  "type": "object"
}
knowledge_source_batch_getRead item-level state for a Knowledge Base source batch.
Input schema
{
  "properties": {
    "installation_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Installation Id",
      "type": "string"
    },
    "batch_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Batch Id",
      "type": "string"
    }
  },
  "required": [
    "installation_id",
    "batch_id"
  ],
  "title": "knowledge_source_batch_getArguments",
  "type": "object"
}
knowledge_source_batch_upload_actionsCreate fresh signed upload actions for pending file items in a batch.
Input schema
{
  "properties": {
    "installation_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Installation Id",
      "type": "string"
    },
    "batch_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Batch Id",
      "type": "string"
    }
  },
  "required": [
    "installation_id",
    "batch_id"
  ],
  "title": "knowledge_source_batch_upload_actionsArguments",
  "type": "object"
}
knowledge_source_complete_uploadConfirm a signed file upload and start ingestion and indexing.
Input schema
{
  "properties": {
    "installation_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Installation Id",
      "type": "string"
    },
    "source_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Source Id",
      "type": "string"
    }
  },
  "required": [
    "installation_id",
    "source_id"
  ],
  "title": "knowledge_source_complete_uploadArguments",
  "type": "object"
}
knowledge_source_create_file_uploadCreate a signed upload target for a Knowledge Base file source.
Input schema
{
  "properties": {
    "installation_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Installation Id",
      "type": "string"
    },
    "file_name": {
      "title": "File Name",
      "type": "string"
    },
    "content_type": {
      "title": "Content Type",
      "type": "string"
    },
    "idempotency_key": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Idempotency Key"
    }
  },
  "required": [
    "installation_id",
    "file_name",
    "content_type"
  ],
  "title": "knowledge_source_create_file_uploadArguments",
  "type": "object"
}
knowledge_source_deleteDelete a Knowledge Base source and its indexed content.
Input schema
{
  "properties": {
    "installation_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Installation Id",
      "type": "string"
    },
    "source_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Source Id",
      "type": "string"
    }
  },
  "required": [
    "installation_id",
    "source_id"
  ],
  "title": "knowledge_source_deleteArguments",
  "type": "object"
}
knowledge_source_getRead upload or indexing state for one Knowledge Base source.
Input schema
{
  "properties": {
    "installation_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Installation Id",
      "type": "string"
    },
    "source_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Source Id",
      "type": "string"
    }
  },
  "required": [
    "installation_id",
    "source_id"
  ],
  "title": "knowledge_source_getArguments",
  "type": "object"
}
knowledge_sources_listList every source and indexing state for a Knowledge Base installation.
Input schema
{
  "properties": {
    "installation_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Installation Id",
      "type": "string"
    }
  },
  "required": [
    "installation_id"
  ],
  "title": "knowledge_sources_listArguments",
  "type": "object"
}
planner_abandonQueue irreversible abandonment of a Planner build.
Input schema
{
  "properties": {
    "build_id": {
      "maxLength": 200,
      "minLength": 6,
      "pattern": "^pbld_[A-Za-z0-9_-]+$",
      "title": "Build Id",
      "type": "string"
    },
    "state_version": {
      "exclusiveMinimum": 0,
      "title": "State Version",
      "type": "integer"
    },
    "idempotency_key": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Idempotency Key"
    }
  },
  "required": [
    "build_id",
    "state_version"
  ],
  "title": "planner_abandonArguments",
  "type": "object"
}
planner_accept_stepExplicitly accept the reviewed step, optionally with reviewed edits.
Input schema
{
  "properties": {
    "build_id": {
      "maxLength": 200,
      "minLength": 6,
      "pattern": "^pbld_[A-Za-z0-9_-]+$",
      "title": "Build Id",
      "type": "string"
    },
    "step_number": {
      "exclusiveMinimum": 0,
      "title": "Step Number",
      "type": "integer"
    },
    "state_version": {
      "exclusiveMinimum": 0,
      "title": "State Version",
      "type": "integer"
    },
    "edited_code": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Edited Code"
    },
    "edited_yaml_params": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Edited Yaml Params"
    },
    "idempotency_key": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Idempotency Key"
    }
  },
  "required": [
    "build_id",
    "step_number",
    "state_version"
  ],
  "title": "planner_accept_stepArguments",
  "type": "object"
}
planner_assist_stepAsk Build Copilot for a proposed edit without mutating the build.
Input schema
{
  "properties": {
    "build_id": {
      "maxLength": 200,
      "minLength": 6,
      "pattern": "^pbld_[A-Za-z0-9_-]+$",
      "title": "Build Id",
      "type": "string"
    },
    "step_number": {
      "exclusiveMinimum": 0,
      "title": "Step Number",
      "type": "integer"
    },
    "prompt": {
      "title": "Prompt",
      "type": "string"
    },
    "current_code": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Current Code"
    },
    "current_yaml": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Current Yaml"
    },
    "editor_session_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Editor Session Id"
    }
  },
  "required": [
    "build_id",
    "step_number",
    "prompt"
  ],
  "title": "planner_assist_stepArguments",
  "type": "object"
}
planner_cancel_stepSynchronously cancel a running test; repeating this is safe.
Input schema
{
  "properties": {
    "build_id": {
      "maxLength": 200,
      "minLength": 6,
      "pattern": "^pbld_[A-Za-z0-9_-]+$",
      "title": "Build Id",
      "type": "string"
    },
    "step_number": {
      "exclusiveMinimum": 0,
      "title": "Step Number",
      "type": "integer"
    }
  },
  "required": [
    "build_id",
    "step_number"
  ],
  "title": "planner_cancel_stepArguments",
  "type": "object"
}
planner_export_buildExport a redacted Planner journey fixture for debugging or re-seeding.
Input schema
{
  "properties": {
    "build_id": {
      "maxLength": 200,
      "minLength": 6,
      "pattern": "^pbld_[A-Za-z0-9_-]+$",
      "title": "Build Id",
      "type": "string"
    }
  },
  "required": [
    "build_id"
  ],
  "title": "planner_export_buildArguments",
  "type": "object"
}
planner_get_browser_sessionRefresh scoped noVNC viewer/controller links for a Planner browser step.
Input schema
{
  "properties": {
    "build_id": {
      "maxLength": 200,
      "minLength": 6,
      "pattern": "^pbld_[A-Za-z0-9_-]+$",
      "title": "Build Id",
      "type": "string"
    },
    "step_number": {
      "exclusiveMinimum": 0,
      "title": "Step Number",
      "type": "integer"
    }
  },
  "required": [
    "build_id",
    "step_number"
  ],
  "title": "planner_get_browser_sessionArguments",
  "type": "object"
}
planner_get_buildRead the durable build projection and current Planner step state.
Input schema
{
  "properties": {
    "build_id": {
      "maxLength": 200,
      "minLength": 6,
      "pattern": "^pbld_[A-Za-z0-9_-]+$",
      "title": "Build Id",
      "type": "string"
    }
  },
  "required": [
    "build_id"
  ],
  "title": "planner_get_buildArguments",
  "type": "object"
}
planner_get_eventsReplay durable build events after an exclusive integer cursor.
Input schema
{
  "properties": {
    "build_id": {
      "maxLength": 200,
      "minLength": 6,
      "pattern": "^pbld_[A-Za-z0-9_-]+$",
      "title": "Build Id",
      "type": "string"
    },
    "after": {
      "default": 0,
      "minimum": 0,
      "title": "After",
      "type": "integer"
    },
    "limit": {
      "default": 100,
      "exclusiveMinimum": 0,
      "title": "Limit",
      "type": "integer"
    }
  },
  "required": [
    "build_id"
  ],
  "title": "planner_get_eventsArguments",
  "type": "object"
}
planner_list_buildsList this API key organization's durable Planner builds.
Input schema
{
  "properties": {
    "limit": {
      "default": 50,
      "exclusiveMinimum": 0,
      "title": "Limit",
      "type": "integer"
    },
    "cursor": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Cursor"
    },
    "status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status"
    }
  },
  "title": "planner_list_buildsArguments",
  "type": "object"
}
planner_message_stepSend non-accepting feedback to the Planner for the current step.
Input schema
{
  "properties": {
    "build_id": {
      "maxLength": 200,
      "minLength": 6,
      "pattern": "^pbld_[A-Za-z0-9_-]+$",
      "title": "Build Id",
      "type": "string"
    },
    "step_number": {
      "exclusiveMinimum": 0,
      "title": "Step Number",
      "type": "integer"
    },
    "state_version": {
      "exclusiveMinimum": 0,
      "title": "State Version",
      "type": "integer"
    },
    "comment": {
      "title": "Comment",
      "type": "string"
    },
    "idempotency_key": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Idempotency Key"
    }
  },
  "required": [
    "build_id",
    "step_number",
    "state_version",
    "comment"
  ],
  "title": "planner_message_stepArguments",
  "type": "object"
}
planner_promoteExplicitly promote a completed build into a production definition.
Input schema
{
  "properties": {
    "build_id": {
      "maxLength": 200,
      "minLength": 6,
      "pattern": "^pbld_[A-Za-z0-9_-]+$",
      "title": "Build Id",
      "type": "string"
    },
    "state_version": {
      "exclusiveMinimum": 0,
      "title": "State Version",
      "type": "integer"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Name"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Description"
    },
    "idempotency_key": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Idempotency Key"
    }
  },
  "required": [
    "build_id",
    "state_version"
  ],
  "title": "planner_promoteArguments",
  "type": "object"
}
planner_reject_stepReject the reviewed step with required repair instructions.
Input schema
{
  "properties": {
    "build_id": {
      "maxLength": 200,
      "minLength": 6,
      "pattern": "^pbld_[A-Za-z0-9_-]+$",
      "title": "Build Id",
      "type": "string"
    },
    "step_number": {
      "exclusiveMinimum": 0,
      "title": "Step Number",
      "type": "integer"
    },
    "state_version": {
      "exclusiveMinimum": 0,
      "title": "State Version",
      "type": "integer"
    },
    "comment": {
      "title": "Comment",
      "type": "string"
    },
    "idempotency_key": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Idempotency Key"
    }
  },
  "required": [
    "build_id",
    "step_number",
    "state_version",
    "comment"
  ],
  "title": "planner_reject_stepArguments",
  "type": "object"
}
planner_respond_to_planReview the generated overall plan before any step starts. APPROVE allows Planner step execution to begin. REJECT requires a nonblank comment describing how to revise the plan. This queues a durable command; it does not accept an individual step, promote a workflow, or approve or publish a Queue UI design.
Input schema
{
  "properties": {
    "build_id": {
      "maxLength": 200,
      "minLength": 6,
      "pattern": "^pbld_[A-Za-z0-9_-]+$",
      "title": "Build Id",
      "type": "string"
    },
    "action": {
      "enum": [
        "APPROVE",
        "REJECT"
      ],
      "title": "Action",
      "type": "string"
    },
    "state_version": {
      "exclusiveMinimum": 0,
      "title": "State Version",
      "type": "integer"
    },
    "comment": {
      "anyOf": [
        {
          "maxLength": 20000,
          "pattern": "\\S",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Comment"
    },
    "idempotency_key": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Idempotency Key"
    }
  },
  "required": [
    "build_id",
    "action",
    "state_version"
  ],
  "title": "planner_respond_to_planArguments",
  "type": "object"
}
planner_resumeQueue resume for an interrupted durable build.
Input schema
{
  "properties": {
    "build_id": {
      "maxLength": 200,
      "minLength": 6,
      "pattern": "^pbld_[A-Za-z0-9_-]+$",
      "title": "Build Id",
      "type": "string"
    },
    "state_version": {
      "exclusiveMinimum": 0,
      "title": "State Version",
      "type": "integer"
    },
    "idempotency_key": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Idempotency Key"
    }
  },
  "required": [
    "build_id",
    "state_version"
  ],
  "title": "planner_resumeArguments",
  "type": "object"
}
planner_retry_stepRegenerate and retest the current step through the existing Planner.
Input schema
{
  "properties": {
    "build_id": {
      "maxLength": 200,
      "minLength": 6,
      "pattern": "^pbld_[A-Za-z0-9_-]+$",
      "title": "Build Id",
      "type": "string"
    },
    "step_number": {
      "exclusiveMinimum": 0,
      "title": "Step Number",
      "type": "integer"
    },
    "state_version": {
      "exclusiveMinimum": 0,
      "title": "State Version",
      "type": "integer"
    },
    "idempotency_key": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Idempotency Key"
    }
  },
  "required": [
    "build_id",
    "step_number",
    "state_version"
  ],
  "title": "planner_retry_stepArguments",
  "type": "object"
}
planner_save_templateSave a completed build as an organization workflow template.
Input schema
{
  "properties": {
    "build_id": {
      "maxLength": 200,
      "minLength": 6,
      "pattern": "^pbld_[A-Za-z0-9_-]+$",
      "title": "Build Id",
      "type": "string"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Name"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Description"
    },
    "category": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Category"
    }
  },
  "required": [
    "build_id"
  ],
  "title": "planner_save_templateArguments",
  "type": "object"
}
planner_set_browser_controlSwitch a Planner browser step between human and shared control.
Input schema
{
  "properties": {
    "build_id": {
      "maxLength": 200,
      "minLength": 6,
      "pattern": "^pbld_[A-Za-z0-9_-]+$",
      "title": "Build Id",
      "type": "string"
    },
    "step_number": {
      "exclusiveMinimum": 0,
      "title": "Step Number",
      "type": "integer"
    },
    "mode": {
      "enum": [
        "human",
        "shared"
      ],
      "title": "Mode",
      "type": "string"
    }
  },
  "required": [
    "build_id",
    "step_number",
    "mode"
  ],
  "title": "planner_set_browser_controlArguments",
  "type": "object"
}
planner_start_buildQueue a durable Planner build and return its public build ID. Set ``context.recorded_task_id`` to use an organization-owned Browser Agent recording as build context. The Planner resolves its transcript, action log, and existing code through the same organization-scoped FDE Planner path used by the web app; credentials remain separate references. Retain the required idempotency_key before admission so an ambiguous response can be recovered safely. Save the returned build_id and reconnect with build/event reads after later disconnects.
Input schema
{
  "properties": {
    "request": {
      "title": "Request",
      "type": "string"
    },
    "idempotency_key": {
      "maxLength": 200,
      "minLength": 1,
      "title": "Idempotency Key",
      "type": "string"
    },
    "context": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Context"
    },
    "existing_yaml": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Existing Yaml"
    },
    "modification_instructions": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Modification Instructions"
    }
  },
  "required": [
    "request",
    "idempotency_key"
  ],
  "title": "planner_start_buildArguments",
  "type": "object"
}
planner_test_stepTest reviewed code or YAML without accepting the step.
Input schema
{
  "properties": {
    "build_id": {
      "maxLength": 200,
      "minLength": 6,
      "pattern": "^pbld_[A-Za-z0-9_-]+$",
      "title": "Build Id",
      "type": "string"
    },
    "step_number": {
      "exclusiveMinimum": 0,
      "title": "Step Number",
      "type": "integer"
    },
    "state_version": {
      "exclusiveMinimum": 0,
      "title": "State Version",
      "type": "integer"
    },
    "edited_code": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Edited Code"
    },
    "edited_yaml_params": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Edited Yaml Params"
    },
    "idempotency_key": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Idempotency Key"
    }
  },
  "required": [
    "build_id",
    "step_number",
    "state_version"
  ],
  "title": "planner_test_stepArguments",
  "type": "object"
}
planner_usageRead this organization's Planner, browser, and model-cost quota usage.
Input schema
{
  "properties": {},
  "title": "planner_usageArguments",
  "type": "object"
}
planner_wait_for_eventsBounded polling wait for durable events; safe after disconnect/restart.
Input schema
{
  "properties": {
    "build_id": {
      "maxLength": 200,
      "minLength": 6,
      "pattern": "^pbld_[A-Za-z0-9_-]+$",
      "title": "Build Id",
      "type": "string"
    },
    "after": {
      "minimum": 0,
      "title": "After",
      "type": "integer"
    },
    "timeout_seconds": {
      "default": 20,
      "exclusiveMinimum": 0,
      "title": "Timeout Seconds",
      "type": "integer"
    },
    "limit": {
      "default": 100,
      "exclusiveMinimum": 0,
      "title": "Limit",
      "type": "integer"
    }
  },
  "required": [
    "build_id",
    "after"
  ],
  "title": "planner_wait_for_eventsArguments",
  "type": "object"
}
queue_ui_approveApprove this exact design version and its returned 16-character resolved_yaml_hash using a system API key with explicit approval authority. Supply the current publication.live_version_id receipt, or explicit null before first publication, as expected_live_version_id; stale approval is rejected. This records system approval, not human review or approval by the key creator. It does not publish; personal keys and user-bound OAuth cannot use this operation.
Input schema
{
  "properties": {
    "session_id": {
      "maxLength": 200,
      "pattern": "^qds_[A-Za-z0-9_-]+$",
      "title": "Session Id",
      "type": "string"
    },
    "version_id": {
      "maxLength": 200,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_-]+$",
      "title": "Version Id",
      "type": "string"
    },
    "resolved_yaml_hash": {
      "maxLength": 16,
      "minLength": 16,
      "pattern": "^[0-9a-f]{16}$",
      "title": "Resolved Yaml Hash",
      "type": "string"
    },
    "expected_live_version_id": {
      "anyOf": [
        {
          "maxLength": 200,
          "minLength": 1,
          "pattern": "^[A-Za-z0-9_-]+$",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Expected Live Version Id"
    }
  },
  "required": [
    "session_id",
    "version_id",
    "resolved_yaml_hash",
    "expected_live_version_id"
  ],
  "title": "queue_ui_approveArguments",
  "type": "object"
}
queue_ui_cancel_runStop the selected or current generation run. Saved versions and previews remain available.
Input schema
{
  "properties": {
    "session_id": {
      "maxLength": 200,
      "pattern": "^qds_[A-Za-z0-9_-]+$",
      "title": "Session Id",
      "type": "string"
    },
    "run_id": {
      "anyOf": [
        {
          "maxLength": 200,
          "minLength": 1,
          "pattern": "^[A-Za-z0-9_-]+$",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Run Id"
    }
  },
  "required": [
    "session_id"
  ],
  "title": "queue_ui_cancel_runArguments",
  "type": "object"
}
queue_ui_cleanup_previewsFinish this design session and clean up its temporary previews. This closes the session before cleanup: no further messages or publishing are allowed. Start a fresh session to design again. Versions, publication history, and the live queue remain intact; cleanup retries and rollback still work.
Input schema
{
  "properties": {
    "session_id": {
      "maxLength": 200,
      "pattern": "^qds_[A-Za-z0-9_-]+$",
      "title": "Session Id",
      "type": "string"
    }
  },
  "required": [
    "session_id"
  ],
  "title": "queue_ui_cleanup_previewsArguments",
  "type": "object"
}
queue_ui_get_designCheck a design's progress, current version, review link, and live publication.
Input schema
{
  "properties": {
    "session_id": {
      "maxLength": 200,
      "pattern": "^qds_[A-Za-z0-9_-]+$",
      "title": "Session Id",
      "type": "string"
    }
  },
  "required": [
    "session_id"
  ],
  "title": "queue_ui_get_designArguments",
  "type": "object"
}
queue_ui_get_eventsRead saved progress for a generation run. Keep run_id and after_seq together; start at zero for a new run. After a connection failure, inspect state and events instead of blindly sending another mutation. Generation is not approval or publication.
Input schema
{
  "properties": {
    "session_id": {
      "maxLength": 200,
      "pattern": "^qds_[A-Za-z0-9_-]+$",
      "title": "Session Id",
      "type": "string"
    },
    "run_id": {
      "anyOf": [
        {
          "maxLength": 200,
          "minLength": 1,
          "pattern": "^[A-Za-z0-9_-]+$",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Run Id"
    },
    "after_seq": {
      "default": 0,
      "minimum": 0,
      "title": "After Seq",
      "type": "integer"
    },
    "limit": {
      "default": 100,
      "maximum": 100,
      "minimum": 1,
      "title": "Limit",
      "type": "integer"
    }
  },
  "required": [
    "session_id"
  ],
  "title": "queue_ui_get_eventsArguments",
  "type": "object"
}
queue_ui_get_versionInspect one exact saved version and open its preview for human review.
Input schema
{
  "properties": {
    "session_id": {
      "maxLength": 200,
      "pattern": "^qds_[A-Za-z0-9_-]+$",
      "title": "Session Id",
      "type": "string"
    },
    "version_id": {
      "maxLength": 200,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_-]+$",
      "title": "Version Id",
      "type": "string"
    }
  },
  "required": [
    "session_id",
    "version_id"
  ],
  "title": "queue_ui_get_versionArguments",
  "type": "object"
}
queue_ui_list_designsFind your saved queue designs and their generation or review status.
Input schema
{
  "properties": {
    "limit": {
      "default": 50,
      "maximum": 100,
      "minimum": 1,
      "title": "Limit",
      "type": "integer"
    },
    "cursor": {
      "anyOf": [
        {
          "maxLength": 500,
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Cursor"
    }
  },
  "title": "queue_ui_list_designsArguments",
  "type": "object"
}
queue_ui_list_targetsFind workflows whose operator screens your personal or system credential may design.
Input schema
{
  "properties": {
    "limit": {
      "default": 50,
      "maximum": 100,
      "minimum": 1,
      "title": "Limit",
      "type": "integer"
    },
    "cursor": {
      "anyOf": [
        {
          "maxLength": 500,
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Cursor"
    }
  },
  "title": "queue_ui_list_targetsArguments",
  "type": "object"
}
queue_ui_list_versionsCompare saved design versions, validation results, and preview links.
Input schema
{
  "properties": {
    "session_id": {
      "maxLength": 200,
      "pattern": "^qds_[A-Za-z0-9_-]+$",
      "title": "Session Id",
      "type": "string"
    },
    "limit": {
      "default": 50,
      "maximum": 100,
      "minimum": 1,
      "title": "Limit",
      "type": "integer"
    },
    "cursor": {
      "anyOf": [
        {
          "maxLength": 500,
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Cursor"
    }
  },
  "required": [
    "session_id"
  ],
  "title": "queue_ui_list_versionsArguments",
  "type": "object"
}
queue_ui_publishPublish an exact approved design version_id with authorized personal or system access. Personal publication also requires an ADMIN, PARTNER, or STAFF organization role plus explicit workflow configure permission; a scope alone is not enough. expected_live_version_id is the publication.live_version_id receipt, or null before first publication, not a design version. Approval and target publication permission are checked separately. Cannot approve a design or publish from a closed session.
Input schema
{
  "properties": {
    "session_id": {
      "maxLength": 200,
      "pattern": "^qds_[A-Za-z0-9_-]+$",
      "title": "Session Id",
      "type": "string"
    },
    "version_id": {
      "maxLength": 200,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_-]+$",
      "title": "Version Id",
      "type": "string"
    },
    "expected_live_version_id": {
      "anyOf": [
        {
          "maxLength": 200,
          "minLength": 1,
          "pattern": "^[A-Za-z0-9_-]+$",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Expected Live Version Id"
    }
  },
  "required": [
    "session_id",
    "version_id",
    "expected_live_version_id"
  ],
  "title": "queue_ui_publishArguments",
  "type": "object"
}
queue_ui_rollbackRestore an earlier operator screen without changing business data. to_version_id is a receipt from publication.history or publication.baseline_version_id, not a design version. expected_live_version_id is the current publication.live_version_id receipt. Requires authorized personal or system publication access; works after session cleanup.
Input schema
{
  "properties": {
    "session_id": {
      "maxLength": 200,
      "pattern": "^qds_[A-Za-z0-9_-]+$",
      "title": "Session Id",
      "type": "string"
    },
    "to_version_id": {
      "maxLength": 200,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_-]+$",
      "title": "To Version Id",
      "type": "string"
    },
    "expected_live_version_id": {
      "anyOf": [
        {
          "maxLength": 200,
          "minLength": 1,
          "pattern": "^[A-Za-z0-9_-]+$",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Expected Live Version Id"
    }
  },
  "required": [
    "session_id",
    "to_version_id",
    "expected_live_version_id"
  ],
  "title": "queue_ui_rollbackArguments",
  "type": "object"
}
queue_ui_send_messageDescribe edits to generate a new design version. Reuse the same request key when retrying this message.
Input schema
{
  "properties": {
    "session_id": {
      "maxLength": 200,
      "pattern": "^qds_[A-Za-z0-9_-]+$",
      "title": "Session Id",
      "type": "string"
    },
    "prompt": {
      "maxLength": 20000,
      "minLength": 1,
      "pattern": "\\S",
      "title": "Prompt",
      "type": "string"
    },
    "idempotency_key": {
      "maxLength": 200,
      "minLength": 1,
      "title": "Idempotency Key",
      "type": "string"
    }
  },
  "required": [
    "session_id",
    "prompt",
    "idempotency_key"
  ],
  "title": "queue_ui_send_messageArguments",
  "type": "object"
}
queue_ui_start_designDescribe an operator screen for an eligible workflow. Keep the request key for retries, then open the returned review link when generation completes.
Input schema
{
  "properties": {
    "workflow_definition_id": {
      "maxLength": 200,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_-]+$",
      "title": "Workflow Definition Id",
      "type": "string"
    },
    "prompt": {
      "maxLength": 20000,
      "minLength": 1,
      "pattern": "\\S",
      "title": "Prompt",
      "type": "string"
    },
    "idempotency_key": {
      "maxLength": 200,
      "minLength": 1,
      "title": "Idempotency Key",
      "type": "string"
    }
  },
  "required": [
    "workflow_definition_id",
    "prompt",
    "idempotency_key"
  ],
  "title": "queue_ui_start_designArguments",
  "type": "object"
}
schedule_createCreate a recurring schedule with frozen workflow input.
Input schema
{
  "properties": {
    "workflow_definition_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Workflow Definition Id",
      "type": "string"
    },
    "cron_expression": {
      "title": "Cron Expression",
      "type": "string"
    },
    "input": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Input"
    },
    "overlap_policy": {
      "default": "BUFFER_ALL",
      "title": "Overlap Policy",
      "type": "string"
    },
    "note": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Note"
    }
  },
  "required": [
    "workflow_definition_id",
    "cron_expression"
  ],
  "title": "schedule_createArguments",
  "type": "object"
}
schedule_deleteDelete a schedule; the workflow definition remains intact.
Input schema
{
  "properties": {
    "workflow_definition_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Workflow Definition Id",
      "type": "string"
    }
  },
  "required": [
    "workflow_definition_id"
  ],
  "title": "schedule_deleteArguments",
  "type": "object"
}
schedule_getRead one workflow definition’s recurring schedule.
Input schema
{
  "properties": {
    "workflow_definition_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Workflow Definition Id",
      "type": "string"
    }
  },
  "required": [
    "workflow_definition_id"
  ],
  "title": "schedule_getArguments",
  "type": "object"
}
schedule_pausePause future actions for one workflow schedule.
Input schema
{
  "properties": {
    "workflow_definition_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Workflow Definition Id",
      "type": "string"
    },
    "note": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Note"
    }
  },
  "required": [
    "workflow_definition_id"
  ],
  "title": "schedule_pauseArguments",
  "type": "object"
}
schedule_resumeResume future actions for one paused workflow schedule.
Input schema
{
  "properties": {
    "workflow_definition_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Workflow Definition Id",
      "type": "string"
    },
    "note": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Note"
    }
  },
  "required": [
    "workflow_definition_id"
  ],
  "title": "schedule_resumeArguments",
  "type": "object"
}
schedule_triggerTrigger now; reuse idempotency_key for every retry of one attempt.
Input schema
{
  "properties": {
    "workflow_definition_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Workflow Definition Id",
      "type": "string"
    },
    "overlap_policy": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Overlap Policy"
    },
    "idempotency_key": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Idempotency Key"
    }
  },
  "required": [
    "workflow_definition_id"
  ],
  "title": "schedule_triggerArguments",
  "type": "object"
}
schedule_updateUpdate supplied fields on an existing workflow schedule.
Input schema
{
  "properties": {
    "workflow_definition_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Workflow Definition Id",
      "type": "string"
    },
    "cron_expression": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Cron Expression"
    },
    "input": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Input"
    },
    "overlap_policy": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Overlap Policy"
    },
    "note": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Note"
    }
  },
  "required": [
    "workflow_definition_id"
  ],
  "title": "schedule_updateArguments",
  "type": "object"
}
schedules_listList this organization’s workflow schedules and recent runs.
Input schema
{
  "properties": {
    "limit": {
      "default": 25,
      "exclusiveMinimum": 0,
      "title": "Limit",
      "type": "integer"
    },
    "offset": {
      "default": 0,
      "minimum": 0,
      "title": "Offset",
      "type": "integer"
    },
    "paused_only": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Paused Only"
    }
  },
  "title": "schedules_listArguments",
  "type": "object"
}
session_getRead state and capabilities for Planner, Browser, or queue design sessions. Queue designs also require queue_ui:read.
Input schema
{
  "properties": {
    "session_id": {
      "maxLength": 200,
      "minLength": 5,
      "pattern": "^(?:pbld_|bas_|qds_)[A-Za-z0-9_-]+$",
      "title": "Session Id",
      "type": "string"
    }
  },
  "required": [
    "session_id"
  ],
  "title": "session_getArguments",
  "type": "object"
}
session_get_eventsReplay durable events when the session advertises replay_events=true.
Input schema
{
  "properties": {
    "session_id": {
      "maxLength": 200,
      "minLength": 5,
      "pattern": "^(?:pbld_|bas_|qds_)[A-Za-z0-9_-]+$",
      "title": "Session Id",
      "type": "string"
    },
    "after": {
      "default": 0,
      "minimum": 0,
      "title": "After",
      "type": "integer"
    },
    "limit": {
      "default": 100,
      "maximum": 500,
      "minimum": 1,
      "title": "Limit",
      "type": "integer"
    }
  },
  "required": [
    "session_id"
  ],
  "title": "session_get_eventsArguments",
  "type": "object"
}
session_sendSend feedback to Planner, Browser, or a queue design. Queue designs also require queue_ui:write; follow their events_path for progress.
Input schema
{
  "properties": {
    "session_id": {
      "maxLength": 200,
      "minLength": 5,
      "pattern": "^(?:pbld_|bas_|qds_)[A-Za-z0-9_-]+$",
      "title": "Session Id",
      "type": "string"
    },
    "message": {
      "maxLength": 200000,
      "minLength": 1,
      "title": "Message",
      "type": "string"
    },
    "source_session_id": {
      "anyOf": [
        {
          "maxLength": 200,
          "minLength": 5,
          "pattern": "^(?:pbld_|bas_|qds_)[A-Za-z0-9_-]+$",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Source Session Id"
    },
    "step_number": {
      "anyOf": [
        {
          "exclusiveMinimum": 0,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Step Number"
    },
    "expected_state_version": {
      "anyOf": [
        {
          "exclusiveMinimum": 0,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Expected State Version"
    },
    "idempotency_key": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Idempotency Key"
    }
  },
  "required": [
    "session_id",
    "message"
  ],
  "title": "session_sendArguments",
  "type": "object"
}
session_waitBoundedly wait for replayable session events without losing the cursor.
Input schema
{
  "properties": {
    "session_id": {
      "maxLength": 200,
      "minLength": 5,
      "pattern": "^(?:pbld_|bas_|qds_)[A-Za-z0-9_-]+$",
      "title": "Session Id",
      "type": "string"
    },
    "after": {
      "minimum": 0,
      "title": "After",
      "type": "integer"
    },
    "timeout_seconds": {
      "default": 20,
      "exclusiveMinimum": 0,
      "title": "Timeout Seconds",
      "type": "integer"
    },
    "limit": {
      "default": 100,
      "maximum": 500,
      "minimum": 1,
      "title": "Limit",
      "type": "integer"
    }
  },
  "required": [
    "session_id",
    "after"
  ],
  "title": "session_waitArguments",
  "type": "object"
}
sms_inbox_messagesRead messages received by this organization's dedicated VoIP inbox.
Input schema
{
  "properties": {
    "after_ms": {
      "default": 0,
      "minimum": 0,
      "title": "After Ms",
      "type": "integer"
    },
    "limit": {
      "default": 20,
      "maximum": 50,
      "minimum": 1,
      "title": "Limit",
      "type": "integer"
    }
  },
  "title": "sms_inbox_messagesArguments",
  "type": "object"
}
sms_inbox_provisionProvision or retrieve this organization's dedicated VoIP SMS number.
Input schema
{
  "properties": {
    "country_code": {
      "const": "US",
      "default": "US",
      "title": "Country Code",
      "type": "string"
    },
    "area_code": {
      "anyOf": [
        {
          "pattern": "^[0-9]{3}$",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Area Code"
    }
  },
  "title": "sms_inbox_provisionArguments",
  "type": "object"
}
workflow_executeStart one on-demand run of a promoted workflow definition.
Input schema
{
  "properties": {
    "workflow_definition_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Workflow Definition Id",
      "type": "string"
    },
    "input": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Input"
    },
    "idempotency_key": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Idempotency Key"
    }
  },
  "required": [
    "workflow_definition_id"
  ],
  "title": "workflow_executeArguments",
  "type": "object"
}
workflow_get_phasesRead safe activity-phase status for an exact workflow run.
Input schema
{
  "properties": {
    "workflow_instance_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[^/\\\\?#]+$",
      "title": "Workflow Instance Id",
      "type": "string"
    }
  },
  "required": [
    "workflow_instance_id"
  ],
  "title": "workflow_get_phasesArguments",
  "type": "object"
}
workflow_metric_dashboard_getRender one approved metric view for an explicitly granted workflow.
Input schema
{
  "properties": {
    "workflow_definition_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Workflow Definition Id",
      "type": "string"
    },
    "dashboard_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Dashboard Id",
      "type": "string"
    },
    "from_date": {
      "anyOf": [
        {
          "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "From Date"
    },
    "to_date": {
      "anyOf": [
        {
          "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "To Date"
    }
  },
  "required": [
    "workflow_definition_id",
    "dashboard_id"
  ],
  "title": "workflow_metric_dashboard_getArguments",
  "type": "object"
}
workflow_metric_dashboards_listList approved metric views for one explicitly granted workflow.
Input schema
{
  "properties": {
    "workflow_definition_id": {
      "maxLength": 500,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "title": "Workflow Definition Id",
      "type": "string"
    }
  },
  "required": [
    "workflow_definition_id"
  ],
  "title": "workflow_metric_dashboards_listArguments",
  "type": "object"
}

Security model

Authorization defines the boundary.

  • Interactive OAuth access is bound to the approving user, selected XY organization, exact MCP resource, and approved scopes.
  • Personal API keys are also user-bound; service API keys represent unattended organization systems rather than a human actor.
  • Every OAuth request rechecks the user's current organization membership and assigned API scopes; endpoint-specific workflow permissions still apply.
  • Interactive access must be enabled for the organization, and each user receives only the scopes assigned to their identity.
  • Every tool operation receives a request ID and a payload-free audit record with its credential, actor when applicable, organization, route, outcome, and opaque target identifiers.
  • OAuth grants and API keys are environment-bound; this public guide always uses production.
  • Tool discovery is filtered to the scopes on the current OAuth grant or API key.
  • Queue UI Designer supports personal access with explicit workflow permissions and system keys with organization authorization. Only system keys with queue_ui:approve can use queue_ui_approve; personal OAuth cannot. Publish never grants approval.
  • API keys belong in a secret manager or OS keychain, never in a URL or source control.
  • Credential-bound workflows require an exact visible Password Vault reference. MCP clients can discover safe metadata and receive credential IDs, never plaintext secrets.
Open the REST API reference