gitAdd

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

Annotations indicate non-destructive. Description adds behavioral detail: when files omitted, stages all tracked (git add -u); addUntracked includes new files. 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?

Two sentences, front-loaded with purpose, no wasted words.

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?

Covers main use cases and parameter behaviors. No output schema, but effect is clear. Lacks mention of return value (e.g., success message), but acceptable for simple tool.

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 covers both parameters fully. Description enhances meaning by explaining the effect of omitting 'files' and the role of 'addUntracked', going beyond the schema.

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?

Description clearly states the tool stages files for commit, distinguishes between staging all tracked files vs. including untracked ones. This separates it from sibling tools like gitCommit or gitCheckout.

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 clear usage guidance on how to use parameters (omit files for all tracked, use addUntracked for new files). No explicit comparison to alternatives, but no direct staging siblings exist, so adequate.

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