resume_studyResume a paused study and continue its preserved panel recruitment.
| Name | Required | Description | Default |
|---|---|---|---|
| study_id | Yes | ||
| organization_id | No | Platform admins only: select an organization for this operation. Required when changing another organization’s study or using its wallet. |
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes | The resumed study. |
Changes observed during successful MCP inspections.
Input schema / properties / organization_idAdded value: +{
+ "description": "Platform admins only: select an organization for this operation. Required when changing another organization’s study or using its wallet.",
+ "maxLength": 128,
+ "minLength": 1,
+ "type": "string"
+}Input schema / $schemaPrevious value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"Input schema / additionalPropertiesRemoved value: -falseInput schema / properties / study_id / patternAdded value: +"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Output schema / $schemaPrevious value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"Output schema / properties / result / additionalPropertiesPrevious value: -trueNew value: +{}Output schema / properties / result / properties / dashboard_url / $refRemoved value: -"#/properties/result/properties/name"Output schema / properties / result / properties / dashboard_url / typeAdded value: +[
+ "string",
+ "null"
+]Output schema / properties / result / properties / study_link / $refRemoved value: -"#/properties/result/properties/name"Output schema / properties / result / properties / study_link / typeAdded value: +[
+ "string",
+ "null"
+]Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare non-read-only, idempotent, open-world, non-destructive, so safety is covered. The description adds a genuinely non-obvious side effect: resuming also continues the preserved panel recruitment, telling the agent this is more than a status flag flip. It stops short of noting permission requirements or failure modes.
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?
A single sentence with zero filler; the action is front-loaded and the secondary effect follows immediately. Nothing is repeated from the title or schema.
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?
An output schema exists, so return values need no explanation, and annotations cover the safety profile. For a one-required-parameter mutation the description is nearly sufficient, lacking only the failure/precondition behavior when the study is not in a resumable state.
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 coverage is 50%; organization_id is documented in the schema, while study_id has only its type/format. The description adds no parameter meaning, but study_id is self-evident and the description implies which study is affected. Baseline 3 for partial coverage where the undocumented parameter is unambiguous.
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?
States a specific verb (resume) and resource (study) plus the state it transitions from (paused), which distinguishes it from pause_study/stop_study without naming them. It is clear but does not explicitly differentiate itself from the other lifecycle siblings.
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 'a paused study' implies the precondition that the study must currently be paused, which is useful context. However, it never states when not to use it (e.g. stopped or already-running studies), nor names alternatives such as pause_study, stop_study, or launch_panel.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.