Index Git Coedits

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

No annotations are provided, so the description carries the full disclosure burden. It usefully explains the semantics of the edges produced (files changing together without an import link), but omits whether it writes edges into the graph, whether it is idempotent, its cost on large histories, or any required permissions.

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?

A single front-loaded sentence with a colon-delimited clarification; nothing is wasted. It is tight, though one extra clause on parameters could have been spent without bloat.

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 output schema exists so return values needn't be described, but the tool evidently mutates graph state and the description says nothing about that effect, and it leaves all three parameters undocumented. Adequate for purpose, incomplete for correct invocation.

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 0%, so the description must compensate for three parameters and does not. In particular min_shared_commits (default 3) is a non-obvious threshold that is never explained, and vault versus repo scoping is left ambiguous.

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?

States a specific verb ("Derive") and resource ("co_edit edges") and the source ("this repo's git history"), with a clarifying gloss on what co-edit means. It is distinguishable from siblings like index_repo, though it doesn't name any alternative explicitly.

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?

No when-to-use, when-not-to-use, or prerequisite guidance. The description implies the operation only through its subject matter and never tells the agent when this is preferable to index_repo, reindex_paths, or detect_divergence.

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