Skip to main content
Glama

Update Participant

update_participant
DestructiveIdempotent

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

NameRequiredDescriptionDefault
emailNo
metadataNo
external_idNo
participant_idYes
organization_idNoOrganization for this operation and billing. Use list_organizations to choose an active membership.

Output Schema

NameRequiredDescriptionDefault
resultYesThe updated BYOP participant.

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. 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"
      +}
  4. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare destructiveHint/idempotentHint, and the description adds real value on top: PATCH is partial ('pass only fields to change') and email=null is a deliberate wipe that should only happen on explicit request. It stops short of explaining what else is lost when fields are cleared or what permissions are required.

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, each doing distinct work: scope, prerequisite, null-handling warning, and partial-update rule. The most important constraint (single participant, minimal payload) is front-loaded.

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?

With an output schema present, return values need no explanation, and the description covers the mutation semantics an agent needs. The only gap is that the 'CRM fields' are never enumerated, leaving the agent to infer metadata/external_id from the schema.

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 20% across 5 parameters, so the description must carry the load, yet it explains only the email null case. 'CRM fields' is never mapped to metadata vs external_id, and the nested metadata object's key/value constraints are left entirely to the schema.

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) and resource (email or CRM fields on one BYOP invitation) plus the HTTP method (PATCH). The singular scope and field set make it clearly distinct from create_participants, delete_participant, and update_study.

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 a concrete prerequisite (call get_participant first to verify identity) and a caution for the null case (only for explicit clearing). It does not name alternative tools that could also modify participants, but the usage context is unambiguous.

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