Skip to main content
Glama
carmaker-mcp
by dimitr-io

Parameter study progress and results

cm_study_status
Read-only

Retrieves a CarMaker study's status and per-run results, ranks finished runs by sector, split, simulation time, or quantity, and maps each label to its result file.

Instructions

State of a study (running, done, cancelled, failed) and one row per finished run, which also maps every label to its result file. The ranking names each run's result file. To wait use cm_study_wait.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "cm_study_status"
  }
}

Input Schema

NameRequiredDescriptionDefault
topNoOnly the best N of the ranking
studyNoStudy id (default: the latest)
detailNobrief: per run label, valid, end status, sector or split times, abort reason. compact: also time, distance, result file and min / max / mean / last of the quantities. full: also every run's keys, workspace values and all statisticscompact
labelsNoOnly these rows
rank_byNoRank the valid runs: 'sectors' (mean sector time), 'splits' (their sum), 'sim_time', or a quantity statistic such as 'Car.v.max'; '-' first for largest first
with_studiesNoRank these studies' runs together with this one's

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv0.3.0
    • changedInput schema / properties / detail / description
      Previous value: -"compact: per run its label, end status, time, distance, result file and min / max / mean / last of the quantities. full: also every run's keys and workspace values and all statistics"New value: +"brief: per run label, valid, end status, sector or split times, abort reason. compact: also time, distance, result file and min / max / mean / last of the quantities. full: also every run's keys, workspace values and all statistics"
    • changedInput schema / properties / detail / enum
      Previous value: -[
      -  "compact",
      -  "full"
      -]New value: +[
      +  "brief",
      +  "compact",
      +  "full"
      +]
    • addedInput schema / properties / labels
      Added value: +{
      +  "anyOf": [
      +    {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Only these rows"
      +}
    • addedInput schema / properties / rank_by
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Rank the valid runs: 'sectors' (mean sector time), 'splits' (their sum), 'sim_time', or a quantity statistic such as 'Car.v.max'; '-' first for largest first"
      +}
    • addedInput schema / properties / top
      Added value: +{
      +  "anyOf": [
      +    {
      +      "minimum": 1,
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Only the best N of the ranking"
      +}
    • addedInput schema / properties / with_studies
      Added value: +{
      +  "anyOf": [
      +    {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Rank these studies' runs together with this one's"
      +}
  2. Changed1 schema field changedv0.2.0
    • addedInput schema / properties / detail
      Added value: +{
      +  "default": "compact",
      +  "description": "compact: per run its label, end status, time, distance, result file and min / max / mean / last of the quantities. full: also every run's keys and workspace values and all statistics",
      +  "enum": [
      +    "compact",
      +    "full"
      +  ],
      +  "type": "string"
      +}
  3. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds that the payload is state plus one row per *finished* run (implying running/failed runs are not rowed) and that ranking is included, but says nothing about cost, polling cadence, or behavior for an unknown/default study id.

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?

Purpose is front-loaded in the first clause and the follow-up routing sentence is short. Slight redundancy: 'maps every label to its result file' is restated as 'The ranking names each run's result file,' costing a sentence that could have covered parameters instead.

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?

With an output schema present the return shape needn't be spelled out, annotations cover the safety profile, and all six parameters are fully documented in the schema. Adding an alternative to cm_study_wait closes the main remaining gap, so only minor context is missing (e.g., study default resolution is left to the schema).

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%, including the detail enum's brief/compact/full semantics and the rank_by syntax, so the schema does the heavy lifting and the baseline is 3. The description mentions ranking and label mapping but adds no parameter guidance 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?

States a concrete verb+resource: reports the state of a study (with the possible states spelled out) plus one row per finished run and the label-to-result-file mapping. That is specific enough to distinguish it from cm_study_wait and cm_study_start, though it never explicitly contrasts with the results/listing siblings.

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 routing rule: 'To wait use cm_study_wait,' which is exactly the ambiguity an agent would hit when polling a running study. It stops short of saying when to prefer cm_results_list or cm_results_summary for the finished runs.

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