List Doc Snippets

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

Annotations already provide readOnlyHint=true, and the description adds useful behavioral context beyond that: it specifies what is returned (slug, content, page-usage count) and the need for project context. It does not contradict the annotations, though it omits details like pagination or ordering.

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?

The entire description is one efficient, front-loaded sentence. It conveys the core action, the relevant resource scope, the returned fields, and a key prerequisite without wasted words.

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 simple read-only list operation with fully described parameters and no output schema, the description covers the main points: what is listed, what fields are included, and a critical context requirement. Minor omissions such as pagination, sorting, or response wrapping prevent a perfect score.

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%, so both versionId and documentationId are already well documented in the input schema. The description does not add further parameter-level meaning beyond the implied 'documentation version' relationship, so the baseline score of 3 applies.

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 clearly states a specific verb ('List'), resource ('snippets of a documentation version'), and the fields returned (slug, content, usage count). It is understandable on its own, though it does not explicitly name sibling tools like get_doc_snippet or list_script_snippets to differentiate itself.

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 gives a clear prerequisite ('Requires project context') that helps an agent know when this tool is callable. It does not explicitly state when to prefer this over alternatives like list_script_snippets, but the documentation-version scoping implies its context.

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