Skip to main content
Glama

Generate CI/CD pipeline

generate_cicd_pipeline

Generate CI/CD pipeline configuration to run Newman collections in GitHub Actions, GitLab CI, Azure DevOps, Jenkins, or Docker, including report and environment options.

Instructions

Generates configuration to run Newman in CI/CD or Docker (GitHub Actions, GitLab CI, Azure DevOps, Jenkins, Dockerfile).

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": {
      "platform": "<platform>",
      "collectionSource": "<collectionSource>"
    },
    "name": "generate_cicd_pipeline"
  }
}

Input Schema

NameRequiredDescriptionDefault
platformYesTarget platform
overwriteNoAllow replacing outputPath
outputPathNoWrite the file when provided; otherwise return content only
nodeVersionNoNode version for the image or runner20
useHtmlExtraNoAdd newman-reporter-htmlextra alongside JUnit
environmentPathNoEnvironment file path
collectionSourceYesCollection (repo-relative path, https URL, or Postman UID)
iterationDataPathNoIteration data path

Output Schema

NameRequiredDescriptionDefault
contentYes
platformYes
writtenToYes
suggestedPathYes
requiredSecretsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, and openWorldHint=true, so the agent knows this is a non-destructive writer. The description adds that the output is pipeline configuration for specific platforms, but says nothing about file-writing side effects, overwrite behavior, or prerequisites beyond what the schema already states.

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?

A single front-loaded sentence with the action first and the platform enumeration last. Every clause carries information and there is no filler.

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 a full output schema, complete parameter descriptions, and safety annotations, the definition supplies everything needed to invoke the tool. The only minor gap is the absence of guidance on when this tool is preferred over other generate_* siblings.

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%, so all eight parameters are already documented in structured data. The description's platform list merely mirrors the enum values and adds no syntax or format guidance beyond the schema, making the baseline 3 appropriate.

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 (Generates) and resource (configuration to run Newman in CI/CD or Docker) and enumerates the five target platforms. It is clearly distinct from siblings like generate_newman_report or run_newman_collection, though it never explicitly contrasts itself with them.

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 phrase 'to run Newman in CI/CD or Docker' implies the scenario (you need a pipeline file for a collection), but there is no explicit when-to-use, when-not-to-use, or named alternative such as generate_newman_report. The agent must infer the selection criteria.

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