jetbrains_inspect_git_changes

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

No annotations are provided, so the description must carry the full behavioral burden. It discloses that the tool only inspects changed files, excludes deleted files, and uses a base ref. However, it does not mention side effects (likely read-only), performance implications, or required permissions, leaving some behavioral aspects unclear.

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 provide all essential information: the core operation (collect and inspect), scope (staged/unstaged/untracked relative to base_ref), and a notable exclusion (deleted files). No unnecessary 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?

The description adequately covers the main workflow for a tool with an output schema. It could elaborate on what 'inspect' entails or list potential prerequisites (e.g., a valid git repo), but for most use cases it provides sufficient context.

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?

With 0% schema description coverage, the description adds significant value by clarifying that parameters relate to staged, unstaged, and untracked files relative to base_ref, and that deleted files are excluded. It does not detail each parameter individually but provides enough context to understand their roles.

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 tool's function: collect changed files from git (staged, unstaged, untracked) relative to a base ref and inspect them using JetBrains inspections. It also notes exclusions (deleted files), making the purpose specific and unambiguous.

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 does not provide any guidance on when to use this tool versus alternatives like jetbrains_inspect_files or code_quality_analyze_git_changes. There is no mention of prerequisites or scenarios where this tool is preferred or should be avoided.

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