Vault List

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint, so the safety profile is covered. The description adds the app-only and SPA context, which is valuable behavioral context beyond the annotations, clarifying the intended invocation path and non-LLM visibility.

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 concise sentences with zero waste. The primary purpose is front-loaded, and the app-only note follows naturally. 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?

For a simple read-only tool with one optional parameter, annotations cover safety, an output schema exists (so return format is defined), and the description clarifies usage scope. Nothing an agent needs to correctly avoid or understand this tool is missing.

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 single 'folder' parameter with its description ('Folder to list (root if omitted).'), giving 100% coverage. The tool description adds no extra parameter detail, so the baseline of 3 is appropriate since the schema already carries the meaning.

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 the tool lists folders and notes in a vault directory, using a specific verb and resource. It also distinguishes itself from sibling tools like list_folders and list_documents by covering both types, and notes it's app-only, which further clarifies its role.

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 explicitly states it is called by the SPA browser view via app.callServerTool() and is not visible to the LLM, which tells an agent this tool is not for direct LLM use. It doesn't name alternative tools, but the app-only note strongly implies the agent should look elsewhere for LLM-facing list operations.

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