scan_payload_for_value

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

With no annotations, the description carries the full burden. It discloses matching logic (consecutive bytes, binary representation, endianness), offset handling, and auto-calculated byte width. It lacks explicit mention of side effects, but the read-only nature is evident from the return of matching frames.

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 opening sentence is a concise summary, followed by well-structured Args and Returns sections. No fluff or redundancy exists; every line contributes to understanding the tool's operation.

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 all six parameters, matching behavior, and return format. Even though an output schema exists, the description adds useful context about what constitutes a match and the byte-width calculation. It is complete for a search tool with moderate complexity.

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 schema has zero descriptions for its properties, but the description's Args block thoroughly explains each parameter (byte_value, endianness, offsets, limit, session_id) with meanings and defaults. This adds significant value beyond the schema and fully compensates for the lack of property descriptions.

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 'Scan CAN bus payload bytes for a specific decimal value', using a specific verb+resource. It adds details about binary representation and endianness, distinguishing it from sibling tools like query_can_messages or analyze_payload_noise.

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 usage is implied through the action description, but there is no explicit guidance on when to use this tool vs alternatives or when not to use it. No reference to sibling tools or exclusions is provided, so the context is clear but not explicitly guided.

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