Get an agent

Tool: get_workflow. Requires Viewer or higher in the applicable workspace and a connected OAuth session. Returns the agent’s authoring code and metadata. lifecycle_status describes the agent; version_status describes its selected definition. Use the full returned code for subsequent edits. An agent without a versioned definition returns version_not_found; create a version in the console before editing through MCP.

Arguments

Name	Type	Required	Defaults and limits
`workflow_id`	integer	Yes	See full schema

Example arguments

Replace sample resource IDs with IDs returned in your selected workspace.

{
  "workflow_id": 42
}

Result and errors

The schema below describes MCP structuredContent, including the result wrapper where present. Your client may also display a text representation. Read success flags and structured errors before continuing; transport success alone does not prove the operation succeeded. Authentication, missing membership, and insufficient role can fail before a tool result is produced. See troubleshooting. Effect: Reads data. Retry: Declared idempotent. Discovery annotations describe behavior; they do not grant permission or replace confirmation for consequential actions.

Input schema

{
  "additionalProperties": false,
  "properties": {
    "workflow_id": {
      "type": "integer"
    }
  },
  "required": [
    "workflow_id"
  ],
  "type": "object"
}

Result schema

{
  "properties": {
    "assistant_mode": {
      "enum": [
        "single_prompt",
        "workflow"
      ],
      "type": "string"
    },
    "code": {
      "type": "string"
    },
    "id": {
      "type": "integer"
    },
    "lifecycle_status": {
      "enum": [
        "draft",
        "active",
        "paused",
        "archived"
      ],
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "version_number": {
      "type": "integer"
    },
    "version_status": {
      "enum": [
        "draft",
        "published"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "name",
    "lifecycle_status",
    "version_status",
    "version_number",
    "code",
    "assistant_mode"
  ],
  "type": "object"
}

Get started

Use MCP

Workspaces

Agents

Calls and outcomes

Phone numbers

Resources

Authoring guidance

Documentation

Arguments

Example arguments

Result and errors

​Arguments

​Example arguments

​Result and errors

Arguments

Example arguments

Result and errors