Skip to main content
Glama
growsurf

GrowSurf MCP Server

Official
by growsurf
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

List Participants

growsurf_list_participants
Read-onlyIdempotent

List participants in a GrowSurf program, newest page first. Filter by exact metadata match and paginate using nextId.

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.

Input Schema

NameRequiredDescriptionDefault
limitNo
nextIdNoParticipant ID returned as `nextId` from the previous page.
metadataNoExact-match filter on participant metadata, up to 3 keys, for example `{ "customerId": "12345" }`. Values compare as strings.
campaignIdYesTarget program (campaign) id for this call. 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. Changed2 schema fields changedv0.19.15
    • addedInput schema / properties / campaignId / minLength
      Added value: +1
    • addedInput schema / required
      Added value: +[
+  "campaignId"
+]
  2. 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."
  3. 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"
+}
  4. 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"
+}
  5. First observedv0.12.2

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare read-only/idempotent safety, and the description adds real behavioral context: newest-page-first ordering, that filtered results are ordered by participant ID, the paging handshake via nextId, and results carrying participant IDs. That is meaningful beyond the safety flags, though it omits rate limits or result-size expectations.

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 with purpose front-loaded and paging guidance immediately after. A couple of clauses (e.g. the campaignId default) restate the schema verbatim, which is mildly redundant but not wasteful.

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?

With an output schema present, return-shape explanation is unnecessary, and the description still flags that results include participant IDs for the paging loop. Defaults, filtering semantics, ordering, and the pagination contract are all covered for a 4-param nested-object tool.

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 75%, so the baseline is 3; the description lifts this by supplying the limit default of 10, which the schema does not state, and by explaining how nextId, metadata filtering, and the campaignId fallback interact. The exact-match/string-comparison nuance for metadata duplicates the schema text rather than extending it.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('List participants in your GrowSurf program') and scopes it with ordering and paging details. It reads distinctly from the singular get_participant sibling by implication, but never names or contrasts any sibling explicitly.

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 usage context: pass the returned nextId to continue paging, and use the metadata filter to look someone up by your own customer ID. It stops short of stating when to prefer this tool over siblings like get_participant or bulk_delete_participants.

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