MCP tool

    exo_get_flow

    One flow's definition and settings, with secrets masked.

    For tools and AI agents: this page as Markdown · the public OpenAPI file

    Description

    Returns the flow's steps and links so an assistant can change them and send them back with exo_update_flow. Settings whose names look like credentials (secrets, passwords, tokens, API keys) come back as ***; sending *** back keeps the stored value.

    Permission

    Needs an API key or OAuth connection with the build permission.

    Input

    NameTypeRequiredDescription
    flowIdstringYesThe flow id.

    Returns

    id, name, description, status, mode, triggerType, projectId and definition (nodes and edges).

    Errors

    Returned as a normal result with isError: true:

    • flowId is required.
    • Flow "<flowId>" not found.

    Returned as a JSON-RPC error:

    CodeHTTPMessage
    -32001403API key lacks the 'build' permission required for flow authoring tools

    Messages are shown exactly as the server sends them, in English. A value in angle brackets is filled in at run time.

    Examples

    Example call

    {
      "jsonrpc": "2.0",
      "id": 1,
      "method": "tools/call",
      "params": {
        "name": "exo_get_flow",
        "arguments": {
          "flowId": "7a17617d-3c4e-4f0a-9b1e-2d5c8e0f4a61"
        }
      }
    }

    Example result

    {
      "jsonrpc": "2.0",
      "id": 1,
      "result": {
        "content": [
          {
            "type": "text",
            "text": "Flow \"Overdue invoice reminders\" (active).\n{ ... }"
          }
        ],
        "structuredContent": {
          "id": "7a17617d-3c4e-4f0a-9b1e-2d5c8e0f4a61",
          "name": "Overdue invoice reminders",
          "description": null,
          "status": "active",
          "mode": "orchestration",
          "triggerType": "webhook",
          "projectId": "c3e1a9d4-8b2f-4f6e-a0c7-5d9b2e1f7a33",
          "definition": {
            "nodes": [
              "..."
            ],
            "edges": [
              "..."
            ]
          }
        },
        "isError": false
      }
    }

    Example values. In content, the text after the summary line is the same data as structuredContent.