Skip to main content
Glama

git_inspect

Read-onlyIdempotent

Read local Git repository status and diff statistics to review uncommitted changes without staging or committing.

Instructions

Read local repository status and diff statistics (never stages or commits).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "project_path": "<project_path>"
    },
    "name": "git_inspect"
  }
}

Input Schema

NameRequiredDescriptionDefault
project_pathYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description reinforces this with 'never stages or commits', which is a useful confirmation that the working tree and index are left untouched. What it omits is behavior on error or unusual inputs – e.g. a non-repo path or a path with no commits – and any sense of output volume for large diffs.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

One sentence, front-loaded with the resource and action, with the scope-limiting parenthetical earning its place. There is no filler or restatement of the tool name.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a one-parameter read-only tool with full annotation coverage and no output schema, the description covers the essentials: what is read and what is never touched. The gaps – parameter meaning and the shape of 'diff statistics' – are modest given the tool's low complexity, though the latter leaves the agent guessing about return detail.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

There is a single required parameter, project_path, with 0% schema description coverage and no enum or format hint. The description never mentions it, so the agent gets no guidance on whether it is a repository root, a subdirectory, a relative or absolute path, or whether worktrees are accepted. With only one parameter the burden is small, but the description does nothing to compensate for the empty schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description gives a specific verb+resource pair ('Read local repository status and diff statistics'), so the agent knows it inspects git state without mutating anything. The parenthetical narrows the scope further. It doesn't need sibling differentiation because no other git-oriented tool appears in the sibling list, but it also doesn't pin down what 'diff statistics' means (working tree vs. staged vs. against HEAD).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The phrase 'never stages or commits' implicitly tells the agent when this tool is inappropriate – anything that needs to change repository state. However, there is no explicit when-to-use statement, no mention of prerequisites (does the path need to be a git repo root?), and no named alternative for write operations.

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