Skip to main content
Glama
growsurf

GrowSurf MCP Server

Official

List Campaign Rewards

growsurf_list_campaign_rewards
Read-onlyIdempotent

List your GrowSurf program's configured Campaign Rewards, including switched-off rewards and rewards whose group is not selected. Deleted rewards are excluded.

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

NameRequiredDescriptionDefault
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
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.23
    • 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"
      +  ]
      +}
  2. Changed2 schema fields changedv0.19.15
    • addedInput schema / properties / campaignId / minLength
      Added value: +1
    • addedInput schema / required
      Added value: +[
      +  "campaignId"
      +]
  3. 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."
  4. 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."
  5. 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"
      +  ]
      +}
  6. First observedv0.12.2

TDQS

A4.3/5.0
Behavior5/5

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

Annotations already establish read-only, idempotent, non-destructive, closed-world behavior, and the description adds meaningful context beyond that: inclusion of inactive/unselected-group rewards, exclusion of deleted rewards, and the relationship to the campaign response's embedded rewards array. It also warns not to confuse configuration with participant earned rewards.

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 description is front-loaded with the core list operation and scope, then adds relevant caveats. It is somewhat verbose and repeats the campaignId fallback already present in the schema, but no sentence is wholly wasted.

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

Completeness4/5

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

For a one-parameter read-only listing tool with annotations and an output schema, the description is largely complete: it covers scope, exclusions, earned-vs-configured distinction, and campaign targeting. The only notable gap is the slight required-vs-optional ambiguity around campaignId.

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%, and the campaignId property description already documents the GROWSURF_CAMPAIGN_ID fallback, so the baseline is 3. The tool description repeats that fallback, but its 'if supplied, otherwise' phrasing sits awkwardly against the schema marking campaignId as required.

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?

States a specific verb and resource: listing configured Campaign Rewards for a GrowSurf program. It clearly scopes the result set by including switched-off and unselected-group rewards while excluding deleted ones, and distinguishes these configured settings from participant-level earned reward records.

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 clear applicability guidance and a useful when-not: these settings do not prove a participant earned or received a reward, since earned records belong to the participant. It does not explicitly name the sibling tool to use for participant earned-reward records, so it stops short of full alternative routing.

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