Skip to main content
Glama

Pause Study

pause_study
Idempotent

Pause a study while preserving its panel survey, target cycle, progress, and reward hold.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
study_idYes
organization_idNoPlatform admins only: select an organization for this operation. Required when changing another organization’s study or using its wallet.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYesThe paused study.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / organization_id
      Added 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"
      +}
  2. Changed9 schema fields changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / study_id / pattern
      Added 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)$"
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • changedOutput schema / properties / result / additionalProperties
      Previous value: -trueNew value: +{}
    • removedOutput schema / properties / result / properties / dashboard_url / $ref
      Removed value: -"#/properties/result/properties/name"
    • addedOutput schema / properties / result / properties / dashboard_url / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / result / properties / study_link / $ref
      Removed value: -"#/properties/result/properties/name"
    • addedOutput schema / properties / result / properties / study_link / type
      Added value: +[
      +  "string",
      +  "null"
      +]
  3. First observed

TDQS

B3.3/5.0
Behavior4/5

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

Annotations declare idempotentHint=true and destructiveHint=false, so the safety profile is clear. The description adds valuable behavioral context by specifying what state is preserved (panel survey, target cycle, progress, reward hold), which goes beyond annotations.

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?

The description is a single, front-loaded sentence that efficiently communicates the core action and its preserved state. Every word earns its place.

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

Completeness3/5

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

With annotations covering safety and an output schema present, the description need not explain returns. However, it omits usage guidance relative to sibling lifecycle tools, leaving a gap for an agent deciding between pause, stop, and delete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

One parameter (organization_id) has a schema description, but study_id lacks one. The description does not explain either parameter, leaving study_id's purpose solely to its name. It fails to compensate for the coverage gap.

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?

The description states a specific action (pause) and resource (study) and adds what is preserved. However, it does not differentiate from sibling lifecycle tools like stop_study or delete_study, leaving the agent to infer the distinction.

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

Usage Guidelines2/5

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

The description offers no usage context, such as when to pause versus stop or delete, nor does it mention the complementary resume_study tool. The agent must infer appropriate use from the verb alone.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources