wireshark_read_packets

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

Warns about large JSON complexity and describes return format and error types. Without annotations, this sufficiently covers read-only behavior, though it lacks explicit mention of non-destructiveness.

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?

Well-structured with Args, Returns, Errors, Example sections, but slightly verbose. Every sentence contributes value; could trim redundant warnings but remains clear.

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?

Covers deprecation, alternatives, all parameters, return types, errors, and usage example. Output schema exists, so not needed. Complete for a deprecated tool with many siblings.

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 has 0% description coverage, so description compensates fully. Explains each parameter: pcap_file path, limit default/max, offset for pagination, display_filter with example syntax.

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?

Clearly states it reads packet data in structured JSON format. Explicitly marks as deprecated and references preferred alternatives, distinguishing from siblings like wireshark_get_packet_list.

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?

Explicitly advises against use in new workflows and directs to wireshark_get_packet_list and wireshark_get_packet_details. Also provides example and parameter descriptions that clarify when and how to use.

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