gp_index

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

Discloses that indexing is slow and only needed after source changes. No annotations exist, so description carries behavioral burden. Could mention what happens if index is stale, but current detail is sufficient.

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, front-loaded with action, then usage guidelines. Every word serves a purpose; no fluff.

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?

With no output schema, return values are not described, but for a simple re-index action this is acceptable. Covers when, why, and side effects (slowness). Minor gap: no mention of success/failure feedback.

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%, but description adds value by detailing the resolution order for the optional path parameter: GRAPHPILOT_ROOT, MCP workspace roots, parent walk, or a single ~/.graphpilot index.

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 uses specific verb "re-index" and resource "repo", and distinguishes from sibling tools (gp_callers, gp_impact, gp_recall) by stating when to call (after batch edits) and when not to (not before every query).

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?

Explicitly states when to use: "after batch edits" and when not to: "Do NOT call before every query". Also provides rationale: "indexing is slow; only needed when source files changed."

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