Skip to main content
Glama

CI/CD validate workflow YAML

cicd_validate_workflow_yaml
Read-only

Validate a GitHub Actions workflow YAML string against Ankra's platform invariants (one 'build-and-push' job, expected step sequence, --password-stdin, lowercased GHCR owner, multi-arch platforms, ankra-*-scan artifact names, pinned action versions). Use this to inspect a customer's pre-existing workflow before splicing security steps. Returns severity and per-violation keys.

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": {
      "content": "<content>"
    },
    "name": "cicd_validate_workflow_yaml"
  }
}

Input Schema

NameRequiredDescriptionDefault
contentYesFull workflow YAML content (typically read via github_read_file).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

The readOnlyHint annotation already establishes this is a non-mutating operation, so the description's job is to add context about validation behavior. It does that partly by disclosing the return shape ('severity and per-violation keys') and the invariant list used for judgement, which matters since there is no output schema. However, it says nothing about how malformed or unparsable YAML is handled, whether validation is strict or advisory, or whether findings block later steps.

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?

The verb and resource lead, the invariant list follows, and the purpose/return sentences close it out with no filler. The long parenthetical of invariants is dense but each item is specific and useful, so it earns its space.

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 single-parameter, read-only validation tool with no output schema, the description covers what is checked and roughly what is returned, which is enough to call it correctly. Only the handling of invalid YAML and the severity semantics remain unstated.

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?

There is a single parameter with 100% schema description coverage, and the schema already states it is the full workflow YAML content typically obtained via github_read_file. The description confirms the input is a raw YAML string rather than a path, but adds no further meaning. Baseline 3 applies when the schema carries the burden.

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?

The description names a specific verb and resource ('Validate a GitHub Actions workflow YAML string') and enumerates the exact invariants checked (single build-and-push job, --password-stdin, lowercased GHCR owner, pinned action versions), which makes the scope unmistakable. It does not explicitly contrast with the nearby cicd_validate_pipeline_yaml or cicd_convert_workflow_to_pipeline siblings, so an agent must infer the boundary from 'GitHub Actions workflow' alone.

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?

It gives a concrete usage condition: inspect a customer's pre-existing workflow before splicing security steps. That is real routing guidance beyond the name. It stops short of stating when not to use it or naming validate_pipeline_yaml as the alternative for non-GitHub-Actions pipeline definitions.

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.