Skip to main content
Glama
GrowSurf MCP Server

GrowSurf MCP Server

Official

Get Program Options

growsurf_get_campaign_options
Read-onlyIdempotent

Retrieve a GrowSurf program's Options tab configuration—referral triggers, anti-fraud lists, affiliate settings, notifications, languages, and behavior options—to inspect current values before updating.

Instructions

Fetch the Options tab configuration for your GrowSurf program (referral triggers, anti-fraud lists and toggles, affiliate enrollment and application review, notifications, the program's languages under languages, and other behavior options). languages.baseLanguageTranslation is read-only: it counts Program Editor text that is not in a non-English base language yet, which the customer can translate from Options > Languages in the dashboard. Returns the full object with every field and its current value, the same shape you send back on update. autoFulfillRewards: false permits manual fulfillment and does not prove that any reward went undelivered. Targets campaignId if you pass it, 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_get_campaign_options"
  }
}

Input Schema

NameRequiredDescriptionDefault
campaignIdYesTarget program id for this call: the `id` returned by `growsurf_list_campaigns`, not the program name or a share URL. Defaults to GROWSURF_CAMPAIGN_ID when omitted. Program IDs also identify newly created programs without restarting the server.

Output Schema

NameRequiredDescriptionDefault
fraudNoAnti-fraud settings: `blockedEmails`/`blockedIps`/`blockedCountries` and matching allow lists, `blockBurnerEmails`, `blockDataCenterIps`, `blockHighRiskReferrers`, `autoBlockHighRiskIps`, per-IP signup rate limits, and `recaptcha`.
languagesNoThe languages the program runs in. Participants see the portal and program emails in their language. Translations are managed in the dashboard.
autoBlockFraudNoAutomatically block signups flagged as high fraud risk.
rewardEvidenceNoWhat this response establishes about rewards. Combine with other reads; unknown here does not override evidence elsewhere.
payoutThresholdNoAffiliate programs only. Minimum payout in minor currency units (e.g. cents). `0` or `null` means no minimum.
attributionModelNoSelects which server-verified visit receives conversion credit within `referralCookieWindowDays`. `LAST_CLICK` is used when this field is missing, including for programs created before attribution models were configurable.
taxDocumentationNoAffiliate programs only. Company billing details (name, address, VAT number) used on affiliate payout invoices and for VAT handling.
autoFulfillRewardsNoReferral programs only. Automatically mark earned rewards as fulfilled. `false` permits manual fulfillment and does not establish a delivery failure.
notificationEmailsNoOwner notification settings: `recipients` plus per-event `events` toggles.
blockPaidAdsTrafficNoDo not attribute referrals from visitors who arrived through paid ads.
enforceGdprComplianceNoStore only the minimum participant data (no IP addresses, fingerprints, or mobile instance ids).
requireParticipantAuthNoRequire returning participants to authenticate. Affiliate programs require `true`.
affiliateApplicationModeNoAffiliate programs only. How public signups join the program. `OPEN_ENROLLMENT` enrolls them directly; `MANUAL_REVIEW` collects an application you approve or deny; `AUTO_APPROVE` collects the application and approves it immediately. Switching to a reviewed mode requires a saved Program Page. Enrollment through the API, CSV import, dashboard, or invites is never blocked by this setting.
referralCookieWindowDaysNoHow long a referral-link click is remembered in the visitor's browser, in days.
referralCreditWindowDaysNoHow long a referred friend has to complete the qualifying action, in days. `null` means the credit never expires.
requireManualFraudApprovalNoFlag suspected fraud for review instead of blocking signups automatically.
requireManualRewardApprovalNoReferral programs only. Hold each earned reward for manual approval before it unlocks.
affiliateReapplicationPolicyNoAffiliate programs only. Whether a denied applicant may apply again. `AFTER_COOLDOWN` (the default) allows a new application once `affiliateReapplicationCooldownDays` has passed; `DISABLED` never allows one.
affiliateReapplicationCooldownDaysNoAffiliate programs only. How many days a denied applicant waits before they can apply again (1-365, default 30). Only used when `affiliateReapplicationPolicy` is `AFTER_COOLDOWN`.
affiliateApplicationReviewEstimateBusinessDaysNoAffiliate programs only. Optional review-time expectation shown to pending applicants, in business days (1-60). `null` clears it.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.19.34
    • addedOutput schema / properties / languages / properties / baseLanguageTranslation
      Added value: +{
      +  "description": "Read-only. When `baseLanguage` is not `en`, how much of the program's text in the Program Editor is not in the base language yet. GrowSurf translates its own default text. Text the customer wrote stays as written until the customer translates it from Options > Languages in the dashboard. `null` when `baseLanguage` is `en`, or when the account does not include additional languages. It is ignored in updates.",
      +  "properties": {
      +    "total": {
      +      "description": "How many texts the Program Editor holds for this program.",
      +      "type": "integer"
      +    },
      +    "untranslated": {
      +      "description": "How many texts have no current translation in the base language. This includes default text GrowSurf is still translating, so it can stay high for a few minutes after `baseLanguage` changes.",
      +      "type": "integer"
      +    }
      +  },
      +  "type": [
      +    "object",
      +    "null"
      +  ]
      +}
  2. Changed1 schema field changedv0.19.33
    • changedInput schema / properties / campaignId / description
      Previous 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."New value: +"Target program id for this call: the `id` returned by `growsurf_list_campaigns`, not the program name or a share URL. Defaults to GROWSURF_CAMPAIGN_ID when omitted. Program IDs also identify newly created programs without restarting the server."
  3. Changed1 schema field changedv0.19.28
    • changedOutput schema / properties / languages / properties / baseLanguage / description
      Previous value: -"The language the program is written in (default `en`). Participants see it when their language is not one of the program's languages, and for untranslated text. Supported codes: `en`, `es`, `fr`, `de`, `it`, `pt-BR`, `nl`, `pl`, `sv`, `tr`, `ja`, `ko`, `zh-CN`, `id`, `da`, `nb`, `nn`, `fi`, `is`, `cs`, `sk`, `hu`, `ro`, `hr`, `sl`, `et`, `lv`, `lt`, `el`, `bg`, `uk`, `ru`, `pt-PT`, `ca`, `vi`, `ms`, `fil`, `af`, `sw`."New value: +"The language the program is written in (default `en`). Participants see it when their language is not one of the program's languages, and for untranslated text. Supported codes: `en`, `es`, `fr`, `de`, `it`, `pt-BR`, `nl`, `pl`, `sv`, `tr`, `ja`, `ko`, `zh-CN`, `id`, `da`, `nb`, `nn`, `fi`, `is`, `cs`, `sk`, `hu`, `ro`, `hr`, `sl`, `et`, `lv`, `lt`, `el`, `bg`, `uk`, `ru`, `pt-PT`, `ca`, `vi`, `ms`, `fil`, `af`, `sw`, `zh-TW`, `es-419`."
  4. Changed4 schema fields changedv0.19.27
    • changedOutput schema / properties / affiliateApplicationMode / description
      Previous value: -"Affiliate programs only. How public signups join the program. `OPEN_ENROLLMENT` enrolls them directly; `MANUAL_REVIEW` collects an application you approve or deny; `AUTO_APPROVE` collects the application and approves it immediately. A reviewed mode requires the program's published application page. Enrollment through the API, CSV import, dashboard, or invites is never blocked by this setting."New value: +"Affiliate programs only. How public signups join the program. `OPEN_ENROLLMENT` enrolls them directly; `MANUAL_REVIEW` collects an application you approve or deny; `AUTO_APPROVE` collects the application and approves it immediately. Switching to a reviewed mode requires a saved Program Page. Enrollment through the API, CSV import, dashboard, or invites is never blocked by this setting."
    • addedOutput schema / properties / attributionModel
      Added value: +{
      +  "description": "Selects which server-verified visit receives conversion credit within `referralCookieWindowDays`. `LAST_CLICK` is used when this field is missing, including for programs created before attribution models were configurable.",
      +  "enum": [
      +    "LAST_CLICK",
      +    "FIRST_CLICK"
      +  ],
      +  "type": "string"
      +}
    • changedOutput schema / properties / languages / description
      Previous value: -"The languages the program runs in. Participants see the portal and program emails in their language. Turning on additional languages, and any change while they are on, requires the Business plan or higher. Translations are managed in the dashboard."New value: +"The languages the program runs in. Participants see the portal and program emails in their language. Translations are managed in the dashboard."
    • addedOutput schema / properties / languages / properties / flagCountries
      Added value: +{
      +  "additionalProperties": {
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "description": "The flag shown next to each language name when `showFlags` is on, keyed by language code (for example `{ en: 'GB' }`). Only languages with more than one flag to choose from are listed. Values are ISO 3166 country codes; `ES-CT` is Catalonia. Send `null` for a language to go back to its default flag.",
      +  "type": "object"
      +}
  5. Changed3 schema fields changedv0.19.15
    • addedInput schema / properties / campaignId / minLength
      Added value: +1
    • addedInput schema / required
      Added value: +[
      +  "campaignId"
      +]
    • addedOutput schema / properties / languages
      Added value: +{
      +  "description": "The languages the program runs in. Participants see the portal and program emails in their language. Turning on additional languages, and any change while they are on, requires the Business plan or higher. Translations are managed in the dashboard.",
      +  "properties": {
      +    "additionalLanguages": {
      +      "description": "Other languages participants can see, besides `baseLanguage`, using the same codes. `PATCH` replaces the whole list; `[]` turns them off. The base language is dropped from the list and duplicates collapse. Removing a language keeps its translations.",
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    "baseLanguage": {
      +      "description": "The language the program is written in (default `en`). Participants see it when their language is not one of the program's languages, and for untranslated text. Supported codes: `en`, `es`, `fr`, `de`, `it`, `pt-BR`, `nl`, `pl`, `sv`, `tr`, `ja`, `ko`, `zh-CN`, `id`, `da`, `nb`, `nn`, `fi`, `is`, `cs`, `sk`, `hu`, `ro`, `hr`, `sl`, `et`, `lv`, `lt`, `el`, `bg`, `uk`, `ru`, `pt-PT`, `ca`, `vi`, `ms`, `fil`, `af`, `sw`.",
      +      "type": "string"
      +    },
      +    "showFlags": {
      +      "description": "Shows a flag next to each language name in the language picker participants use. New programs start with `false`.",
      +      "type": "boolean"
      +    }
      +  },
      +  "type": "object"
      +}
  6. 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."
  7. Changed2 schema fields changedv0.14.0
    • changedOutput schema / properties / autoFulfillRewards / description
      Previous value: -"Referral programs only. Automatically mark earned rewards as fulfilled."New value: +"Referral programs only. Automatically mark earned rewards as fulfilled. `false` permits manual fulfillment and does not establish a delivery failure."
    • 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"
      +}
  8. 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 cover read-only/idempotent/non-destructive, but the description adds genuinely non-derivable behavior: `languages.baseLanguageTranslation` is a read-only computed count of untranslated Program Editor text, and `autoFulfillRewards: false` merely permits manual fulfillment rather than proving non-delivery. Those are real misinterpretation traps for an agent, disclosed before they can cause a wrong conclusion.

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?

Purpose is front-loaded in the first clause, and each subsequent sentence carries a distinct warning or targeting rule. The long parenthetical field enumeration is dense but serves discovery; nothing is filler, though the phrasing is somewhat packed for a single read.

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?

An output schema exists, so return values need not be spelled out, yet the description still sets expectations about receiving the full object in the same shape as the update payload. Combined with the targeting rule and caveats, an agent has enough to call this correctly; only an explicit alternative-routing statement 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?

With a single parameter at 100% schema description coverage, the schema already explains that `campaignId` is the `id` from `growsurf_list_campaigns`, not a name or share URL, and that it defaults to the env var. The description restates the defaulting rule and adds little syntax or format meaning beyond the schema, so baseline 3 applies.

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 (Fetch) and a clearly bounded resource: the Options tab configuration of a GrowSurf program, enumerated field-by-field (referral triggers, anti-fraud lists, affiliate enrollment, notifications, `languages`). That scoping distinguishes it from the broader `growsurf_get_campaign` and from the write-side `growsurf_update_campaign_options` without needing to open a schema.

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 concrete context for calling it and explains target resolution (`campaignId` if passed, otherwise `GROWSURF_CAMPAIGN_ID`), plus the implicit pairing with the update tool via 'the same shape you send back on update.' It stops short of an explicit 'do not use this to modify settings — use growsurf_update_campaign_options instead' exclusion, so it is clear but not fully 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