Skip to main content
Glama
growsurf

GrowSurf MCP Server

Official

Get Program Design

growsurf_get_campaign_design
Read-onlyIdempotent

Retrieve a GrowSurf campaign's design configuration, including colors, sharing sections, avatars, referral popups, login text, and country labels, to review or update the participant experience.

Instructions

Fetch the configured design fields for your GrowSurf program, including GrowSurf Window content, colors, sharing sections, participant avatars under participantAvatarStyle, referred-visitor content such as the Claim Offer Popup, participant sign-in copy under login, payout-destination confirmation page copy under payoutDestinationConfirmation, and country-name overrides under countryLabels. participantAvatarStyle is CHARACTERS, INITIALS, ANIMALS, or GRADIENT; missing or unknown values mean INITIALS. The confirmation section is omitted when no confirmation fields are stored. Stored null fields are returned as null; omitted and null fields use localized defaults. Targets campaignId if you pass it, otherwise GROWSURF_CAMPAIGN_ID.

Input Schema

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

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
loginNoThe returning-participant sign-in form plus its success, resend, validation, and error text.
shareNoShare channels, invite settings, and share-button styling.
statsNoThe participant's referral-progress stats panel. Only `title` is editable.
themeNoVisual theme styling (colors, shadows, and similar).
headerNoHeader content for participants (`postText`) and non-participants (`preText`).
signupNoSignup form fields, GDPR consent, and button and login text.
windowNoLayout of the GrowSurf window (`navigationMode`: `TABS` or `LIST`).
payoutsNoAffiliate programs only. The Payouts section of the participant portal.
rewardsNoHeading, icon, and empty-state text of the rewards panel.
resourcesNoParticipant Resources presentation settings: visibility, title, link and copy labels, the message shown when nothing is published, and the section icon. Resource items use the program Resource tools.
commissionsNoAffiliate programs only. The Commissions section of the participant portal.
leaderboardNoThe leaderboard section: labels, selectors, and name masking.
landingPagesNoPortal and landing pages: company info, `content`, `styles`, third-party script ids, and SEO meta tags.
countryLabelsNoParticipant-facing country-name overrides keyed by ISO 3166-1 alpha-2 code (for example `GB`). Each label replaces the default country name wherever participants pick a country, such as payout and tax forms. Overrides merge per code on `PATCH`; `null` (or the default name) restores a code's default. Only overridden codes are returned.
referralStatusNoThe section listing who a participant invited and each invite's progress.
referralSummaryNoReferral programs only. The participant's row of summary tiles (clicks, leads, referrals, rewards).
affiliateSummaryNoAffiliate programs only. The affiliate's row of summary tiles (clicks, revenue, payouts).
referredExperienceNoThe banner, headline, and Claim Offer Popup shown to a visitor who arrives through a referral link. The popup is available for referral and affiliate programs.
participantSettingsNoThe participant's account settings area (logout, PayPal and Wise payout confirmation/status messages, tax details).
participantAvatarStyleNoHow participant avatars appear in the GrowSurf Window. New programs use `CHARACTERS`; missing or unknown stored values return `INITIALS`.
payoutDestinationConfirmationNoCustomizable text for the payout-destination confirmation page opened from payout integration cards. One shared set applies to every enabled payout provider. Provider-aware text may use `{{payoutProvider}}`; omitted and `null` fields use localized defaults.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv0.14.0
    • addedOutput schema / properties / participantAvatarStyle
      Added value: +{
      +  "description": "How participant avatars appear in the GrowSurf Window. New programs use `CHARACTERS`; missing or unknown stored values return `INITIALS`.",
      +  "enum": [
      +    "CHARACTERS",
      +    "INITIALS",
      +    "ANIMALS",
      +    "GRADIENT"
      +  ],
      +  "type": "string"
      +}
    • changedOutput schema / properties / referredExperience / description
      Previous value: -"The banner and headline shown to a visitor who arrives through a referral link."New value: +"The banner, headline, and Claim Offer Popup shown to a visitor who arrives through a referral link. The popup is available for referral and affiliate programs."
    • addedOutput schema / properties / referredExperience / properties
      Added value: +{
      +  "isOfferPopupConfettiEnabled": {
      +    "description": "Whether to show confetti after a claim.",
      +    "type": "boolean"
      +  },
      +  "isOfferPopupEnabled": {
      +    "description": "Whether referred visitors see the Claim Offer Popup.",
      +    "type": "boolean"
      +  },
      +  "isOfferPopupOverlayDimmed": {
      +    "description": "Whether a centered popup dims the page behind it.",
      +    "type": "boolean"
      +  },
      +  "isOfferPopupReferrerImageShown": {
      +    "description": "Whether to show the referrer's profile image.",
      +    "type": "boolean"
      +  },
      +  "isOfferPopupShownOnAllPages": {
      +    "description": "Whether the popup can appear on every installed page.",
      +    "type": "boolean"
      +  },
      +  "offerPopupButtonText": {
      +    "description": "Offer-save button text.",
      +    "maxLength": 100,
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "offerPopupDelaySeconds": {
      +    "description": "Delay before the popup appears.",
      +    "enum": [
      +      0,
      +      3,
      +      5,
      +      10
      +    ],
      +    "type": "integer"
      +  },
      +  "offerPopupDescription": {
      +    "description": "Text below the popup heading.",
      +    "maxLength": 255,
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "offerPopupImageUrl": {
      +    "description": "Optional popup image.",
      +    "maxLength": 500,
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "offerPopupPlacement": {
      +    "description": "Where the popup appears.",
      +    "enum": [
      +      "CENTER",
      +      "BOTTOM",
      +      "BOTTOM_RIGHT",
      +      "BOTTOM_LEFT",
      +      "TOP"
      +    ],
      +    "type": "string"
      +  },
      +  "offerPopupSecondaryLinkText": {
      +    "description": "Optional post-claim link text.",
      +    "maxLength": 100,
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "offerPopupSecondaryLinkUrl": {
      +    "description": "Optional post-claim link destination. When saving, use `http://` or `https://`. Send `null` or an empty string to clear it.",
      +    "maxLength": 255,
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "offerPopupThankYouButtonText": {
      +    "description": "Post-claim signup button text.",
      +    "maxLength": 100,
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "offerPopupThankYouText": {
      +    "description": "Message shown after the offer is saved.",
      +    "maxLength": 255,
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "offerPopupTitle": {
      +    "description": "Popup heading.",
      +    "maxLength": 255,
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  }
      +}
    • addedOutput schema / properties / resources
      Added value: +{
      +  "description": "Participant Resources presentation settings: visibility, title, link and copy labels, the message shown when nothing is published, and the section icon. Resource items use the program Resource tools.",
      +  "type": "object"
      +}
    • addedOutput schema / properties / theme / properties
      Added value: +{
      +  "referredExperienceOfferPopup": {
      +    "description": "Paid-plan color settings for the Claim Offer Popup.",
      +    "properties": {
      +      "backgroundColor": {
      +        "description": "Popup background color.",
      +        "maxLength": 255,
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "color": {
      +        "description": "Popup text color.",
      +        "maxLength": 255,
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      }
      +    },
      +    "type": "object"
      +  }
      +}
  2. First observedv0.12.2

TDQS

A4.2/5.0
Behavior5/5

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

The annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is clear. The description goes well beyond this by disclosing enum fallback behavior for `participantAvatarStyle`, omission of the confirmation section when no fields are stored, null versus omitted field handling, and localized defaults. These are behavioral traits an agent cannot infer from the annotations alone, making the description highly transparent.

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 longer than average, but every sentence conveys essential behavior: field inventory, enum values and fallback, null semantics, section omission, and campaign targeting. It is front-loaded with the core action and resource, and code identifiers are used precisely to avoid ambiguity. It loses one point only because the null/default behavior could have been compressed without losing clarity.

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?

For a read-only getter with one optional parameter and an output schema present, the description covers everything needed to invoke it correctly: what fields are returned, enum valid values and default, null behavior, omitted-section behavior, localized defaults, and campaign selection. No critical operational detail is missing.

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?

The input schema already provides 100% coverage for the single `campaignId` parameter, including its default and how to obtain it from growsurf_create_campaign. The description restates the targeting default but does not add new parameter semantics beyond the schema. Per the rubric, baseline 3 is appropriate when the schema carries the load.

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 opens with a specific verb and resource: 'Fetch the configured design fields for your GrowSurf program.' It enumerates the exact field groups returned (GrowSurf Window content, colors, sharing sections, avatar styles, Claim Offer Popup, login copy, payout confirmation copy, country labels), which unambiguously distinguishes it from sibling tools like growsurf_get_campaign or growsurf_get_campaign_emails. The inclusion of specific code paths such as `participantAvatarStyle` and `countryLabels` removes any ambiguity about scope.

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?

The primary use case is implied by the purpose: call this when you need the read-only design configuration of a GrowSurf program. The description does clarify the campaign targeting behavior ('Targets `campaignId` if you pass it, otherwise GROWSURF_CAMPAIGN_ID'), which is useful operational guidance. However, it does not explicitly state when to prefer this over alternatives or when not to use it, leaving the agent to infer routing from the tool name and sibling list.

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