bricks_list_snapshots

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

No annotations are present, so the description must convey behavioral traits. It mentions the data fields returned (name, description, element count, timestamp), but does not disclose permissions, side effects, or whether the operation is read-only. The read-only nature is implied but not stated.

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 two sentences, front-loading the action and listing output fields. Every sentence is valuable, and there is no unnecessary text.

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?

Given the simple nature (1 param, no output schema), the description covers the purpose and outlines the return fields (name, description, element count, timestamp). It lacks details on the return format (e.g., array ordering), but is adequate for basic usage.

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 coverage is 100% for the single required parameter 'page_id,' with a schema description. The tool description does not add meaning beyond the schema, as it only restates that the tool lists snapshots for a page.

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 what the tool does: 'List all named snapshots for a page.' It specifies the verb 'list' and the resource 'named snapshots for a page,' and distinguishes it from sibling tools like 'bricks_create_snapshot' and 'bricks_delete_snapshot.'

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 implies usage for retrieving snapshot lists, and sibling tools clearly differentiate creation, deletion, and restoration. However, no explicit guidance on when to use this tool versus alternatives is provided.

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