Skip to main content
Glama
growsurf

GrowSurf MCP Server

Official

Update Campaign Reward

growsurf_update_campaign_reward
DestructiveIdempotent

Update an existing GrowSurf campaign reward's title, value, limits, visibility, tax details, or metadata while keeping its type unchanged.

Instructions

Update an existing campaign reward (reward config) on your GrowSurf program. campaignRewardId is the reward key (e.g. crew_...). The reward type is immutable. Targets campaignId if you pass it, otherwise GROWSURF_CAMPAIGN_ID.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
eventNoThe referral event that earns this Campaign Reward. Use `LEAD` for a referred signup or `CONVERSION` for a qualifying action. A `LEAD` reward requires a later custom conversion trigger. Referral reward types only.
limitNo
orderNo
titleNo
valueNoTax valuation for the reward (the referrer's side of a double-sided reward). `fairMarketValueUSD` is the manual fair-market value in USD (major units). `taxCharacter` is the reason the recipient earns the reward. For configurable non-commission rewards, `null` inherits the program's confirmed treatment. Commission rewards always use `NONEMPLOYEE_SERVICES`.
imageUrlNo
metadataNo
isVisibleNo
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.
couponCodeNo
descriptionNo
isUnlimitedNo
limitDurationNo
referredValueNoTax valuation for the referred friend's side of a double-sided reward. `taxCharacter` is the reason the recipient earns the reward. For configurable non-commission rewards, `null` inherits the program's confirmed treatment. Commission rewards have no referred-friend side, so GrowSurf clears these settings. Use `PURCHASE_REBATE` only when that is the correct tax character.
numberOfWinnersNo
campaignRewardIdYes
referralCouponCodeNo
commissionStructureNoAffiliate commission structure (AFFILIATE rewards only). Provide a positive `amount` (+ optional `amountISO`) for a FIXED commission, or `percent` for a PERCENT commission. CLICK and LEAD commissions must use FIXED.
conversionsRequiredNo
nextMilestonePrefixNo
nextMilestoneSuffixNo
referralDescriptionNo
referredRewardUpfrontNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

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. Changed6 schema fields changedv0.19.8
    • changedInput schema / properties / couponCode / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "null"
      +]
    • changedInput schema / properties / imageUrl / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "null"
      +]
    • changedInput schema / properties / nextMilestonePrefix / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "null"
      +]
    • changedInput schema / properties / nextMilestoneSuffix / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "null"
      +]
    • changedInput schema / properties / referralCouponCode / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "null"
      +]
    • changedInput schema / properties / referralDescription / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "null"
      +]
  3. Changed5 schema fields changedv0.14.0
    • addedInput schema / properties / commissionStructure / allOf
      Added value: +[
      +  {
      +    "if": {
      +      "properties": {
      +        "event": {
      +          "enum": [
      +            "CLICK",
      +            "LEAD"
      +          ]
      +        }
      +      },
      +      "required": [
      +        "event"
      +      ]
      +    },
      +    "then": {
      +      "properties": {
      +        "amount": {
      +          "minimum": 1,
      +          "type": "integer"
      +        },
      +        "type": {
      +          "enum": [
      +            "FIXED"
      +          ]
      +        }
      +      },
      +      "required": [
      +        "amount"
      +      ]
      +    }
      +  }
      +]
    • changedInput schema / properties / commissionStructure / description
      Previous value: -"Affiliate commission structure (AFFILIATE rewards only). Provide `amount` (+ optional `amountISO`) for a FIXED commission, or `percent` for a PERCENT commission."New value: +"Affiliate commission structure (AFFILIATE rewards only). Provide a positive `amount` (+ optional `amountISO`) for a FIXED commission, or `percent` for a PERCENT commission. CLICK and LEAD commissions must use FIXED."
    • addedInput schema / properties / commissionStructure / properties / amount / minimum
      Added value: +1
    • addedInput schema / properties / commissionStructure / properties / event / description
      Added value: +"The affiliate event that earns the commission. `CLICK` and `LEAD` must use `FIXED`."
    • addedInput schema / properties / event
      Added value: +{
      +  "description": "The referral event that earns this Campaign Reward. Use `LEAD` for a referred signup or `CONVERSION` for a qualifying action. A `LEAD` reward requires a later custom conversion trigger. Referral reward types only.",
      +  "enum": [
      +    "LEAD",
      +    "CONVERSION"
      +  ],
      +  "type": "string"
      +}
  4. First observedv0.12.2

TDQS

B3.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=true, idempotentHint=true, and openWorldHint=true, so the safety profile is covered. The description adds two genuinely useful facts (reward type is immutable; target resolution defaults), but for a 23-param destructive mutation it never states partial-update vs. replace semantics or what happens to omitted fields.

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?

Three short sentences, front-loaded with the operation, then the key param, then targeting behavior. No filler, though it is arguably too terse for the surface area it covers.

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

Completeness2/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 not be described, but a destructive 23-parameter mutation with 22% schema coverage and no partial-update semantics, prerequisites, or field-level guidance leaves the agent under-informed about how to call it safely.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is only 22% across 23 parameters, so the description must compensate and largely does not. It explains campaignRewardId (the reward key) and campaignId, but says nothing about the many undocumented fields (limit, order, title, isVisible, numberOfWinners, etc.) or the distinction between value/referredValue sides.

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+resource ('Update an existing campaign reward (reward config)') that clearly separates it from the create/list/delete reward siblings. It does not name an alternative, but the verb alone makes the intent unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

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

It clarifies how the target program is resolved (campaignId else GROWSURF_CAMPAIGN_ID) and that type is immutable, which is useful context. However there is no explicit when-to-use guidance, no prerequisite/permission notes, and no differentiation from growsurf_create_campaign_reward beyond the verb.

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