GrowSurf MCP Server

Official

by growsurf

Overview Schema Source Related Servers Discussions Admin

TypeScript

Hybrid

List Campaign Rewards

growsurf_list_campaign_rewards

Read-onlyIdempotent

List a GrowSurf campaign's configured rewards, including switched-off and unselected reward types while excluding deleted ones; optionally filter by group to review reward settings.

Instructions

List your GrowSurf program's configured Campaign Rewards, including switched-off rewards and rewards whose reward type is not selected. Deleted rewards are excluded. A reward can be earned only when it also appears in the campaign response's embedded rewards array. The list includes every group's rewards; each reward's groupId names its group (null is Default). These settings do not establish that a participant earned or received a reward; earned reward records belong to the individual participant. Targets campaignId if supplied, 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_campaign_rewards"
  }
}

Input Schema

Name	Required	Description	Default
`groupId`	No	Return only this group's rewards (`grp_…`). To get Default's rewards, omit `groupId` and keep the rewards whose `groupId` is `null`. An ID that is not a group in this program returns `404`.
`campaignId`	Yes	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.

Output Schema

Name	Required	Description	Default
`rewards`	No	The program's configured Campaign Rewards, including switched-off rewards. Deleted rewards are excluded.
`rewardEvidence`	No	What this response establishes about rewards. Combine with other reads; unknown here does not override evidence elsewhere.

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedv0.19.32Nov 12, 2026

addedInput schema / properties / groupId

Added value: +{
+  "description": "Return only this group's rewards (`grp_…`). To get Default's rewards, omit `groupId` and keep the rewards whose `groupId` is `null`. An ID that is not a group in this program returns `404`.",
+  "type": "string"
+}

addedOutput schema / properties / rewards / items / properties / groupId

Added value: +{
+  "description": "The group this reward belongs to (`grp_…`), or `null` for Default. A participant earns only their own group's rewards.",
+  "type": [
+    "string",
+    "null"
+  ]
+}

Changed3 schema fields changedv0.19.27Nov 3, 2026

changedOutput schema / properties / rewards / items / properties / event / description

Previous value: -"The referral event that earns this Campaign Reward. `LEAD` means a referred signup; `CONVERSION` means a qualifying action."New value: +"The referral event that earns this Campaign Reward. `LEAD` means a referred signup; `CONVERSION` means a qualifying action. Present for `SINGLE_SIDED`, `DOUBLE_SIDED`, and `MILESTONE` rewards."

changedOutput schema / properties / rewards / items / properties / event / enum

Previous value: -[
-  "LEAD",
-  "CONVERSION",
-  null
-]New value: +[
+  "LEAD",
+  "CONVERSION"
+]

changedOutput schema / properties / rewards / items / properties / event / type
```
Previous value: -[
-  "string",
-  "null"
-]New value: +"string"
```

Changed1 schema field changedv0.19.23Oct 22, 2026

addedOutput schema / properties / rewards / items / properties / imageIconKey

Added value: +{
+  "description": "The starter icon shown for the reward, or `null` when `imageUrl` is your own image.",
+  "enum": [
+    "GIFT_1",
+    "GIFT_2",
+    "GIFT_3",
+    "GIFT_4",
+    "GIFT_5",
+    "GIFT_6",
+    "GIFT_CARD",
+    "CASH",
+    "COIN",
+    "CARD",
+    "STAR_1",
+    "STAR_2",
+    "STAR_3",
+    "TROPHY",
+    "CROWN",
+    "SEAL",
+    "HEART_1",
+    "HEART_2",
+    "TAG",
+    "DIAMOND",
+    "CONFETTI",
+    "ROCKET",
+    null
+  ],
+  "type": [
+    "string",
+    "null"
+  ]
+}

Changed2 schema fields changedv0.19.15Oct 15, 2026
- addedInput schema / properties / campaignId / minLength
```
Added value: +1
```
- addedInput schema / required
```
Added value: +[
+  "campaignId"
+]
```

Changed1 schema field changedv0.19.9Oct 3, 2026

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."

Changed1 schema field changedv0.19.1Sep 24, 2026

changedOutput schema / properties / rewards / description

Previous value: -"The program's active, visible, and enabled reward configs."New value: +"The program's configured Campaign Rewards, including switched-off rewards. Deleted rewards are excluded."

Changed2 schema fields changedv0.14.0Sep 10, 2026

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"
+}

addedOutput schema / properties / rewards / items / properties / event

Added value: +{
+  "description": "The referral event that earns this Campaign Reward. `LEAD` means a referred signup; `CONVERSION` means a qualifying action.",
+  "enum": [
+    "LEAD",
+    "CONVERSION",
+    null
+  ],
+  "type": [
+    "string",
+    "null"
+  ]
+}

First observedv0.12.2Aug 25, 2026

TDQS

A4.3/5.0

Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, lowering the bar. The description adds real substance beyond them: what is included and excluded, that groupId null means Default, and that these settings do not imply an earned reward. Pagination and response size are unaddressed.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The inclusion/exclusion boundary is front-loaded, which is correct. The remaining half is a dense run of four caveats; each earns its place content-wise, but the paragraph could be tightened and split for scanability.

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 no explanation. For a two-parameter read tool with rich annotations, the description covers inclusion rules, grouping, earning semantics, and ID resolution—everything required to invoke and interpret it.

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 100%, so baseline is 3. The description adds meaningful semantics on campaignId resolution (supplied value, else GROWSURF_CAMPAIGN_ID) and reinforces the groupId/Default interplay, though the latter largely repeats the schema's own text.

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?

Specific verb plus resource with precise scope: it lists configured Campaign Rewards including switched-off and unselected-type rewards, and excludes deleted ones. It draws a sharp line between configuration settings and the embedded `rewards` array / participant earned records, so it is distinguishable from siblings like 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 Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly frames when this tool applies (configuration inspection, all groups' rewards) and when its output should not be read as evidence of earned rewards. It stops short of naming a specific sibling for earned-reward records, but the negative case is stated clearly enough to route the agent.

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

Deploy Server