get_dataflash_summary

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

No annotations are provided, so the description carries full burden. It indicates a 'get' operation (read-only) but does not disclose any side effects, destructive potential, rate limits, or authentication requirements. The description lacks behavioral context beyond the operation type.

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: the first clearly states purpose and return fields, the second provides a usage note. No redundant information. Front-loaded with key information.

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 no parameters, no output schema, and no annotations, the description provides reasonable context: what it returns and a usage hint. However, it lacks details on return format (e.g., data types) and prerequisites like connection state. Still fairly complete for a simple getter.

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 tool has no parameters, and schema description coverage is 100% (empty schema). The description adds value by listing the returned fields ('ready state, total size, and used size'), which compensates for the empty schema. Baseline for 0 params is 4, and the description meets that.

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 retrieves a summary of onboard blackbox flash storage, specifying 'ready state, total size, and used size.' Among siblings like 'get_blackbox_device' and 'get_blackbox_mode,' this tool is uniquely focused on flash storage summary, making its purpose distinct.

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 note 'call this before any CLI tools in the same session' provides a specific usage order but does not explain when to use this tool versus alternatives or when not to use it. No sibling tools are compared, so guidance is limited.

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