show_diagnostic
Show git repository diagnostic info: current branch, upstream, HEAD SHA, remote URLs, and status summary.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| workingDirectory | No | Git repo path. Default current directory. | . |
Show git repository diagnostic info: current branch, upstream, HEAD SHA, remote URLs, and status summary.
| Name | Required | Description | Default |
|---|---|---|---|
| workingDirectory | No | Git repo path. Default current directory. | . |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must carry the full burden. It describes a read-only operation ('Show') without side effects, but does not mention authorization needs or other behavioral traits. The description is adequate but minimal.
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 a single sentence that front-loads the verb and resource, then lists specifics. Every word is relevant, with no waste.
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 info tool with one optional parameter and no output schema, the description fully covers the purpose and scope. No additional context is needed.
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 description coverage is 100% (the only parameter 'workingDirectory' has a description in the schema). The tool description does not add any further meaning beyond what the schema provides, so baseline score of 3 is appropriate.
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 verb 'Show' and the resource 'git repository diagnostic info', followed by specific items (branch, upstream, SHA, remote URLs, status). This distinguishes it from siblings like show_remote or show_history which have more narrow focus.
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 the tool is for viewing diagnostic info, but does not explicitly state when to use it versus alternatives (e.g., show_remote for remotes only). No when-not or alternative guidance is provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.
Each tool has a clearly distinct purpose. Even similar tools like 'undo_changes' and 'restore_file' differ in scope (all vs single file), and 'find_changes' vs 'show_change' list files vs show diffs. No two tools overlap ambiguously.
All tool names follow a verb_noun snake_case pattern. While verbs are not perfectly uniform (e.g., 'get_vault_status' vs 'show_history'), the naming is consistent and predictable, with no mixed camelCase or confusing conventions.
22 tools is on the higher side but appropriate for a comprehensive Git server covering branch management, commits, pushes, credentials, diagnostics, and more. The number is manageable and each tool serves a distinct function.
The tool set covers essential operations but has notable gaps: there's no branch listing, pull/merge, or stash functionality. Agents may encounter dead ends when needing these operations, though core workflows like commit and push are well supported.