ansible-know-mcp

Overview Schema Source Related Servers Score Discussions Admin

get_collection_docs

Read-only

Retrieve complete parameter-level documentation for all modules in a Galaxy collection in one API call. Ideal for batch operations needing full module details without installation.

Instructions

Get full parameter-level documentation for every module in a collection from Galaxy.

WARNING: output can be very large (100 KB+) for collections with many modules. Use get_collection_manifest first for a compact overview, then get_module_doc for the specific modules you need. Reserve this tool for batch operations that genuinely need all parameter details at once (e.g. skill generation).

Returns all module docs in a single API call without installing the collection. Result shape: {"modules": {fqcn: {module_name, short_description, params, examples, is_api_module}, ...}, "doc_source": "galaxy", "doc_version": str}. On failure returns {"error": str}.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`version`	No	Optional version (e.g. '3.23.0'). If omitted, uses latest.
`collection_namespace`	Yes	Collection namespace (e.g. 'netbox.netbox')

Output Schema

TableJSON Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.7.0Jul 7, 2026

TDQS

A4.7/5.0

Behavior5/5

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

Beyond the readOnlyHint annotation, the description adds a large-output warning (100 KB+), states the result shape with keys, notes failure returns {'error': str}, and clarifies it does not install the collection. This gives the agent concrete expectations for behavior and consequences.

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?

Front-loaded purpose, then warning, usage guidance, result shape, and failure behavior. Each sentence serves a distinct informative purpose with no filler; compact despite covering multiple aspects.

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?

Given the output schema is present, the description appropriately focuses on behavior not covered by schema: output size, API-call characteristics, failure shape, and recommendation context. It is complete for a moderate-complexity read-only tool.

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 3 applies. The description does not add new parameter meaning beyond the schema; it references collection-level docs but leaves parameter details to the well-documented input 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?

Description opens with a specific verb+resource+scope: 'Get full parameter-level documentation for every module in a collection from Galaxy.' It also distinguishes itself from siblings by contrasting with get_collection_manifest and get_module_doc, so the purpose is explicit and unique.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides explicit when-to-use guidance: use get_collection_manifest first for compact overview, get_module_doc for specific modules, and reserve this tool for batch operations needing all parameter details. This is clear guidance with alternatives and exclusions.

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