stm32_build_project

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

With no annotations, the description carries the full behavioral burden. It discloses the headless-build mechanism, clean-build behavior via clean_first, and indexer-disabling via no_indexer. However, it does not mention side effects on the workspace, failure modes, output artifacts, or whether an IDE/installation is required.

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 compact and front-loaded with the core purpose, followed by a clean Args list. Every line adds information and there is no filler or repetition of the schema.

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 parameters and the core behavior, and an output schema exists to document return values. It lacks context about prerequisites (e.g., workspace must exist, STM32CubeIDE installed) and expected build duration/failure behavior, but the essentials for invoking the tool correctly are present.

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 0%, so the description must compensate, and it does. Every parameter is explained with meaningful semantics: workspace_path is the Eclipse workspace folder, project_name can be None for all projects, configuration is Debug/Release, clean_first maps to -cleanBuild, and no_indexer disables the indexer for speed.

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 verb ('Executes') and resource ('a project in an STM32CubeIDE workspace') and clearly identifies the build action via headless-build. This distinguishes it from siblings like stm32_clean_project or stm32_get_build_artifacts.

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?

There is no explicit guidance on when to use this tool versus alternatives, nor any exclusions or prerequisites. The intended use is implied by the verb 'build,' but the description never says 'use this when you need to compile a project' or mentions cleaner/artifact-related alternatives.

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