backup_vault

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

Since no annotations are provided, the description carries the full burden of behavioral disclosure. It clearly explains the tool runs git commands, automatically initializes a git repo if missing, and returns a 'no_changes' status instead of an error when there are no changes. This adequately informs the agent of side effects and edge cases.

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 exceptionally concise, with the main purpose stated in the first sentence. Subsequent details are logically organized: use case, behavior with vs without parameter, auto-init, and no-change response. Every sentence adds value without redundancy.

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 the tool has no output schema, the description fully compensates by detailing return behavior (including the 'no_changes' status), git operations, and initialization logic. This covers all essential aspects a developer or AI agent would need to invoke the tool correctly.

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 coverage is 100% as the only parameter 'vault_name' is documented. The description adds value by explaining the effect of omitting the parameter (backs up all vaults), which goes beyond the schema description that merely states 'omit to back up all vaults.' This provides actionable insight.

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 opens with 'Create a git commit snapshot of a vault's current state,' which clearly specifies the verb ('create snapshot'), resource ('vault'), and mechanism ('git commit'). This distinguishes it from sibling tools like 'audit_project' or 'check_doc_changes' which serve different purposes.

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 when to use this tool: 'when the user asks to back up, sync, or save the current state.' It also explains the behavior for vault_name provided vs omitted, guiding usage. However, it does not mention when not to use it or list alternatives.

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