Skip to main content
Glama

Get Study

get_study
Read-onlyIdempotent

Get the full persisted study, including the plan, audience targeting, screeners, and concept assets managed by customize_study. Call before metadata updates and after customization to verify the result. After customization, return the complete persisted study_plan to the user in a readable form and obtain explicit approval of the current plan before paid Panel launch or BYOP participant creation. Retain study_id and updated_at with that approval; if both still match on resume, do not ask for the same approval again. When provisioning_status is provisioned, include both returned links in the completion response. dashboard_url is the researcher management link. study_link is the live participant interview link, not a test or preview link; opening it starts the participant experience. The public API does not expose a separate researcher-preview URL.

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 full persisted 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. Changed39 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: +{}
    • changedOutput schema / properties / result / properties / byop_config / additionalProperties
      Previous value: -trueNew value: +{}
    • removedOutput schema / properties / result / properties / byop_config / properties / auto_send_incentives / $ref
      Removed value: -"#/properties/result/properties/byop_config/properties/is_incentives_enabled"
    • addedOutput schema / properties / result / properties / byop_config / properties / auto_send_incentives / type
      Added value: +[
      +  "boolean",
      +  "null"
      +]
    • changedOutput schema / properties / result / properties / concept_images / items / additionalProperties
      Previous value: -trueNew value: +{}
    • changedOutput schema / properties / result / properties / concept_links / items / additionalProperties
      Previous value: -trueNew value: +{}
    • removedOutput schema / properties / result / properties / concept_links / items / properties / embeddable / $ref
      Removed value: -"#/properties/result/properties/byop_config/properties/is_incentives_enabled"
    • addedOutput schema / properties / result / properties / concept_links / items / properties / embeddable / type
      Added value: +[
      +  "boolean",
      +  "null"
      +]
    • 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"
      +]
    • addedOutput schema / properties / result / properties / expected_duration_seconds / maximum
      Added value: +9007199254740991
    • addedOutput schema / properties / result / properties / expected_duration_seconds / minimum
      Added value: +-9007199254740991
    • changedOutput schema / properties / result / properties / interview_attempt_count / anyOf
      Previous value: -[
      -  {
      -    "type": "integer"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "maximum": 9007199254740991,
      +    "minimum": -9007199254740991,
      +    "type": "integer"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedOutput schema / properties / result / properties / interview_count / anyOf
      Previous value: -[
      -  {
      -    "type": "integer"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "maximum": 9007199254740991,
      +    "minimum": -9007199254740991,
      +    "type": "integer"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedOutput schema / properties / result / properties / invitation_count / anyOf
      Previous value: -[
      -  {
      -    "type": "integer"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "maximum": 9007199254740991,
      +    "minimum": -9007199254740991,
      +    "type": "integer"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • removedOutput schema / properties / result / properties / language / $ref
      Removed value: -"#/properties/result/properties/name"
    • addedOutput schema / properties / result / properties / language / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • changedOutput schema / properties / result / properties / quality_interview_count / anyOf
      Previous value: -[
      -  {
      -    "type": "integer"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "maximum": 9007199254740991,
      +    "minimum": -9007199254740991,
      +    "type": "integer"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • removedOutput schema / properties / result / properties / recruiting_method / $ref
      Removed value: -"#/properties/result/properties/name"
    • addedOutput schema / properties / result / properties / recruiting_method / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • changedOutput schema / properties / result / properties / resolved_targeting / items / additionalProperties
      Previous value: -trueNew value: +{}
    • removedOutput schema / properties / result / properties / resolved_targeting / items / properties / approximation_note / $ref
      Removed value: -"#/properties/result/properties/name"
    • addedOutput schema / properties / result / properties / resolved_targeting / items / properties / approximation_note / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • addedOutput schema / properties / result / properties / resolved_targeting / items / properties / qualification_id / maximum
      Added value: +9007199254740991
    • addedOutput schema / properties / result / properties / resolved_targeting / items / properties / qualification_id / minimum
      Added value: +-9007199254740991
    • changedOutput schema / properties / result / properties / screener_questions / anyOf
      Previous value: -[
      -  {
      -    "items": {
      -      "additionalProperties": {},
      -      "type": "object"
      -    },
      -    "type": "array"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "items": {
      +      "additionalProperties": {},
      +      "propertyNames": {
      +        "type": "string"
      +      },
      +      "type": "object"
      +    },
      +    "type": "array"
      +  },
      +  {
      +    "type": "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"
      +]
    • changedOutput schema / properties / result / properties / study_plan / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "background": {
      -        "$ref": "#/properties/result/properties/name"
      -      },
      -      "conversation_flow": {
      -        "$ref": "#/properties/result/properties/name"
      -      },
      -      "learning_goals": {
      -        "$ref": "#/properties/result/properties/name"
      -      },
      -      "learning_goals_structured": {
      -        "anyOf": [
      -          {
      -            "items": {
      -              "additionalProperties": false,
      -              "properties": {
      -                "evidence_needed": {
      -                  "$ref": "#/properties/result/properties/name"
      -                },
      -                "id": {
      -                  "type": "string"
      -                },
      -                "question": {
      -                  "type": "string"
      -                }
      -              },
      -              "required": [
      -                "id",
      -                "question"
      -              ],
      -              "type": "object"
      -            },
      -            "type": "array"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "objectives": {
      -        "$ref": "#/properties/result/properties/name"
      -      },
      -      "study_improvements": {
      -        "$ref": "#/properties/result/properties/name"
      -      },
      -      "study_specific_rules": {
      -        "$ref": "#/properties/result/properties/name"
      -      }
      -    },
      -    "type": "object"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "background": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "conversation_flow": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "learning_goals": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "learning_goals_structured": {
      +        "anyOf": [
      +          {
      +            "items": {
      +              "additionalProperties": false,
      +              "properties": {
      +                "evidence_needed": {
      +                  "type": [
      +                    "string",
      +                    "null"
      +                  ]
      +                },
      +                "id": {
      +                  "type": "string"
      +                },
      +                "question": {
      +                  "type": "string"
      +                }
      +              },
      +              "required": [
      +                "id",
      +                "question"
      +              ],
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "objectives": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "study_improvements": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "study_specific_rules": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      }
      +    },
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedOutput schema / properties / result / properties / targeting_attributes / anyOf
      Previous value: -[
      -  {
      -    "items": {
      -      "additionalProperties": {},
      -      "type": "object"
      -    },
      -    "type": "array"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "items": {
      +      "additionalProperties": {},
      +      "propertyNames": {
      +        "type": "string"
      +      },
      +      "type": "object"
      +    },
      +    "type": "array"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • removedOutput schema / properties / result / properties / updated_at / $ref
      Removed value: -"#/properties/result/properties/created_at"
    • addedOutput schema / properties / result / properties / updated_at / description
      Added value: +"ISO 8601 timestamp."
    • addedOutput schema / properties / result / properties / updated_at / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / result / properties / use_case / $ref
      Removed value: -"#/properties/result/properties/name"
    • addedOutput schema / properties / result / properties / use_case / type
      Added value: +[
      +  "string",
      +  "null"
      +]
  3. First observed

TDQS

A4.4/5.0
Behavior5/5

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

Annotations cover only the read/idempotency profile, while the description adds substantial behavioral context: what the payload contains, the approval workflow keyed on study_id + updated_at, the semantics of dashboard_url vs study_link, and that study_link starts the live participant experience and no researcher-preview URL exists.

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?

Front-loads the purpose before pivoting to workflow and link semantics, and every sentence carries operational weight. It is dense and long, but not padded with redundant restatement of the tool name.

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?

For a read tool with an output schema and full annotation coverage, the description supplies the workflow and return-value semantics an agent needs to act on the result (approval handling, link usage). Nothing material 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 coverage is 50% and organization_id is already documented in the schema as admin-only. The description references retaining study_id but adds no format, scope, or usage detail beyond what the schema provides, so the baseline of 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?

States a specific verb and resource ('Get the full persisted study') and enumerates the content returned (plan, audience targeting, screeners, concept assets). The mention that these are 'managed by customize_study' cleanly distinguishes it from that sibling mutation tool.

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 explicit triggers: call before metadata updates and after customization, and obtain approval before paid Panel launch or BYOP participant creation. It does not name read-side alternatives (e.g. list_studies or get_study_report), so it stops short of full alternative routing.

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