websex_arp_scan

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 discloses two useful behavioral traits: shell parsing is never used (argv tokens passed directly) and it runs within the selected engagement namespace. Key details are still missing, such as required privileges, timeout behavior, and what the output contains.

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?

Two sentences, front-loaded with the tool's purpose and augmented by operational notes. Efficient, though slightly terse for a security tool without annotations.

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 network scanning tool with no annotations, no schema descriptions, and a complex argument-list parameter, the description is thin. The output schema existence means return values needn't be described, but the lack of privilege requirements, timeout expectations, and argument format leaves significant gaps.

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 description coverage is 0%, so the description must compensate. It only vaguely references 'supplied argv tokens' and 'relative paths for engagement artifacts', leaving engagement_id, arguments, stdin, and working_directory largely undocumented in both schema and description.

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?

States a specific verb (Run arp scan) and resource (WebSex network toolkit / arp-scan), so the purpose is unambiguous. It does not explicitly name a sibling alternative such as websex_nmap or websex_netbios_scan, so it falls short of a 5.

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 through 'Run arp scan' and 'Runs from the selected engagement namespace', and the path guidance ('use relative paths for engagement artifacts') gives some operational context. However, it does not state when to prefer arp scan over alternatives like websex_nmap, websex_netbios_scan, or websex_network_mapper, so guidance is only implied.

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