buffer_overflow_pattern

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

Without annotations, the description bears full responsibility. It clearly explains the behavior: generating a De Bruijn sequence or searching for an offset. It mentions expected input formats (hex or ASCII). The tool is non-destructive and behaves as a calculation utility, so the transparency is sufficient.

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 paragraph with a bulleted argument list and return value note. It is clear and free of fluff, though slightly longer than necessary. The structure front-loads the main purpose and then details parameters, which is effective.

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 tool's complexity (two modes, three parameters), the description is complete. It explains both actions, parameter roles, and return values. The presence of an output schema (not shown) further supports completeness. Context signals show this is a targeted exploitation tool, and the description fits well.

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 0% description coverage, so the description must compensate. It does so by explaining each parameter: action (create/offset), value (hex/ASCII string), length (pattern length or search range). This adds meaning beyond raw schema types and defaults.

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 explicitly states the tool's two main actions: generate a cyclic pattern or find an offset. It compares it to Metasploit's pattern_create/pattern_offset, which immediately clarifies its purpose in binary exploitation. This distinguishes it from sibling tools that focus on disassembly or ROP gadgets.

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 explains when to use the tool: to determine EIP/RIP overwrite offset. It details the two actions and their arguments, providing clear context. While it doesn't explicitly state when not to use it, the purpose is narrow and well-defined.

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