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

Wait for a parameter study

cm_study_wait
Read-only

Wait until another run of the study has finished or the study has ended, at most timeout_s, and return the compact table (new_rows says how many runs finished meanwhile). Call it again while state is 'running'.

Instructions

Wait until another run of the study has finished or the study has ended, at most timeout_s, and return the compact table (new_rows says how many runs finished meanwhile). Call it again while state is 'running'. Use this for studies instead of cm_wait_end.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
studyNoStudy id (default: the latest)
timeout_sNoLongest time to wait in seconds; keep it below your client's tool time-out and call again if not finished

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.2.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered. The description adds useful behavioral context: it waits at most timeout_s, returns a compact table with new_rows count, and should be re-called while the study is running. It does not mention permissions or rate limits, but for a read-only polling tool that is acceptable.

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

Conciseness5/5

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

Front-loaded with the core wait behavior in one sentence, followed by two concise sentences covering repetition and alternative selection. Every sentence earns its place and no words are wasted.

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

Completeness5/5

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

Given the tool has an output schema, the description need not explain return values in detail. It nevertheless clarifies the polling loop, timeout behavior, and sibling alternative. Nothing essential for correct invocation is missing.

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 both parameters (study, timeout_s) are fully documented in the schema. The description restates timeout_s semantics but adds no meaning beyond what the schema already provides. Baseline 3 is appropriate when the schema does the heavy lifting.

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 (wait), resource (parameter study), scope (until another run finishes or study ends, at most timeout_s), and return value (compact table with new_rows). Explicitly distinguishes itself from the sibling cm_wait_end by naming it.

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

Usage Guidelines5/5

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

Provides explicit looping guidance ('Call it again while state is running') and names the alternative tool to use instead ('Use this for studies instead of cm_wait_end'). An agent knows both when to use this and which sibling it replaces.

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