html_escape

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

With no annotations, the description carries the burden of behavioral disclosure. It mentions the core operation and the entities handled, but does not disclose edge cases such as whether existing entities are double-escaped, behavior for non-listed characters, or the return format. This is minimal but not misleading.

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 a single, front-loaded sentence with no redundancy. It conveys the full purpose and key details efficiently.

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?

For a simple text transformation tool, the description covers the essential purpose and entity set. However, it does not explicitly describe the return value (since there is no output schema), and the 'text' parameter lacks documentation. Still, it is largely complete for its simplicity.

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 coverage is 50% (only 'mode' has a description, 'text' does not). The description adds meaning by specifying the HTML entities involved, which implies the content of 'text', but it does not elaborate on parameter behavior beyond what the schema already states for 'mode'.

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 'Escape or unescape HTML entities (& < > " ')' clearly states the action (escape/unescape) and the target resource (HTML entities), listing specific characters. This distinguishes it from sibling utilities like base64_codec or hash_text, which perform different transformations.

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 implies usage (when you need to escape or unescape HTML) but provides no explicit guidance on when to use this tool versus alternatives, nor any exclusions. It is adequate but lacks contextual direction.

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