string_escape

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

No annotations are provided, so the description carries the full burden. It explains what the tool does for each style (e.g., shell yields a paste-safe single-quoted token). However, it does not explicitly state the return type (escaped string) or discuss edge cases like handling null characters or unicode normalization.

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 very concise, using only a few sentences. It is front-loaded with the main purpose, uses backticks for style names, and avoids unnecessary words. Every sentence adds value, making it efficient for an AI agent.

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 low complexity (2 parameters, no output schema, no annotations), the description covers both parameters well, provides usage guidance, and distinguishes from siblings. It could mention the return format (escaped string) to be fully complete, but overall it is adequate.

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 schema has 0% description coverage, so the description must compensate. It explains the 'text' parameter as 'Escape text' and provides detailed explanations for each 'style' option, including symbols and examples. This adds significant meaning beyond the enum values.

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's function: 'Escape text for a source-code or markup context'. It specifies the verb 'escape' and the resource 'text'. It distinguishes from the sibling tool 'encode' by noting that URL escaping should use encode(scheme='url') instead, and mentions the inverse tool 'string_unescape'.

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?

The description provides explicit guidance on when not to use this tool (URL escaping) and points to an alternative. It lists the available styles and briefly explains each, but could offer more detail on selecting among similar styles like json, js, and python.

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