metasploit_generate_payload

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

With no annotations, the description carries the burden of disclosure. It reveals a key side effect (writes payload bytes to /opt/workspace/payloads/) and the fallback mechanism (RPC to msfvenom). This is valuable context beyond the schema, though it omits failure modes or exact side effects of overwriting files.

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 well-structured with labeled sections (Purpose, Constraints, Example) and is compact. Every sentence serves a purpose, and the example illustrates usage without unnecessary verbosity.

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 covers the essential purpose, constraints, side-effect location, and an example. It lacks details on error handling, format options, or when to use the RPC vs fallback path, but the presence of an output schema may partially compensate for return format. Context is adequate but has clear gaps for a tool with nested options.

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 0%, so the description must compensate. It does add meaning by explaining that options should include LHOST/LPORT and that format controls output format, plus an example payload. However, it does not enumerate possible formats or all option fields, leaving gaps for a nested object with additionalProperties true.

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 generates a payload via Metasploit RPC or msfvenom fallback, which is a specific verb+resource. It does not explicitly distinguish itself from sibling Metasploit tools, but the purpose is unambiguous and the payload generation scope is clear.

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 gives usage constraints like passing payload and options (LHOST/LPORT) and controlling format, but it does not explicitly state when to use this tool versus alternatives (e.g., metasploit_run_module). Usage is implied from the purpose, but no when-not-to-use or alternative references are provided.

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