Skip to main content
Glama

cubemx1_ioc_check

Validates an STM32CubeMX .ioc by loading and round-trip saving it, then checks that all required keys retain expected values and scans the load log.

Instructions

[development/acceptance only, not a required step for release use] Hand the .ioc to CubeMX: load -> save as -> verify that every key the target requires is present with the same value, and scan the load log. Needs a CubeMX session; writes _roundtrip.ioc into save_dir. Normal project generation does not call it.

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_check"
  }
}

Input Schema

NameRequiredDescriptionDefault
iocYespath of the .ioc to check
save_dirNowhere to save as; defaults to the .ioc directory

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A4.1/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 well: it discloses the prerequisite (active CubeMX session), the side effect (writes <same name>_roundtrip.ioc into save_dir), and the internal steps including log scanning. It omits what happens on a key mismatch (raise, report, partial write) and what the tool returns, which is a meaningful gap for a verification tool with no output schema.

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?

Front-loaded with the scope caveat, then a compact arrow chain for the procedure, then prerequisites and side effects. Every clause earns its place; the arrow shorthand ('load -> save as -> verify') is dense but readable, at the cost of a little polish.

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 two-parameter tool with no annotations and no output schema, the description covers purpose, exclusions, prerequisite environment, and file side effect. The remaining gap is failure/return semantics — an agent cannot tell what a failed verification looks like versus a successful one.

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?

Schema description coverage is 100%, so the baseline is 3. The description adds one useful detail beyond the schema — that save_dir receives a file named '<same name>_roundtrip.ioc' — but says nothing further about accepted path forms or whether ioc must be a full or relative path.

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

Purpose5/5

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

States a specific verb chain and resource: hand the .ioc to CubeMX, load, save-as, verify required keys, and scan the load log. The bracketed 'development/acceptance only' scope plus 'Normal project generation does not call it' separates it from the generation siblings (cubemx1_ioc_generate/build) without needing to open their schemas.

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

Usage Guidelines4/5

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

Gives an explicit when-to-use ('development/acceptance only') and when-not ('not a required step for release use', 'Normal project generation does not call it'), plus a prerequisite ('Needs a CubeMX session'). It falls short of 5 because no alternative sibling is named for the case where a real roundtrip is not wanted.

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