Skip to main content
Glama
growsurf

GrowSurf MCP Server

Official
by growsurf
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

List Campaign Rewards

growsurf_list_campaign_rewards
Read-onlyIdempotent

List a GrowSurf campaign's configured rewards, including switched-off or unselected-group rewards, while excluding deleted ones. Use it to inspect reward setup before checking participant earnings.

Instructions

List your GrowSurf program's configured Campaign Rewards, including switched-off rewards and rewards whose group 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. 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.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
campaignIdNoTarget 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

TableJSON Schema
NameRequiredDescriptionDefault
rewardsNoThe program's configured Campaign Rewards, including switched-off rewards. Deleted rewards are excluded.
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.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."
  2. Changed1 schema field changedv0.19.1
    • 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."
  3. Changed2 schema fields 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"
+}
    • 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"
+  ]
+}
  4. First observedv0.12.2

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so the safety profile is covered. The description adds real value beyond them: it discloses inclusion rules (switched-off rewards and unselected-group rewards appear; deleted ones do not) and warns that these settings do not imply a participant earned a reward, which prevents a common misinterpretation.

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?

The scoping and the inclusion/exclusion rules are front-loaded, and the earned-reward caveat follows immediately. It is a fairly dense multi-sentence block, but each sentence carries distinct information rather than padding.

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-value detail is unnecessary, and the description fully covers scope, include/exclude semantics, the earned-vs-configured distinction, and targeting behavior. An agent has everything needed to call this correctly.

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 100%, so the single campaignId parameter and its GROWSURF_CAMPAIGN_ID fallback are already documented in the schema. The description restates that targeting behavior without adding syntax, format, or edge-case detail, so the baseline 3 holds.

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 gives a specific verb (List) and resource (configured Campaign Rewards), then precisely bounds scope: includes switched-off and non-group-selected rewards, excludes deleted rewards. It also disambiguates from a confusingly similar concept (earned reward records on participants), so an agent can distinguish it from siblings like get_participant or the reward CRUD tools.

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 clearly establishes when this tool is the right source (configuration-level reward definitions) and when it is not (earned/received reward records, which belong to the participant). However, it does not explicitly name alternate tools (e.g., growsurf_get_campaign or growsurf_get_participant) that an agent should reach for instead, leaving that routing to inference.

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