sd_get_collection_stats

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

No annotations are provided, so the description must convey behavior. It states that it returns a CollectionStats object and describes the collection parameter, implying a read-only operation. However, it does not explicitly deny side effects, mention permissions, or discuss limitations, so it is adequate but not comprehensive.

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 well-structured with clear sections (PURPOSE, WHEN TO USE, Args, Returns) and no wasted words. It is compact yet informative, staying within a few sentences.

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 tool with one parameter and an output schema, the description provides sufficient guidance for an agent to decide when and how to invoke it. It covers the main use cases, parameter meaning, and return type, making it a complete standalone description.

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 schema only defines a single string parameter with a default. The description adds critical context: 'collection' is a path relative to data_path, and an empty value represents the root collection. This fully compensates for the 0% schema description 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 opens with 'Get statistics about documents in a collection' and includes a PURPOSE section clarifying it measures size/content. This clearly distinguishes it from sibling tools like sd_list_collections or sd_list_collection_contents.

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 WHEN TO USE section gives concrete scenarios (e.g., 'how many documents are there?') and advises using it before browsing/searching. It does not explicitly state when not to use it or name alternative tools, so it is clear but lacks exclusionary guidance.

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