get_collection_manifest

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

The annotations only declare readOnlyHint: true, but the description adds substantial behavioral context: cached vs. on-demand generation, metadata extraction with no skill generation, error return shape, and the partial-failure behavior where a hard batch failure yields zero module entries but retains roles/plugins. This goes well beyond the annotation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

Every sentence earns its place: purpose, usage guidance, caching behavior, error shape, and failure semantics. The description is front-loaded with the core purpose and then methodically covers edge cases without fluff.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a single-parameter tool with an output schema, the description covers purpose, selection criteria, caching, generation side effects, error returns, and degraded batch behavior. It is fully self-sufficient for an agent to decide when and how to invoke it.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%: the only parameter, collection_namespace, already includes an example ('netbox.netbox'). The tool description does not add additional parameter-level detail, so the schema carries the load; this meets the baseline but does not exceed it.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a specific verb and resource: 'Get a lightweight collection overview: module/role/plugin names with one-line descriptions.' It clearly distinguishes this from the sibling get_collection_docs by framing it as the preferred exploratory overview tool, and points to get_module_doc for drilling down.

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

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

The description explicitly says 'Prefer this over get_collection_docs when exploring a collection' and notes it is 'suitable for deciding which modules to drill into with get_module_doc.' This gives clear context and names alternatives, though it does not enumerate explicit when-not-to-use cases beyond the preference statement.

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