replace_signature

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

Description discloses that it preserves body and decorators, a key behavioral trait. With no annotations, it provides an example but could mention potential side effects like file modification. Still, it is informative.

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?

Description is compact: one sentence for purpose, one for usage guidelines, and an example. No redundancy, well-structured.

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 3 params and no annotations, the description covers usage and provides an example. Output schema exists to explain return values. Could mention return value or error handling, but overall sufficient.

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 3 required params with 0% description coverage. Description adds value through an example showing target format (function path) and new_signature (Python code with indentation). Does not explicitly describe file_path, but it's self-explanatory.

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 'Replace only the signature of a function', specifying verb and resource. It distinguishes from siblings like replace_function and add_parameter by explicitly naming them.

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 (changing parameters, return type, function name) and when not to (changing body -> use replace_function, adding/removing one parameter -> use add_parameter/remove_parameter). Provides clear guidance.

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