stm32_configure_pins

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

With no annotations provided, the description carries the full burden and discloses the two most important behaviors: it mutates a file ('patches') and triggers a regeneration side effect. 'Idempotent' adds material safety context—re-running with the same inputs yields consistent results. It doesn't specify overwrite behavior or prerequisites, but it goes well beyond a bare 'configure pins' statement.

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 short sentences front-load the action ('Patches pin config in an existing .ioc') and place the idempotency note second. There is zero filler—'Patches,' 'existing .ioc,' 'regenerates,' and 'Idempotent' each carry distinct, necessary 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?

The core invocation contract is present—what it patches, where, and that it regenerates—sufficient for a 2-parameter call. However, with no output schema and no annotations, gaps remain: return behavior, whether regeneration implies a build, and conflict/error handling for pin modes are all undisclosed. Adequate for basic invocation, but thin for a mutating tool with side effects.

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 description coverage is 100%, with both projectPath and pins described in the schema, so the baseline is 3. The description confirms projectPath points to an existing .ioc but adds no detail on pin naming conventions, mode values, or label usage for the nested objects, which remain undocumented.

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 uses the specific verb 'patches' with a precise resource ('pin config in an existing .ioc') and discloses the regeneration side effect. This clearly distinguishes it from siblings like stm32_create_project (which would not target an existing .ioc) and stm32_patch_user_code (which targets user code, not pin config).

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 phrase 'existing .ioc' implies this tool is for modifying already-created projects rather than initial setup, pointing away from stm32_create_project and stm32_generate_code. However, it never explicitly states when to prefer this tool over alternatives or what conditions exclude it, leaving routing mostly to inference.

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