get_stats

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

With no annotations, the description carries full burden but only states a read-like operation. It does not disclose whether the tool is purely read-only, requires specific permissions, or how it behaves with invalid project paths. No side effects or error conditions are mentioned.

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?

Extremely concise at three words, but lacking structure or front-loading of key information. While brevity is valued, the description sacrifices completeness for conciseness, providing minimal actionable guidance.

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?

No output schema, and the description does not specify what the tool returns (e.g., numeric stats, object). For a simple tool with one parameter, more detail (like return format or example values) would greatly improve completeness without needing an output schema.

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%, and the description adds no meaning beyond what the parameter's own description already provides. The tool's one-line description does not elaborate on parameter usage or constraints, so it relies entirely on the schema.

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 'Get index statistics' conveys the verb and resource but lacks specificity about what 'index statistics' entails (e.g., document count, size). It does not distinguish itself from sibling tools like 'list_documents' or 'list_projects', which could also relate to index information.

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?

No guidance on when to use this tool versus alternatives such as 'list_documents' or 'search'. The description does not mention prerequisites, typical use cases, or scenarios where this tool is preferred over siblings.

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