Skip to main content
Glama

circleci_get_pipeline

Read-onlyIdempotent

Retrieve details for a single CircleCI pipeline by its ID using an API key, so you can inspect pipeline status, configuration, and metadata in agent workflows.

Instructions

Get details for a single CircleCI pipeline by ID.

Input Schema

NameRequiredDescriptionDefault
api_keyYesCircleCI personal API token
pipeline_idYesPipeline ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.1.9
  2. Removed
  3. Addedv0.1.5

TDQS

A3.8/5.0
Behavior2/5

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

The annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false. The description adds no behavioral context beyond 'Get details'—no auth requirements, rate limits, or response behavior—so it provides little value beyond the structured annotation data.

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

Conciseness5/5

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

The description is a single front-loaded sentence with no wasted words. It states the action, resource, scope, and identifier requirement efficiently.

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?

For a simple read-only lookup tool, the description plus the fully described schema and rich annotations are sufficient to select and invoke it correctly. The lack of output schema leaves the exact 'details' shape unstated, but that is a minor gap for this tool's complexity.

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?

Both parameters are fully described in the schema, including api_key as a personal API token and pipeline_id as the pipeline identifier. The description's 'by ID' adds only marginal meaning to pipeline_id and does not mention api_key, matching the baseline for high schema coverage.

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?

The description uses a specific verb and resource ('Get details for a single CircleCI pipeline') and scopes it by ID. This clearly distinguishes it from sibling list tools such as circleci_list_pipelines.

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?

The phrase 'by ID' makes the usage context clear: call this when you already have a specific pipeline ID. It does not explicitly name alternatives or exclusions, but the single-pipeline scope is unambiguous.

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