stm32_parse_ioc

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

With no annotations, the description carries the burden. It implies a read-only parse by the verb and output list, but does not explicitly state that the .ioc file is not modified, nor mention error behavior for invalid paths or malformed files. It adds useful output context but no safety or prerequisite detail.

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 a tight action statement followed by a concise bullet list of returned fields. Every line earns its place; there is no filler or redundant restatement of the tool name.

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 one-parameter parser with an output schema, the main action and returned categories are covered, so an agent can likely call it. However, missing usage differentiation and behavioral/error details leave moderate gaps, especially without annotations. The output schema mitigates the need to list return values, so this is adequate but not complete.

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 no descriptions (0% coverage), so the description must clarify the parameter. It does identify the value as a path to an STM32CubeMX .ioc file, which pairs with the self-explanatory parameter name 'ioc_path'. It does not explain path format, existence requirements, or relative vs absolute paths.

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 states a specific action (Parses), a specific resource (STM32CubeMX .ioc file), and enumerates the returned data categories. This clearly distinguishes it from sibling tools like stm32_get_target_info or stm32_update_ioc based on input type and output.

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 intended context (need parsed .ioc configuration data) is implied by the description, but it never explicitly states when to use this tool versus alternatives such as stm32_get_target_info or stm32_update_ioc. No exclusions or recommended alternatives are given.

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