Skip to main content
Glama

CI/CD validate pipeline YAML

cicd_validate_pipeline_yaml
Read-only

Validate an Ankra pipeline definition (.ankra/pipeline.yaml) before proposing or committing it - the twin of cicd_validate_workflow_yaml for the definition that replaces the GitHub Actions workflow. Returns a severity ('ok', 'warn' or 'fatal'), the violations with their classifier key and message, and what the pipeline declares: its name, its stage names in declaration order, and its trigger events. A 'fatal' severity means the pipeline cannot be planned and must be fixed before it is committed; unreadable YAML comes back as a fatal violation rather than a tool error. Read-only over the text you pass it.

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_yaml": "<pipeline_yaml>"
    },
    "name": "cicd_validate_pipeline_yaml"
  }
}

Input Schema

NameRequiredDescriptionDefault
pipeline_yamlYesThe full contents of the .ankra/pipeline.yaml document to validate.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior5/5

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

Annotations only declare readOnlyHint=true, and the description goes well beyond that: it discloses the return shape (severity of 'ok'/'warn'/'fatal', violations with classifier key and message, declared name, stage names in order, trigger events) and the important edge case that unreadable YAML surfaces as a fatal violation rather than a tool error. It also reinforces that the operation is read-only over the passed text with no side effects on the repository.

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?

Front-loaded with the action and the file it applies to, and every sentence carries information (purpose, routing to sibling, return shape, fatal semantics). The middle sentence is a long enumeration of return fields that reads densely and could be split, but nothing is expendable.

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

Completeness5/5

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

There is no output schema, so the description takes on the burden of describing return values and does so fully, including severity levels and what each violation contains. For a single-parameter, read-only validator, an agent has everything needed to call it and interpret the result, including the unreadable-YAML case.

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 one parameter at 100% schema description coverage, the schema already explains that pipeline_yaml is the full document contents. The description adds only the file-path context (.ankra/pipeline.yaml) rather than format or syntax constraints, so the baseline 3 applies.

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?

States a specific verb (validate) and resource (Ankra pipeline definition at .ankra/pipeline.yaml), and explicitly positions itself as the twin of cicd_validate_workflow_yaml for the definition document that replaces the GitHub Actions workflow. An agent can distinguish it from the workflow validator and from proposing tools without opening any schema.

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?

Gives clear timing context ('before proposing or committing it') and names the alternative tool for the other document type, which is enough to route correctly. It never says when not to use it (e.g., after commit, or for chart values where cicd_validate_chart_values applies), so it stops short of full exclusion guidance.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.