Sync Vault

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. The description says it triggers a sync and updates vectors and indexes, but it doesn't mention whether it's safe to call (read-only vs mutating), what side effects occur (e.g., does it modify the vault or just the index?), or any performance implications. An agent cannot infer the safety profile from this sparse description.

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 concise, with two sentences: the first states the primary action, and the second elaborates on scope and effects. It's front-loaded with the key verb, and there's no wasted words. However, it could have been structured to include a leading phrase for when to use it, but it's still efficient.

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 that this tool has no parameters and an output schema exists, the description doesn't need to explain return values. However, the description lacks context on when to use it relative to siblings (e.g., after editing notes) and what the impact is. It's adequate for a simple trigger tool but could be improved by mentioning that it's for keeping search indexes up to date, which is implied but not explicit.

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?

Since there are no parameters, the description needs to explain the scope of the sync, which it does by mentioning it's incremental and scans for created/modified/deleted notes. With zero parameters, the baseline is 4, and the description doesn't need to compensate for parameter documentation; it provides clear semantics for what the tool does without any input.

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's verb ('Trigger incremental sync') and the resource ('Obsidian vault'). It also specifies what the sync does: scanning for created, modified, or deleted notes and updating dense vectors & FTS5 index. This is specific and distinguishes it from search_vault and get_note, which are read operations, though it doesn't explicitly name them as alternatives.

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 when to use this tool: whenever the vault's notes have changed and you need indexes updated. However, it doesn't explicitly state when not to use it (e.g., for full re-index) or compare it to search_vault or get_note as alternatives for different purposes. The context that it's for syncing is clear, but exclusions are absent.

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