index_vault

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

No annotations are provided, so the description must carry the full burden. It states the tool does not modify the vault, which is helpful. However, it fails to disclose behaviors such as the effect of dry_run, what happens on reindex, or prerequisites like requiring the vault to be open. Partial disclosure.

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 extremely concise: two sentences with no unnecessary words. It front-loads the core action and a key safety note. 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?

With 4 parameters, no output schema, and no annotations, the description lacks completeness. The agent is not informed about the behavior of mode (incremental vs full), paths (what happens if omitted), dry_run effects, or the requirement for include_sensitive. More details are needed for safe and effective use.

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 description coverage is low (25%), with only include_sensitive having a description. The tool description adds no information about any parameter semantics, leaving the agent to infer meaning from names only. This is insufficient for 4 parameters.

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 verb 'Index or reindex' and the resource 'Obsidian vault into the external semantic index'. It distinguishes from sibling tools like search_notes, read_note, and index_status by describing a unique operation.

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 creating or updating the semantic index, and states it does not modify the vault, but lacks explicit guidance on when to use this tool versus alternatives like search_notes or index_status. No exclusions or conditions are provided.

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