Skip to main content
Glama

cubemx1_ioc_generate

Generate a CMake project from a compiled .ioc via native CubeMX, then check startup-file references and target numeric parameters; requires a CubeMX session and matching firmware pack.

Instructions

Hand the compiled .ioc to native CubeMX generation of a CMake project and check the artifacts: the startup file exists and is referenced by the project, and the target's numeric parameters appear in the generated code. Successful generation does not mean the project compiles, let alone runs on the board. Needs a CubeMX session and the firmware pack of the matching family.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "ioc": "<ioc>"
    },
    "name": "cubemx1_ioc_generate"
  }
}

Input Schema

NameRequiredDescriptionDefault
iocYespath of a compiled .ioc

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A3.7/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does most of the work: it discloses that the tool writes generated artifacts and then validates two specific conditions (startup file present and referenced, numeric parameters in the generated code). It adds an honest limitation that success does not imply compilation or board execution, plus environmental requirements. What is missing is whether files are written in place, whether existing output is overwritten, and what the response contains.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Four tight sentences, front-loaded with the action and followed by what is verified, then the caveat and prerequisites. Every sentence contributes; only the 'compiles, let alone runs' clause is slightly expansive.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a single-parameter tool with no annotations and no output schema, the description covers action, verification scope, environmental prerequisites, and expected failure modes. The remaining gap is return value and where artifacts land, which is a modest omission given the tool's simplicity.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

There is only one parameter and schema coverage is 100%, so the schema already documents it fully. The description adds only the qualifier 'compiled' to the .ioc path, which hints that the value must come from a prior compile step rather than a raw file, but adds no format or path details beyond that.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description gives a specific verb and resource ("Hand the compiled .ioc to native CubeMX generation of a CMake project") plus the post-generation verification it performs. An agent can distinguish this from cubemx1_ioc_build or cubemx1_ioc_check by the word 'generation', though no sibling is named explicitly.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Prerequisites and context are stated well (needs a CubeMX session and the firmware pack of the matching family; input must be a compiled .ioc), which tells the agent when it can successfully call this. However, there is no explicit when-to-use-vs-alternatives guidance against cubemx1_ioc_build or cubemx1_ioc_check, leaving sequencing to inference.

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