string_escape

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

The description lacks details about the specific set of special characters that are escaped/unescaped, potential side effects, or limitations. With no annotations, the description should disclose more behavioral traits.

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?

The description is concise and front-loaded with a clear statement of purpose. The parameter list is well-structured, though it could be more integrated into the main description.

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 description is too brief for a string escape tool. It does not specify which special characters are handled (e.g., backslashes, quotes) or the output format. Although an output schema exists, the description should provide more context for safe usage.

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?

The description explains the purpose of each parameter ('text' is the string to process, 'mode' specifies escape or unescape), adding meaning beyond the schema's types and defaults. This is important given 0% schema description coverage.

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 that the tool escapes or unescapes special characters in strings. The verb 'escape' is specific and indicates the operation. However, it does not differentiate from sibling tools like 'html_escape' or 'url_encode_decode' which might have similar purposes.

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 guidelines are provided about when to use this tool versus alternatives. There is no mention of context, prerequisites, or scenarios where this tool is appropriate.

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