Skip to main content
Glama
Orchestra MCP Server

Orchestra MCP Server

Official
by orchestra-hq

Start a pipeline run

start_pipeline

Start a pipeline run by alias or ID with optional branch, commit, version, or run inputs; returns a pipelineRunId for polling status.

Instructions

Start a pipeline run. The pipeline can be identified by alias or pipeline ID.

All request body fields are optional. Use branch and commit for Git-backed pipelines, versionNumber for Orchestra-backed published versions, and runInputs for values required by pipeline inputs. The response includes a pipelineRunId you can use to poll run status.

Any other JSON body, such as a webhook sent by another tool, still starts the run, with default options; requestBodyMessage and requestBodyErrors in the response say which happened. Either way the whole body is available to the pipeline's webhook.runInputs as ${{ outputs.payload }}, for example ${{ outputs.payload.connection_id }}, or ${{ outputs.payload['connectionId'] }} for a key with capitals, so task conditions can act on it through ${{ inputs.<name> }}. Bodies over 64 KiB are not kept.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "pipeline_id_or_alias": "<pipeline_id_or_alias>"
    },
    "name": "start_pipeline"
  }
}

Input Schema

NameRequiredDescriptionDefault
dataNo
branchNo
commitNo
ciRunIdNo
taskIdsNo
inputSetNoName of a pipeline input set that fills inputs not given in run_inputs.
runInputsNo
environmentNo
versionNumberNo
retryFromFailedNo
environmentOverridesNo
pipeline_id_or_aliasYesPipeline ID or alias.
continueDownstreamRunNo
X-Orchestra-Account-IdNoAct on this account rather than the one the credential resolves to. Omit it to use the credential's own account. An API key is issued to a single account, so it may only name that account; an OAuth token may name any account its grant covers.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2026.11.13-0
    • addedInput schema / properties / inputSet
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Name of a pipeline input set that fills inputs not given in run_inputs."
      +}
  2. Changed12 schema fields changedv2026.10.12-0
    • removedInput schema / properties / body
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "additionalProperties": false,
      -      "description": "Full webhook request body for triggering a pipeline run.",
      -      "properties": {
      -        "branch": {
      -          "anyOf": [
      -            {
      -              "type": "string"
      -            },
      -            {
      -              "type": "null"
      -            }
      -          ]
      -        },
      -        "ciRunId": {
      -          "anyOf": [
      -            {
      -              "type": "string"
      -            },
      -            {
      -              "type": "null"
      -            }
      -          ]
      -        },
      -        "commit": {
      -          "anyOf": [
      -            {
      -              "type": "string"
      -            },
      -            {
      -              "type": "null"
      -            }
      -          ]
      -        },
      -        "continueDownstreamRun": {
      -          "anyOf": [
      -            {
      -              "type": "boolean"
      -            },
      -            {
      -              "type": "null"
      -            }
      -          ]
      -        },
      -        "data": {
      -          "default": [],
      -          "items": {
      -            "anyOf": [
      -              {
      -                "additionalProperties": false,
      -                "description": "Webhook payload for Airflow DAG run completion notifications.",
      -                "properties": {
      -                  "dagId": {
      -                    "type": "string"
      -                  },
      -                  "dagRunId": {
      -                    "type": "string"
      -                  },
      -                  "integration": {
      -                    "const": "AIRFLOW",
      -                    "type": "string"
      -                  }
      -                },
      -                "required": [
      -                  "integration",
      -                  "dagId",
      -                  "dagRunId"
      -                ],
      -                "type": "object"
      -              }
      -            ]
      -          },
      -          "type": "array"
      -        },
      -        "environment": {
      -          "anyOf": [
      -            {
      -              "type": "string"
      -            },
      -            {
      -              "type": "null"
      -            }
      -          ]
      -        },
      -        "environmentOverrides": {
      -          "anyOf": [
      -            {
      -              "additionalProperties": {
      -                "description": "A typed environment variable value.",
      -                "properties": {
      -                  "type": {
      -                    "enum": [
      -                      "string",
      -                      "int",
      -                      "bool",
      -                      "integration_credential",
      -                      "dict",
      -                      "list"
      -                    ],
      -                    "type": "string"
      -                  },
      -                  "value": {
      -                    "anyOf": [
      -                      {
      -                        "type": "string"
      -                      },
      -                      {
      -                        "type": "boolean"
      -                      },
      -                      {
      -                        "type": "integer"
      -                      },
      -                      {
      -                        "type": "number"
      -                      },
      -                      {
      -                        "additionalProperties": true,
      -                        "type": "object"
      -                      },
      -                      {
      -                        "items": {},
      -                        "type": "array"
      -                      }
      -                    ]
      -                  }
      -                },
      -                "required": [
      -                  "type",
      -                  "value"
      -                ],
      -                "type": "object"
      -              },
      -              "type": "object"
      -            },
      -            {
      -              "type": "null"
      -            }
      -          ]
      -        },
      -        "retryFromFailed": {
      -          "default": false,
      -          "type": "boolean"
      -        },
      -        "runInputs": {
      -          "anyOf": [
      -            {
      -              "additionalProperties": true,
      -              "type": "object"
      -            },
      -            {
      -              "type": "null"
      -            }
      -          ]
      -        },
      -        "taskIds": {
      -          "anyOf": [
      -            {
      -              "items": {
      -                "type": "string"
      -              },
      -              "type": "array"
      -            },
      -            {
      -              "type": "null"
      -            }
      -          ]
      -        },
      -        "versionNumber": {
      -          "anyOf": [
      -            {
      -              "type": "integer"
      -            },
      -            {
      -              "type": "null"
      -            }
      -          ]
      -        }
      -      },
      -      "type": "object"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ]
      -}
    • addedInput schema / properties / branch
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • addedInput schema / properties / ciRunId
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • addedInput schema / properties / commit
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • addedInput schema / properties / continueDownstreamRun
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "boolean"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • addedInput schema / properties / data
      Added value: +{
      +  "default": [],
      +  "items": {
      +    "anyOf": [
      +      {
      +        "additionalProperties": false,
      +        "description": "Webhook payload for Airflow DAG run completion notifications.",
      +        "properties": {
      +          "dagId": {
      +            "type": "string"
      +          },
      +          "dagRunId": {
      +            "type": "string"
      +          },
      +          "integration": {
      +            "const": "AIRFLOW",
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "integration",
      +          "dagId",
      +          "dagRunId"
      +        ],
      +        "type": "object"
      +      }
      +    ]
      +  },
      +  "type": "array"
      +}
    • addedInput schema / properties / environment
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • addedInput schema / properties / environmentOverrides
      Added value: +{
      +  "anyOf": [
      +    {
      +      "additionalProperties": {
      +        "description": "A typed environment variable value.",
      +        "properties": {
      +          "type": {
      +            "enum": [
      +              "string",
      +              "int",
      +              "bool",
      +              "integration_credential",
      +              "dict",
      +              "list"
      +            ],
      +            "type": "string"
      +          },
      +          "value": {
      +            "anyOf": [
      +              {
      +                "type": "string"
      +              },
      +              {
      +                "type": "boolean"
      +              },
      +              {
      +                "type": "integer"
      +              },
      +              {
      +                "type": "number"
      +              },
      +              {
      +                "additionalProperties": true,
      +                "type": "object"
      +              },
      +              {
      +                "items": {},
      +                "type": "array"
      +              }
      +            ]
      +          }
      +        },
      +        "required": [
      +          "type",
      +          "value"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "object"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • addedInput schema / properties / retryFromFailed
      Added value: +{
      +  "default": false,
      +  "type": "boolean"
      +}
    • addedInput schema / properties / runInputs
      Added value: +{
      +  "anyOf": [
      +    {
      +      "additionalProperties": true,
      +      "type": "object"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • addedInput schema / properties / taskIds
      Added value: +{
      +  "anyOf": [
      +    {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • addedInput schema / properties / versionNumber
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
  3. First observedv0.1.0

TDQS

A4.3/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Rich behavioral detail beyond annotations: it explains that arbitrary JSON bodies trigger the run with default options, describes response fields (pipelineRunId, requestBodyMessage, requestBodyErrors), explains how the payload maps to webhook.runInputs, and states a 64 KiB size limit. This is far more than the non-readOnly/non-destructive annotations convey.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Structured logically: purpose first, identification method second, parameter guidance third, then body handling and response details. The explanation of payload mapping into ${{ outputs.payload }} is slightly verbose but necessary to understand how inputs are consumed.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The output schema is provided, so return values need less explanation, and the description smartly covers the unusual return fields. For a 14-parameter mutation tool, it equips an agent well for typical Git and Orchestra runs but is incomplete for less common parameters like environment or environmentOverrides.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With only 21% schema description coverage across 14 parameters, the description compensates by explaining branch, commit, versionNumber, and runInputs. However, it leaves 9 parameters (e.g., ciRunId, taskIds, environmentOverrides, data) entirely undocumented in both schema and prose.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Starts with 'Start a pipeline run,' a specific verb and resource that immediately distinguishes it from sibling tools like cancel_pipeline_run or get_pipeline_run. The description makes the action unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides clear conditional usage guidance for key parameters: use branch/commit for Git-backed pipelines, versionNumber for Orchestra-backed published versions, and runInputs for pipeline inputs. It does not explicitly state when not to use this tool or name a specific alternative, but the operational context is well-defined.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools