Retrieve structured Git branch, HEAD, staged, dirty, and untracked state to assess a repository's working tree before commit or automation.
Return structured branch, HEAD-related dirty, staged, and untracked Git state.
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes |
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Changes observed during successful MCP inspections.
v1.1.2Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is fully covered. The description adds the returned state categories (branch, dirty, staged, untracked), but with an output schema present this adds limited behavioral value beyond structured fields.
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?
A single, front-loaded sentence that contains no filler. Every word earns its place by naming the verb, the output structure, and the key state components.
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?
Annotations fully cover safety and mutation behavior, and the output schema means return values need not be explained. However, the required path parameter is undocumented in both schema and description, leaving a meaningful gap for correct invocation.
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 only parameter, path, has 0% schema description coverage and is not mentioned at all in the description. An agent must infer that path means a repository or working-tree path; the description does nothing to compensate for the absent schema semantics.
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?
States a specific verb (Return) and resource (structured Git state) and enumerates the state categories: branch, HEAD-related dirty, staged, and untracked. This distinguishes it from siblings like git_diff, git_log, and git_show, which deal with diffs, history, and object inspection respectively.
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 by naming the returned state categories, but it gives no explicit when-to-use guidance, no when-not-to-use exclusions, and no routing to alternatives such as git_diff or shell. For a status-inspection tool among several Git siblings, this is adequate but under-guided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.