Skip to main content
Glama

Start a parameter study

cm_study_start

Runs a test run multiple times with different parameter values in the background and returns a study ID to poll for status. Changes stay in memory; project files are not written.

Instructions

Run one test run several times with different parameter values, one after another, in the background. Returns a study id at once; poll cm_study_status. Nothing is written to project files.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
modeNocm4sl: the MATLAB-connected session. standalone: a separate CarMaker process per run (no 'workspace' values)cm4sl
scopeNo'base' for the MATLAB base workspace, or the name of a loaded Simulink model for that model's workspacebase
testrunYesTest run relative to Data/TestRun
max_run_sNoA run is stopped after this wall time in s
save_logsNoAfter every run, save what Simulink logged and the workspaces as that run used them to a MAT file next to its result file (mode cm4sl; logs_file per row)
quantitiesNoQuantities to summarise per run (default: Time, Car.v)
variationsYesOne entry per run: {'label': 'heavy', 'keys': {'Body.mass': 320}, 'workspace': {'Kp_yaw': 1.5}}. 'keys' are infofile keys applied in memory for that run only (prefix a place such as 'Vehicle:' if needed); 'workspace' are MATLAB variables in 'scope', restored after the run. Both are optional

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false and destructiveHint=false; the description usefully adds that execution is backgrounded, that a study id is returned immediately, and that nothing is written to project files. It does not cover limits such as the maxItems=50 cap or how failures mid-study are surfaced.

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?

Three tight clauses: what it does, the async/polling contract, and the no-write guarantee. Front-loaded with the core action and free of filler, though slightly telegraphic.

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?

An output schema exists, so return details need not be explained; the description still notes the immediate study id and the polling path. Combined with full schema coverage and safety annotations, it is essentially complete, missing only the run-count ceiling.

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 each of the 7 parameters is already documented in the schema with defaults and constraints. The description adds only the notion of sequential variation and no extra syntax or semantic detail, so the baseline 3 applies.

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?

The description states a specific verb and resource: run one test run repeatedly with varied parameter values, sequentially and in the background. That cleanly separates it from single-run siblings such as cm_start_sim, and it names its companion tool cm_study_status explicitly.

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?

It gives clear operating context (background execution, poll cm_study_status for progress) and implies the async workflow. It does not, however, state when to prefer this over alternatives like a single cm_start_sim or how to abort, so exclusions are absent.

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