cubemx_script

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

With no annotations, the description carries the burden of behavioral disclosure. It states commands are passed verbatim to -q (原样传给 -q), revealing that there is no validation or processing, which is a key behavioral trait. However, it does not discuss error handling, side effects, or output behavior, leaving some transparency gaps.

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, starting with the purpose and then offering a bulleted list of examples. Every line earns its place, with no filler or repetition.

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?

For a tool with a single free-form string parameter and an output schema, the description provides sufficient context through the escape-hatch explanation and examples. It could be more comprehensive by specifying the complete command grammar or error behavior, but it is adequate for invocation.

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. It provides concrete command examples (config load, set mode, project generate) that illustrate the expected format and scope of the 'script' parameter, giving the agent actionable guidance. This is substantial compensation, though not exhaustive.

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 executes arbitrary CubeMX script command sequences and functions as an escape hatch, distinguishing it from the more specific sibling tools like cubemx_load or cubemx_generate. It uses a specific verb (执行/execute) and resource (CubeMX script commands), making its purpose unambiguous.

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 '逃生通道' (escape hatch) signals this tool is meant for cases not covered by the higher-level sibling tools, but it does not explicitly name alternatives or state when not to use it. The implied usage is clear: use when custom or arbitrary commands are needed.

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