Skip to main content
Glama
orchestra-hq

Orchestra MCP Server

Official
by orchestra-hq

Get a pipeline by selector

get_pipeline
Read-only

Fetch a single pipeline by ID, alias, or repository and YAML path. Use it to retrieve a pipeline's configuration and metadata.

Instructions

Fetch a single pipeline. Provide exactly one selector: pipeline_id, alias, or repository together with yaml_path.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
aliasNoPipeline alias selector.
branchNoPipeline branch selector (used for git-backed pipeline YAML).
commitNoPipeline commit selector (used for git-backed pipeline YAML).
versionNoPipeline version selector (used for versioned pipeline YAML).
yaml_pathNoPipeline YAML path selector. Must be provided together with `repository`.
repositoryNoRepository selector. Must be provided together with `yaml_path`.
pipeline_idNoPipeline ID selector.
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

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior4/5

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

readOnlyHint=true already covers the safety profile, so the bar is lower, and the description contributes the mutually-exclusive selector constraint that the empty required list does not enforce. It still omits what happens when zero or conflicting selectors are supplied, and whether branch/commit/version can be combined, so it is not fully transparent.

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?

Two tight sentences with the purpose front-loaded and no filler. The second sentence partly repeats parameter names already visible in the schema, which keeps it from being maximally economical.

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?

With an output schema present, return values need no explanation, annotations cover read-only safety, and the schema fully documents parameters; the description adds the missing selector-exclusivity rule. It could still note the failure mode for an invalid selector set or point to the sibling used for data/runs retrieval.

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?

Schema description coverage is 100% and each selector parameter is documented in the schema, including the repository/yaml_path pairing. The description restates the selector list and adds the exactly-one rule, but supplies no format or semantics beyond what the schema already carries, so the baseline 3 applies.

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

Purpose4/5

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

"Fetch a single pipeline" gives a specific verb and resource, and "single" implicitly contrasts with the sibling list_pipelines. It does not, however, distinguish itself from get_pipeline_data or pipeline_context, which an agent would have to disambiguate on its own.

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

Usage Guidelines3/5

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

The description states the invocation rule (provide exactly one selector) and enumerates the valid selector combinations, which is real usage guidance. It gives no when-to-use vs when-not-to-use guidance relative to siblings like get_pipeline_data or list_pipelines, leaving selection inferred.

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