Skip to main content
Glama

Grade collection documentation

grade_collection

Evaluates an Ansible collection's documentation quality by analyzing module RETURN documentation and optionally checking roles for output_specs.yml, producing an A-F grade.

Instructions

Grade a collection on documentation quality. Returns A-F grade based on module RETURN documentation. With ANSIBLE_OUTPUT_SPECS=true, also checks whether roles have output_specs.yml.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
namespaceYesCollection namespace
nameYesCollection name
Behavior3/5

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

No annotations are provided, so the description must carry the behavioral load. It describes the grading logic and optional environment variable behavior, but does not explicitly state that the tool is read-only or any other side effects. This is adequate but could be improved.

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?

Two sentences, front-loaded with primary purpose. Second sentence adds optional behavior. No superfluous words.

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?

For a simple tool with two fully described parameters and a clear output (A-F grade), the description is complete. It also covers the optional environment variable behavior.

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 baseline is 3. The description adds no additional parameter meaning beyond the schema.

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 clearly states the verb 'grade', the resource 'collection', and the basis for grading (module RETURN documentation and optionally output_specs.yml). It is distinct from siblings which retrieve modules, roles, or specs.

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 description explains what the tool does but does not explicitly state when to use it vs alternatives. No exclusions or context about when not to use it is provided.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/fabiendupont/mcp-ansible-galaxy'

If you have feedback or need assistance with the MCP directory API, please join our Discord server