Skip to main content
Glama
GrowSurf MCP Server

GrowSurf MCP Server

Official

List Participants

growsurf_list_participants
Read-onlyIdempotent

Lists participants in a GrowSurf program, newest page first, with paging via nextId and exact metadata or group filters to find specific people.

Instructions

List participants in your GrowSurf program, newest page first. limit is 1-100 (default 10). Pass response nextId into the next call to continue paging. Pass metadata to return only participants whose stored metadata matches every given key and value exactly, for example { "customerId": "12345" } to look someone up by your own customer ID; filtered results are ordered by participant ID. Results include participant IDs. Targets campaignId if you pass it, otherwise GROWSURF_CAMPAIGN_ID.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "campaignId": "<campaignId>"
    },
    "name": "growsurf_list_participants"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNo
nextIdNoParticipant ID returned as `nextId` from the previous page.
groupIdNoReturn only this group's members (`grp_…`). Works alone or with `metadata`. Default has no ID, so it cannot be named here. An ID that is not a group in this program returns `404`.
metadataNoExact-match filter on participant metadata, up to 3 keys, for example `{ "customerId": "12345" }`. Values compare as strings.
campaignIdYesTarget program id for this call: the `id` returned by `growsurf_list_campaigns`, not the program name or a share URL. Defaults to GROWSURF_CAMPAIGN_ID when omitted. Program IDs also identify newly created programs without restarting the server.

Output Schema

NameRequiredDescriptionDefault
limitNoMaximum number of participants requested for this page.
nextIdNoParticipant id to pass as `nextId` for the next page, or `null` when there are no more results.
participantsNoParticipants returned for this page.
rewardEvidenceNoWhat this response establishes about rewards. Combine with other reads; unknown here does not override evidence elsewhere.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.19.33
    • changedInput schema / properties / campaignId / description
      Previous value: -"Target program (campaign) id for this call. Defaults to GROWSURF_CAMPAIGN_ID when omitted. Program IDs also identify newly created programs without restarting the server."New value: +"Target program id for this call: the `id` returned by `growsurf_list_campaigns`, not the program name or a share URL. Defaults to GROWSURF_CAMPAIGN_ID when omitted. Program IDs also identify newly created programs without restarting the server."
  2. Changed1 schema field changedv0.19.32
    • addedInput schema / properties / groupId
      Added value: +{
      +  "description": "Return only this group's members (`grp_…`). Works alone or with `metadata`. Default has no ID, so it cannot be named here. An ID that is not a group in this program returns `404`.",
      +  "type": "string"
      +}
  3. Changed2 schema fields changedv0.19.15
    • addedInput schema / properties / campaignId / minLength
      Added value: +1
    • addedInput schema / required
      Added value: +[
      +  "campaignId"
      +]
  4. Changed1 schema field changedv0.19.9
    • changedInput schema / properties / campaignId / description
      Previous value: -"Target program (campaign) id for this call. Defaults to GROWSURF_CAMPAIGN_ID when omitted. Pass the `id` returned by growsurf_create_campaign to configure or operate a program you just created, without restarting the server."New value: +"Target program (campaign) id for this call. Defaults to GROWSURF_CAMPAIGN_ID when omitted. Program IDs also identify newly created programs without restarting the server."
  5. Changed1 schema field changedv0.16.0
    • addedInput schema / properties / metadata
      Added value: +{
      +  "additionalProperties": {
      +    "type": "string"
      +  },
      +  "description": "Exact-match filter on participant metadata, up to 3 keys, for example `{ \"customerId\": \"12345\" }`. Values compare as strings.",
      +  "maxProperties": 3,
      +  "minProperties": 1,
      +  "type": "object"
      +}
  6. Changed1 schema field changedv0.14.0
    • addedOutput schema / properties / rewardEvidence
      Added value: +{
      +  "description": "What this response establishes about rewards. Combine with other reads; unknown here does not override evidence elsewhere.",
      +  "properties": {
      +    "approvalPolicy": {
      +      "description": "Referral reward approval policy from requireManualRewardApproval, not affiliate commission approval or an individual reward state.",
      +      "enum": [
      +        "manual",
      +        "automatic",
      +        "unknown"
      +      ],
      +      "type": "string"
      +    },
      +    "automaticFulfillmentMarking": {
      +      "description": "The autoFulfillRewards setting, when returned by an options read. Null means unknown; this controls marking, not delivery.",
      +      "type": [
      +        "boolean",
      +        "null"
      +      ]
      +    },
      +    "basis": {
      +      "enum": [
      +        "this_response_only"
      +      ],
      +      "type": "string"
      +    },
      +    "conclusion": {
      +      "type": "string"
      +    },
      +    "deliveryStatus": {
      +      "enum": [
      +        "unknown"
      +      ],
      +      "type": "string"
      +    },
      +    "integrationConnection": {
      +      "enum": [
      +        "not_established"
      +      ],
      +      "type": "string"
      +    },
      +    "nextStep": {
      +      "type": "string"
      +    },
      +    "programReferralTrigger": {
      +      "enum": [
      +        "not_established"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  7. First observedv0.12.2

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare read-only, idempotent, non-destructive, non-open-world, so safety needs no restating. The description adds real behavioral context beyond them: result ordering (newest first, but ID-ordered when metadata filtering), the paging contract via nextId, and program-targeting fallback to GROWSURF_CAMPAIGN_ID. Minor omission: the groupId 404 behavior lives only in the schema.

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?

A single dense paragraph that is front-loaded with purpose then walks parameters in a logical order; almost every clause carries information. The closing 'Targets campaignId if you pass it, otherwise GROWSURF_CAMPAIGN_ID' partially restates the campaignId schema description, which is a small redundancy rather than filler.

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 a five-parameter paged list tool with an output schema available, the definition covers everything an agent must know to call it correctly: page size bounds and default, continuation token handling, filter semantics, and which program is targeted. Return details are left to the output schema, which is the right division of labor.

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 80%, yet the description still contributes defaults and semantics the schema lacks: limit default of 10, the nextId chaining rule for paging, and the exact-match/string-comparison nature of the metadata filter with a worked example. groupId is left entirely to the schema, which is the one parameter not reinforced here.

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?

Opens with a specific verb and resource ('List participants in your GrowSurf program, newest page first') and fixes the ordering immediately, so an agent can distinguish it from the write-side siblings (add_participant, bulk_delete_participants, bulk_move_participants) without reading any 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?

Gives concrete operating guidance: continue paging by feeding the response's nextId into the next call, and use metadata as an exact-match lookup (with a customerId example) when you want to find one participant. It stops short of explicit when-not-to-use framing or naming a sibling alternative for broad enumeration, but the intended usage is unambiguous.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools