cubemx_export_pinout

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It explicitly mentions that the operation is read-only and that the CSV is written to the system temp directory before being read back, which is a valuable side-effect disclosure. It does not detail error conditions or cleanup of temp files, but the key behavioral trait is transparently communicated.

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 extremely concise, consisting of two short sentences. The primary action is front-loaded, and the parameter explanation is directly attached. Every word serves a purpose, with no filler or redundancy.

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 the tool's simplicity, the description covers the main aspects: input parameter, behavior, and side effects. The presence of an output schema handles return values. However, it omits potential preconditions (e.g., .ioc must exist) and error handling, but for a single-purpose export tool, this is a minor gap, making it largely 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 provides only a string type for the 'ioc' parameter with 0% description coverage. The description compensates by specifying 'absolute path to project .ioc file', adding critical semantic context that clarifies the expected input format and purpose. This extra detail goes beyond the schema and is essential for correct usage.

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 loads a .ioc file and exports the current pin configuration as CSV. The verb 'export' and resource 'pin configuration CSV' are specific, and this distinguishes it from siblings like cubemx_generate (which generates code) or cubemx_configure (which modifies settings).

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 for retrieving pin configurations as CSV, and the read-only note suggests safe invocation. However, it does not explicitly state when to use this tool versus alternatives, nor does it provide exclusions or prerequisites (e.g., requiring an existing .ioc file), leaving the usage context implied rather than explicit.

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