Skip to main content
Glama

Create Participants

create_participants
Destructive

Queue creation of 1–100 unique BYOP participants. Poll get_participant_job until succeeded, then list participants. Before creating participants, call get_study, require provisioning_status=provisioned, and verify or obtain explicit approval of the current plan. Carry a trusted unchanged approval forward using study_id and updated_at; changed plan or invitation settings invalidate it. Invitations send unless silent is true.

Input Schema

NameRequiredDescriptionDefault
study_idYes
participantsYes
idempotency_keyNoReuse the same key and inputs if a prior call timed out. A different operation needs a new key.
organization_idNoOrganization for this operation and billing. Use list_organizations to choose an active membership.

Output Schema

NameRequiredDescriptionDefault
resultYesParticipant creation job.

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. Changed9 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 / participants / items / properties / email / pattern
      Added value: +"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
    • addedInput schema / properties / participants / items / properties / metadata / propertyNames / type
      Added value: +"string"
    • 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"
    • removedOutput schema / properties / result / properties / error / $ref
      Removed value: -"#/properties/result/properties/result_url"
    • addedOutput schema / properties / result / properties / error / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • changedOutput schema / properties / result / properties / total_count / anyOf
      Previous value: -[
      -  {
      -    "type": "integer"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "maximum": 9007199254740991,
      +    "minimum": -9007199254740991,
      +    "type": "integer"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
  4. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations declare destructiveHint=true and openWorldHint=true but say nothing about side effects or preconditions. The description supplies the key behavioral facts: invitations are sent as a side effect unless silent is true, the operation is asynchronous and must be polled, and approval validity is tied to study_id and updated_at and invalidated by changed plan or invitation settings.

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?

Four sentences, front-loaded with the action, then sequencing, then preconditions, then side effects — a sensible order with no filler. The approval-carry-forward sentence is dense and slightly hard to parse, costing a point.

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 an async, destructive, open-world batch mutation, the description covers preconditions, the polling loop, the invitation side effect, and approval invalidation rules; an output schema exists so return values need not be explained. An agent has everything required to call this correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 50%, and the description compensates for part of the gap by explaining the silent flag's effect, the 1–100 uniqueness bound on participants, and the study_id/updated_at linkage used for approval carry-forward. It says nothing about idempotency_key, metadata, or external_id, which are the remaining undocumented fields.

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 with scope: 'Queue creation of 1–100 unique BYOP participants.' The async nature ('queue') and the batch bound distinguish it immediately from create_study, add_all_research_studies, and update_participant.

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 an explicit pre-call gate (call get_study, require provisioning_status=provisioned, obtain/verify plan approval) and an explicit post-call procedure (poll get_participant_job until succeeded, then list participants). It also names the exact conditions under which a carried-forward approval stays valid versus is invalidated.

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