ruddur_list_heading_snapshots

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

Annotations already declare the tool as readOnly, idempotent, and non-destructive. The description adds the auth requirement ('Requires scope: content.read'), which is valuable context beyond the annotations. It does not describe pagination or return format, but the bar is lower given the annotations.

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 description is a single sentence with the key information front-loaded: what the tool does and what auth scope is required. Every word contributes meaning, with no redundant or vague phrasing.

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?

The tool is a simple list operation with a single required parameter and rich annotations covering safety. The description clearly states the resource and scope, and while it omits details like pagination or output structure, the tool's simplicity and name make it sufficiently complete for an agent to invoke correctly.

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?

The input schema provides descriptions for all parameters, including the required path parameter 'id' for the heading. The description's phrase 'for a Heading' adds no additional meaning beyond what the schema already states, so it meets the baseline for high schema coverage.

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 uses a specific verb ('List') and resource ('snapshots for a Heading'), clearly distinguishing it from sibling tools like ruddur_list_headings. It also adds the required scope, making the tool's purpose unambiguous.

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 provides clear context: use this tool to list snapshots for a specific heading, identified by the path parameter. It does not mention alternatives or exclusions, but the purpose is straightforward and the required scope is stated, giving sufficient guidance for a simple read operation.

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