Skip to main content
Glama

Update Participant

update_participant
Idempotent

Change the email or CRM fields on one BYOP invitation with PATCH. Call get_participant first to verify the intended participant. Send email=null only when the user explicitly wants to clear it. Pass only fields to change.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
emailNo
metadataNo
external_idNo
participant_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 updated BYOP participant.

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. Changed22 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
    • changedInput schema / properties / email / anyOf
      Previous value: -[
      -  {
      -    "format": "email",
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "format": "email",
      +    "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
      +    "type": "string"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • addedInput schema / properties / metadata / propertyNames / type
      Added value: +"string"
    • addedInput schema / properties / participant_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 / email / $ref
      Removed value: -"#/properties/result/properties/study_id"
    • addedOutput schema / properties / result / properties / email / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / result / properties / external_id / $ref
      Removed value: -"#/properties/result/properties/study_id"
    • addedOutput schema / properties / result / properties / external_id / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • addedOutput schema / properties / result / properties / interview_count / maximum
      Added value: +9007199254740991
    • addedOutput schema / properties / result / properties / interview_count / minimum
      Added value: +-9007199254740991
    • removedOutput schema / properties / result / properties / interview_link / $ref
      Removed value: -"#/properties/result/properties/study_id"
    • addedOutput schema / properties / result / properties / interview_link / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / result / properties / invite_created_at / $ref
      Removed value: -"#/properties/result/properties/reward_sent_at"
    • addedOutput schema / properties / result / properties / invite_created_at / description
      Added value: +"ISO 8601 timestamp."
    • addedOutput schema / properties / result / properties / invite_created_at / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / result / properties / invite_sent_at / $ref
      Removed value: -"#/properties/result/properties/reward_sent_at"
    • addedOutput schema / properties / result / properties / invite_sent_at / description
      Added value: +"ISO 8601 timestamp."
    • addedOutput schema / properties / result / properties / invite_sent_at / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • addedOutput schema / properties / result / properties / metadata / propertyNames
      Added value: +{
      +  "type": "string"
      +}
  3. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare idempotentHint=true and destructiveHint=false, so the write/safety profile is covered. The description adds genuinely new behavior: partial PATCH semantics, the null-clears-field rule for email, and a read-before-write verification step. It stops short of describing permission requirements or what happens to unspecified fields in metadata.

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?

Three short sentences, front-loaded with the action and scope, then the prerequisite, then the two edge-case rules. No filler or restated name/title content.

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?

Output schema exists, so return values correctly need no description. Combined with annotations, the description covers the mutation semantics, verification prerequisite, and clearing behavior. The remaining gap is the shape/merge behavior of the nested metadata object and external_id, which are neither in the schema nor the description.

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 only 20% (only organization_id is documented in-schema). The description clarifies email semantics (null clears) and the partial-update rule, but says nothing about how metadata is merged or replaced, or about external_id's role, leaving three parameters thinly explained in both places.

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 (change), a specific resource (one BYOP invitation / participant), and names the exact fields touched (email, CRM fields) plus the HTTP verb PATCH. An agent can distinguish it from delete_participant and get_participant without opening the 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 prerequisites ('Call get_participant first to verify the intended participant'), an explicit guard on a risky case ('Send email=null only when the user explicitly wants to clear it'), and a general invocation rule ('Pass only fields to change'). This is prescriptive when-to-use guidance rather than vague context.

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