gograph_changes

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

Describes read-only nature, no side effects, prerequisite requirement, and behavior variation with/without git_ref. Complements annotations (readOnlyHint, idempotentHint) without contradiction.

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?

Concise yet comprehensive, front-loaded with core function, logically structured with labeled sections (WHEN/NOT TO USE, RETURNS), 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?

Covers all aspects: purpose, parameter semantics, prerequisites, use cases, exclusions, and return types. No gaps given the tool's simplicity and no output schema.

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 coverage is 100% and schema describes git_ref well. Description adds context by explaining how git_ref changes behavior, providing integrated understanding beyond schema.

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 it lists structurally modified Go symbols, with distinct behavior for working tree vs. git reference. Differentiates from siblings like gograph_impact and gograph_review.

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?

Explicit WHEN TO USE (after edits) and NOT TO USE (line diffs, blast-radius) sections with alternative tool names, providing clear decision guidance.

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