Skip to main content
Glama

Create Participants

create_participants

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

TableJSON 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_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
resultYesParticipant creation job.

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

TDQS

A4.6/5.0
Behavior5/5

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

Annotations only declare the safety profile (readOnlyHint=false, idempotentHint=false, destructiveHint=false, openWorldHint=true); the description adds genuinely new behavior: creation is queued asynchronously and must be polled, invitations are sent unless silent=true, and approval validity is carried via study_id/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?

Front-loads the action and its bound, then the workflow, then the approval and invitation rules. Every sentence carries information, though the approval-invalidation clause is densely packed into a single run-on sentence.

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?

An output schema exists, so return values need not be described; instead the description supplies the operational context an agent actually needs — async job polling, hard prerequisites, approval reuse/invalidation rules, and invitation side effects — which is complete for a mutating batch-create tool.

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 50%, and the description reinforces the batch bound ('1–100 unique') and the effect of silent. However, it says nothing about idempotency_key or organization_id, both of which are documented only in the schema, so it does not fully compensate for the coverage gap. Baseline 3 fits.

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 framing ('Queue') and the 1–100 bound distinguish it immediately from sibling reads like get_participant and list_participants.

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-flight sequence (call get_study, require provisioning_status=provisioned, verify or obtain explicit approval of the current plan) and an explicit post-flight sequence (poll get_participant_job until succeeded, then list participants). Named siblings and the conditions that select them leave nothing to inference.

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