Get Vault Statistics

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint false. The description adds value by specifying the return shape (totalNotes, totalSize, totalTags, lastModified) and their types, which is useful given there is no output schema. However, it doesn't add context about performance or formatting nuances beyond the parameter schema.

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 direct sentence followed by a clear return-type block. No wasted words; the core purpose and output structure are front-loaded.

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 simple stats tool with one optional parameter and no output schema, the description provides sufficient context through the return object. It does not mention error scenarios or edge cases, but for the tool's simplicity, this is adequate. The sibling set confirms this is a distinct aggregate query tool.

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 fully documents the only parameter 'response_format' with its enum, default, and description. The tool description does not add any parameter-specific nuance beyond what the schema already provides. Baseline of 3 applies due to 100% 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 clearly states 'Get statistics about the Obsidian vault' with a specific verb and resource. It distinguishes itself from sibling tools like obsidian_list_notes, obsidian_read_note, and obsidian_get_links by focusing on aggregate vault-level statistics.

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 vault-level aggregates but does not explicitly differentiate when to use this tool vs alternatives. Sibling tool names suggest distinct purposes, and the tool's objective is clear from the name, but no when-to-use or exclusions are provided.

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