List Property Keys

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

Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true. Description adds behavioral details: folder parameter prefix matching and recursion, sorted return array with top 3 sample values, and return format. No contradictions.

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?

Efficiently structured: first sentence states purpose, then example, then usage context, then alternatives, then parameter behavior, then return format. No wasted words, information is 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?

Given one parameter, full schema description coverage, and no output schema, the description fully covers purpose, parameters, return format, and usage context. Annotations already cover safety. Complete for an AI agent.

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?

Single parameter 'folder' has schema description, but description adds crucial detail: path prefix matching, recursion into subfolders, and omission behavior (scan entire vault). This goes beyond schema and clarifies usage significantly.

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?

Clearly states the tool discovers all property keys with note counts and sample values. Distinguishes from siblings like vault_list_property_values and vault_search_by_property by explicitly naming them and contrasting use cases.

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 when-to-use (discovering properties before searching, vault orientation), and when-not-to (prefer vault_list_property_values for full values, vault_search_by_property for key-value). Also mentions it's a good first step alongside vault_list_tags.

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