Skip to main content
Glama

Update Study

update_study
DestructiveIdempotent

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

NameRequiredDescriptionDefault
nameNo
voiceNoInterviewer configuration for every format, including chat. Defaults to male when omitted.
languageNo
study_idYes
study_typeNo
byop_configNo
organization_idNoOrganization for this operation and billing. Use list_organizations to choose an active membership.
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

NameRequiredDescriptionDefault
resultYesThe updated study. Call get_study for full state.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / organization_id / description
      Previous value: -"Platform admins only: select an organization for this operation. Required when changing another organization’s study or using its wallet."New value: +"Organization for this operation and billing. Use list_organizations to choose an active membership."
  2. 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"
      +}
  3. 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"
      +]
  4. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already flag the mutation (readOnlyHint=false, destructiveHint=true, idempotentHint=true), so the description doesn't need to re-declare safety. What it adds beyond the annotations is genuine: PATCH semantics ('Only supplied fields change'), the lifecycle precondition that active panel studies must be paused/stopped, and the read-before-write convention. It does not explain why the tool is marked destructive or how null vs. omitted fields are treated, which is the remaining gap.

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 scope and the sibling exclusion before any preconditions. Every sentence carries a distinct instruction; nothing is redundant with the title or annotations.

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

Completeness4/5

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

For a nine-parameter mutation tool with an output schema and full annotations, the description supplies scope, alternative routing, and two operational preconditions. The main remaining shortfall is the lack of field-level enumeration given only 44% schema coverage, but the essentials for a correct call are present.

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 44%, so the schema only partially documents the nine parameters. The description does useful scoping by saying 'ordinary study metadata only' and excluding a set of field families, which implicitly constrains the updateable set, but it never enumerates the accepted fields (name, voice, language, study_type, byop_config, interview_format, recruiting_method) or clarifies field-level behaviors like clearing a value. It helps but does not compensate for the coverage gap.

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 ('PATCH ordinary study metadata'), and immediately delineates scope against the sibling customize_study, which handles the research plan, targeting, screener, concepts, and images. An agent can tell exactly which of the two update tools to pick without opening either schema.

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?

Gives explicit alternatives ('Use customize_study—not this tool—for...'), prerequisites ('Active panel studies must be paused or stopped first', 'Call get_study first'), and an implicit when-not for every excluded field family. This is a textbook routing instruction with no inference required.

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