Skip to main content
Glama

Update Study

update_study
Idempotent

PATCH ordinary study metadata only. Use customize_study—not this tool—for the research plan, audience targeting, screener questions, concept links, or concept images. Only supplied fields change. Active panel studies must be paused or stopped first. Call get_study first.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNo
voiceNoInterviewer configuration for every format, including chat. Defaults to male when omitted.
languageNo
study_idYes
study_typeNo
byop_configNo
organization_idNoPlatform admins only: select an organization for this operation. Required when changing another organization’s study or using its wallet.
interview_formatNoInterview mode. Defaults to voice when omitted.
recruiting_methodNoRequired explicit human choice. Ask the user to choose panel, BYOP, or synthetic respondents before calling create_study; do not guess or silently default it.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYesThe updated study. Call get_study for full state.

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. Changed13 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
    • removedInput schema / properties / language / default
      Removed value: -"en"
    • removedInput schema / properties / language / description
      Removed value: -"Interview language code from userintuition://catalog/languages. Defaults to English (`en`)."
    • 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)$"
    • removedInput schema / properties / study_type / default
      Removed value: -"in-depth-interview"
    • removedInput schema / properties / study_type / description
      Removed value: -"Use concept-test for a participant-facing concept image and prototype-test for a clickable prototype, staging site, live page, or web flow. Prototype tests require video or voice, never chat."
    • 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

A4.2/5.0
Behavior4/5

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

Annotations already declare write, idempotent, non-destructive, and open-world traits. The description adds important behavioral context beyond those annotations: partial-update semantics ('Only supplied fields change'), a state precondition requiring active panel studies to be paused/stopped, and a recommended read-before-write workflow. It does not cover auth or rate limits, but the added constraints are substantive.

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?

Four short sentences, front-loaded with the core action and scope. Each sentence earns its place by adding routing, update semantics, or a precondition. No filler or repetition.

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?

Output schema exists, so return values need not be explained, and annotations cover the safety profile. However, for a mutation tool with nine parameters and only 44% schema coverage, the description leaves an agent without guidance on many fields. It handles routing and preconditions well but is incomplete on parameter-level detail.

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?

Schema description coverage is only 44%, so the description must compensate but largely does not. It clarifies that only ordinary metadata is in scope and excludes several fields, but it adds no meaning about the individual parameters such as name, language, study_type, or byop_config. 'Only supplied fields change' is useful PATCH semantics but does not document what the parameters accept.

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?

The first sentence states a specific action and scope: 'PATCH ordinary study metadata only.' It immediately distinguishes this tool from customize_study, naming the exact fields handled elsewhere, so an agent can differentiate it from siblings without inspecting schemas.

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?

The description explicitly names the alternative (customize_study), states when not to use this tool, and gives two clear preconditions: active panel studies must be paused or stopped first, and get_study should be called first. This goes beyond implied usage to explicit routing and prerequisites.

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