Skip to main content
Glama

List Participants

list_participants
Read-onlyIdempotent

List BYOP invitation records with each personal interview link, status and visible interview count. These are study participations, not deduplicated people; use list_interviews(participant_id) for the sessions. Panel and open-link respondents are anonymous interviews.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNo
emailNo
study_idNo
page_sizeNo
external_idNoExact customer ID; requires study_id.
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
resultYesPaginated BYOP participants.

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. Changed26 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 / page / maximum
      Added value: +9007199254740991
    • 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"
    • changedOutput schema / properties / result / additionalProperties
      Previous value: -trueNew value: +{}
    • changedOutput schema / properties / result / properties / page / anyOf
      Previous value: -[
      -  {
      -    "type": "integer"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "maximum": 9007199254740991,
      +    "minimum": -9007199254740991,
      +    "type": "integer"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedOutput schema / properties / result / properties / page_size / anyOf
      Previous value: -[
      -  {
      -    "type": "integer"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "maximum": 9007199254740991,
      +    "minimum": -9007199254740991,
      +    "type": "integer"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedOutput schema / properties / result / properties / participants / items / additionalProperties
      Previous value: -trueNew value: +{}
    • removedOutput schema / properties / result / properties / participants / items / properties / email / $ref
      Removed value: -"#/properties/result/properties/participants/items/properties/study_id"
    • addedOutput schema / properties / result / properties / participants / items / properties / email / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / result / properties / participants / items / properties / external_id / $ref
      Removed value: -"#/properties/result/properties/participants/items/properties/study_id"
    • addedOutput schema / properties / result / properties / participants / items / properties / external_id / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • addedOutput schema / properties / result / properties / participants / items / properties / interview_count / maximum
      Added value: +9007199254740991
    • addedOutput schema / properties / result / properties / participants / items / properties / interview_count / minimum
      Added value: +-9007199254740991
    • removedOutput schema / properties / result / properties / participants / items / properties / interview_link / $ref
      Removed value: -"#/properties/result/properties/participants/items/properties/study_id"
    • addedOutput schema / properties / result / properties / participants / items / properties / interview_link / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / result / properties / participants / items / properties / invite_created_at / $ref
      Removed value: -"#/properties/result/properties/participants/items/properties/reward_sent_at"
    • addedOutput schema / properties / result / properties / participants / items / properties / invite_created_at / description
      Added value: +"ISO 8601 timestamp."
    • addedOutput schema / properties / result / properties / participants / items / properties / invite_created_at / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / result / properties / participants / items / properties / invite_sent_at / $ref
      Removed value: -"#/properties/result/properties/participants/items/properties/reward_sent_at"
    • addedOutput schema / properties / result / properties / participants / items / properties / invite_sent_at / description
      Added value: +"ISO 8601 timestamp."
    • addedOutput schema / properties / result / properties / participants / items / properties / invite_sent_at / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • addedOutput schema / properties / result / properties / participants / items / properties / metadata / propertyNames
      Added value: +{
      +  "type": "string"
      +}
    • addedOutput schema / properties / result / properties / total_count / maximum
      Added value: +9007199254740991
    • addedOutput schema / properties / result / properties / total_count / minimum
      Added value: +-9007199254740991
  3. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is covered. The description adds genuine behavioral context beyond that: what each row represents, that panel/open-link respondents are anonymous, and that rows are participations rather than people. It omits pagination/result-shape behavior, but the output schema carries that.

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 tight sentences, front-loaded with the core action and grain definition, each carrying distinct information. No restatement of the title or filler.

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

Completeness3/5

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

The output schema and annotations cover return values and safety, and the description handles record semantics well, so an agent knows what it is looking at. However, with 6 parameters and only 33% schema coverage, the definition gives no guidance on how to filter or paginate, leaving a real gap for a list endpoint.

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 33% (email, study_id, page and page_size have no descriptions), so the description must compensate and does not. It never mentions filtering by email or study_id, nor the page/page_size pagination parameters, leaving most inputs undocumented anywhere.

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?

The description names a specific verb and resource ('List BYOP invitation records') and enumerates the returned fields ('personal interview link, status and visible interview count'). It also disambiguates the overloaded term 'participant' against siblings like list_interviews and get_participant, so an agent can tell it apart without opening a schema.

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?

It explicitly routes one case to an alternative: 'use list_interviews(participant_id) for the sessions.' It also clarifies the record grain ('study participations, not deduplicated people'), which prevents misuse. It stops short of stating when to use this tool versus get_participant or the filter conditions (email/study_id), so it is clear context without full when/when-not coverage.

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