Tool details
| Field | Value |
|---|---|
| Name | get_workflow |
| Group | Jobs |
Playground
Input schema
Input schema
{
"type": "object",
"properties": {
"project_reference": {
"type": "string",
"description": "Project ID or slug"
},
"workflow_id": {
"type": "string",
"description": "Workflow ID from list_workflows, for example publish-site"
},
"runtime_target_kind": {
"anyOf": [
{
"type": "string",
"enum": [
"production",
"environment",
"preview_branch"
],
"description": "Provide the runtime target kind."
},
{
"type": "null",
"description": "Provide the runtime target kind."
}
],
"description": "Provide the runtime target kind."
},
"target_environment_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Provide the target environment id."
},
{
"type": "null",
"description": "Provide the target environment id."
}
],
"description": "Provide the target environment id."
},
"target_branch_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Provide the target branch id."
},
{
"type": "null",
"description": "Provide the target branch id."
}
],
"description": "Provide the target branch id."
},
"source_target_kind": {
"type": "string",
"enum": [
"project",
"production",
"environment",
"preview_branch"
],
"description": "Provide the source target kind."
}
},
"required": [
"project_reference",
"workflow_id"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "Input schema for the get_workflow tool."
}
Output schema
Output schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Workflow identifier."
},
"name": {
"type": "string",
"description": "Human-readable workflow name."
},
"description": {
"type": [
"string",
"null"
],
"description": "Short description of the workflow purpose."
},
"target": {
"type": "string",
"description": "Execution target that implements the workflow."
},
"source_path": {
"type": "string",
"description": "Source file path where the workflow definition lives."
},
"version": {
"type": [
"string",
"null"
],
"description": "Version string for the workflow definition, when tracked."
},
"input_schema": {
"anyOf": [
{
"type": "object",
"additionalProperties": {
"description": "Additional structured values associated with this result."
},
"description": "Structured input schema details associated with this record."
},
{
"type": "null",
"description": "The input schema returned by the tool."
}
],
"description": "Structured input schema for workflow execution, when defined."
},
"output_schema": {
"anyOf": [
{
"type": "object",
"additionalProperties": {
"description": "Additional structured values associated with this result."
},
"description": "Structured output schema details associated with this record."
},
{
"type": "null",
"description": "The output schema returned by the tool."
}
],
"description": "Structured output schema for workflow execution, when defined."
},
"schedulable": {
"type": "boolean",
"description": "Whether the workflow can be triggered by schedulers or automations."
}
},
"required": [
"id",
"name",
"description",
"target",
"source_path",
"version",
"input_schema",
"output_schema",
"schedulable"
],
"additionalProperties": false,
"description": "Workflow definition returned by MCP workflow tools.",
"$schema": "http://json-schema.org/draft-07/schema#"
}