Skip to main content
Glama

Collection upgrade impact

ansible_upgrade_impact
Read-onlyIdempotent

Check which Ansible project tasks break when a collection moves to an exact version. Reports removed modules/options, new required options, file:line impacts, requirements constraints, and a verdict.

Instructions

What breaks in THIS project's tasks if one collection moves to an exact version: removed or moved modules (meta/runtime.yml redirects and tombstones), removed options and aliases, newly required options, dropped choices, type and default changes, each tied to the task's file:line, plus requirements.yml constraints and a verdict. Downloads the target collection from Galaxy (or the configured servers) into this server's cache on first use; never touches dir, requirements files or your collections paths.

Input Schema

NameRequiredDescriptionDefault
dirNoAnsible project directory. Default: ANSIBLE_MCP_DIR, else the server's working directory.
versionYesExact target version, e.g. 12.0.0 (not a constraint)
playbooksNoPlaybooks to walk (default: all detected)
collectionYesnamespace.name, e.g. community.general
syntax_checkNoConfirm with ansible-playbook --syntax-check against the target
include_unusedNoAlso list removed/moved/deprecated content of the collection this project does not use (capped at 200)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.2

TDQS

A4.3/5.0
Behavior5/5

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

Annotations cover read-only/idempotent/non-destructive, and the description adds genuinely non-derivable behavior: it downloads the target collection from Galaxy or configured servers into the server's cache on first use (network + latency implication) and explicitly guarantees it will not modify the project directory, requirements files, or collections paths. That mutation-safety boundary is exactly the kind of context annotations cannot express.

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 dense sentences with no filler; the finding categories and the side-effect guarantee are front-loaded before the download caveat. The enumeration of change classes is long but each item is informative rather than redundant.

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 six-parameter, no-output-schema analysis tool, the description conveys the return shape (per-finding file:line attribution, requirements.yml constraints, a verdict) and the side-effect profile, which is what an agent needs to decide to call it. Minor gaps remain around syntax_check interplay and result ordering, but nothing critical is missing.

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 parameters like dir, version, playbooks, syntax_check, and include_unused are already fully documented in the schema. The description mentions requirements.yml constraints and the file:line attribution, but adds no syntax, format, or default nuance beyond the schema, so the baseline of 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 and resource with unusual precision: it reports what breaks in the current project's tasks when one collection moves to an exact version, enumerating the change classes (redirects, tombstones, removed options/aliases, newly required options, dropped choices, type/default changes). This is clearly differentiable from siblings like ansible_collections (inventory of installed collections) or ansible_module_doc (docs lookup).

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 'if one collection moves to an exact version' framing establishes the triggering scenario clearly, and the download/caching sentence plus 'never touches dir, requirements files or your collections paths' sets expectations for a pre-upgrade probe. However, no alternative tool is named for adjacent questions (e.g. a plain version listing), so an agent must infer the boundary rather than being routed explicitly.

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