register_edit

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

Annotations provide idempotentHint. Description adds that it mutates the index, explains cache invalidation, duplication checks, and return format, providing context beyond annotations.

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?

Four sentences, front-loaded with action and immediate effects, then usage and warnings. No redundant 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?

Tool has one param, no output schema, but description explains return JSON structure fully. Covers purpose, usage, side effects, and duplication warnings.

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 has 100% coverage for the single parameter. Description adds minimal extra context (relative path, edited file), but baseline is 3.

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 notifies trace-mcp of an edited file, reindexes it, and invalidates caches. It distinguishes from siblings like reindex by noting it's lighter.

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 says to call after Edit/Write, contrasts with full reindex, and gives guidance on handling duplication warnings.

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