snapshot_index

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

No annotations are provided, so the description carries full burden. It discloses the dependency on prior snapshot creation and the columns returned, but does not explicitly state read-only behavior, return format, or potential side effects. The prerequisite and column detail add some value beyond a bare list.

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?

Two sentences, front-loaded with the action and resource. The first sentence defines the output, and the second gives usage and prerequisites. No redundant or filler content; every sentence earns its place.

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 tool's low complexity (one optional parameter, no output schema), the description adequately covers purpose, columns, usage context, and a prerequisite. It does not explicitly describe the return format, but for a simple uid listing this is largely self-evident and the dependency guidance provides essential context.

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 parameter maxResults, which includes description, default, min, and max. The description adds no additional information about this parameter, so the schema already does the heavy lifting, resulting in the baseline score of 3.

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?

Description states 'List uids from the most recent snapshot' with specific columns (role, name, path), clearly identifying the resource and action. It distinguishes itself from siblings like snapshot_diff and page_search by focusing on uid listing from a 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?

Provides explicit usage context ('Useful before page_search or get_node') and a prerequisite ('Requires smart_snapshot or snapshot_diff first'). However, it does not mention when not to use or name alternatives, so it falls short of a 5.

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