regexreplace

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

Without annotations, the description carries the burden of disclosing behavior. It discloses the effect of /g and /i flags, which is valuable. But it omits the default behavior (first occurrence only) and any handling of invalid patterns or replacement string semantics.

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?

Three concise sentences that front-load the primary purpose and provide formatted instructions without redundancy. Every sentence adds useful information.

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?

Despite the clear core purpose, the description is incomplete for a zero-schema tool: it doesn't specify how the input string is provided, what the replacement string is, or what the return value is. The mismatch between the empty schema and the pattern syntax described could confuse an agent.

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 input schema has zero properties, so the description must compensate. It explains the pattern format (leading/trailing slashes) and flags, adding meaning beyond the empty schema. However, it entirely omits the replacement string parameter, which is an essential part of a replace operation, leaving a critical gap.

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 'Find and replace within a String using a RegEx pattern', giving a specific verb, resource, and method. This distinguishes it from sibling 'replaceall' which implies literal replacement, though it doesn't explicitly name alternatives.

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?

It provides explicit usage instructions for pattern syntax ('Include the leading and trailing '/' in your pattern') and flag behavior ('If the /g flag is used, it will replace all occurrences. Use the /i flag...'), which guides the agent on correct invocation. However, it doesn't mention when to prefer this over siblings like 'replaceall' or 'regex'.

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