​
MCP Tool: get_workflow

Retrieves detailed information about a specific workflow by its unique identifier. This tool provides comprehensive workflow details including definition, configuration, and version information.

​
Example Prompt

Get workflow with unique identifier "ticket-escalation-workflow"

​
Input Parameters

NameTypeRequiredDescription
workflowUniqueIdentifierstringYesThe unique identifier of the workflow
versionnumberNoThe version of the workflow (defaults to latest)

​
Response Fields

Below are the fields you may see in the response:
FieldTypeDescription
uidstringUnique identifier for current version of the workflow
typestringThe type of the workflow
subTypestringThe sub type of the workflow
uniqueIdentifierstringThe unique identifier of the workflow
namestringThe name identifier of the workflow
versionnumberThe version of the workflow
triggerEventobjectThe trigger event of the workflow
filtersobjectThe filters of the workflow
annotationsarrayThe annotation for the workflow
workflowDefinitionarrayThe workflow definition steps
executingAgentstringThe executing agent of the workflow
isActivebooleanThe status of the workflow
createdAtstring (ISO8601)The created at date of the workflow
updatedAtstring (ISO8601)The updated at date of the workflow
createdBystringThe created by of the workflow
teamIdstringThe team id of the workflow
metadataobjectThe metadata for the workflow

​
Sample Response

{
  "data": {
    "uid": "WORKFLOW001",
    "type": "WORKFLOW",
    "subType": "AI_AGENT",
    "uniqueIdentifier": "ticket-escalation-workflow",
    "name": "Ticket Escalation Workflow",
    "version": 1,
    "triggerEvent": {
      "id": "EVENT001",
      "name": "ticket.created",
      "description": "Triggered when a new ticket is created",
      "schema": {
        "type": "object",
        "properties": {
          "ticketId": { "type": "string" },
          "priority": { "type": "string" },
          "team": { "type": "string" }
        }
      }
    },
    "filters": {
      "priority": "high",
      "team": "support",
      "autoEscalate": true
    },
    "annotations": [
      {
        "entityType": "ticket",
        "data": {
          "autoEscalate": true,
          "escalationThreshold": 30
        },
        "relations": ["escalation", "notification"]
      }
    ],
    "workflowDefinition": [
      {
        "stepIdentifier": 1,
        "activity": {
          "name": "send-notification",
          "uniqueIdentifier": "notification.activity",
          "version": 1,
          "autoUpgradeToLatestVersion": true
        },
        "input": {
          "recipients": ["support-team", "senior-agents"],
          "message": "High priority ticket requires immediate attention",
          "priority": "urgent"
        },
        "retryPolicy": {
          "maximumAttempts": 3,
          "initialInterval": 1000,
          "backoffCoefficient": 2
        },
        "onFailure": "CONTINUE",
        "isSleepActivity": false,
        "executionTimeout": 30000,
        "dependencies": [],
        "filters": {
          "notificationType": "escalation"
        }
      },
      {
        "stepIdentifier": 2,
        "activity": {
          "name": "assign-to-senior-agent",
          "uniqueIdentifier": "assignment.activity",
          "version": 1,
          "autoUpgradeToLatestVersion": true
        },
        "input": {
          "priority": "high",
          "skillSet": ["escalation", "technical", "senior"],
          "autoAssign": true
        },
        "retryPolicy": {
          "maximumAttempts": 2,
          "initialInterval": 5000,
          "backoffCoefficient": 1.5
        },
        "onFailure": "ABORT",
        "isSleepActivity": false,
        "executionTimeout": 60000,
        "dependencies": [1],
        "filters": {
          "agentLevel": "senior"
        }
      },
      {
        "stepIdentifier": 3,
        "activity": {
          "name": "update-ticket-status",
          "uniqueIdentifier": "status-update.activity",
          "version": 1,
          "autoUpgradeToLatestVersion": true
        },
        "input": {
          "status": "escalated",
          "comment": "Automatically escalated due to high priority"
        },
        "retryPolicy": {
          "maximumAttempts": 1,
          "initialInterval": 1000,
          "backoffCoefficient": 1
        },
        "onFailure": "CONTINUE",
        "isSleepActivity": false,
        "executionTimeout": 15000,
        "dependencies": [2],
        "filters": {}
      }
    ],
    "executingAgent": "workflow-engine",
    "isActive": true,
    "createdAt": "2025-07-24T07:19:10.258Z",
    "updatedAt": "2025-07-24T07:19:10.258Z",
    "createdBy": "USER001",
    "teamId": "TEAM001",
    "metadata": {
      "description": "Automated workflow for escalating high-priority tickets",
      "tags": ["escalation", "automation", "support"],
      "category": "customer-service",
      "priority": "high"
    }
  },
  "status": true,
  "message": "Workflow retrieved successfully!",
  "timestamp": "2025-07-25T12:50:38.937Z"
}