stageEdit

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

Description states 'Stage a file edit' which modifies transaction state, contradicting the readOnlyHint annotation (true) that implies no state mutation. This is a serious inconsistency.

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 with no fluff, front-loaded with key information. Every sentence adds value.

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?

Given the tool's role in a transaction lifecycle, description lacks details about prerequisites (active transaction), post-staging steps (commit), or return values. Missing crucial context 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 description coverage is 100%, so baseline is 3. Description adds no additional meaning beyond the schema; it only references 'same params as previewEdit' without elaborating.

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?

Description clearly states the tool stages a file edit inside a transaction, supporting lineRange and searchReplace operations, and explicitly says it does NOT write to disk. This distinguishes it from siblings like 'editText' and 'previewEdit'.

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?

Description implies usage within a transaction but does not provide explicit when-to-use or when-not-to-use guidance compared to siblings. It mentions same params as previewEdit but no exclusion criteria or alternatives.

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