Get Git status

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

Annotations already declare readOnlyHint and idempotentHint, covering the safety profile. The description adds specific output fields (branch, HEAD, modified, staged, untracked), which is useful behavioral context beyond annotations. No contradictions and no side effects are mentioned, but read-only makes that unnecessary.

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?

Single sentence, front-loaded with the action 'Return' and immediately lists the returned data. No filler or 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?

For a simple read-only tool with an output schema, the description covers the return values but omits explanation of the required 'project' parameter. Given 0% schema coverage, this is a notable gap. No prerequisites or error conditions are mentioned, but these may not be critical for such a straightforward operation.

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?

The sole parameter 'project' has 0% schema description coverage. The description does not explain what 'project' should be (e.g., path, name, or repository identifier), leaving the agent to guess the argument format. With such low schema coverage, the description needed to compensate but did not.

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 returns branch, HEAD, modified, staged, and untracked files. This is a specific verb and resource list, distinguishing it from siblings like git_diff and git_commit. The content list provides unambiguous scope.

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?

No explicit guidance on when to use this over siblings like git_diff or git_commit. The description implies it's for checking repo state but doesn't state when not to use it or what conditions favor it. Given overlapping siblings, more direction would help the agent choose correctly.

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