Skip to main content
Glama

GrowSurf

Get Program Options

growsurf_get_campaign_options
Read-onlyIdempotent

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). 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.

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
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. Turning on additional languages, and any change while they are on, requires the Business plan or higher. 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.
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. 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.
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. Changed2 schema fields changed
    • 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`."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`."
    • addedOutput schema / properties / languages / properties / showFlags
      Added value: +{
      +  "description": "Shows a flag next to each language name in the language picker participants use. New programs start with `false`.",
      +  "type": "boolean"
      +}
  2. Changed1 schema field changed
    • 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 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. Turning on additional languages, and any change while they are on, requires the Business plan or higher. Translations are managed in the dashboard."
  3. Changed1 schema field changed
    • 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 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`.",
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  4. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already establish readOnly/idempotent/non-destructive, so the bar is lower, and the description adds real value beyond them: it promises the full object with every field and current value, states it round-trips with the update call, and pre-empts a likely misinterpretation of autoFulfillRewards:false. It does not cover auth/permission needs or rate limits.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the purpose, then the return shape, then the caveat and the targeting rule. Every clause carries information an agent needs; the parenthetical enumeration is dense but earns its space by naming the configurable sub-areas.

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?

With an output schema present the description need not describe return values, yet it helpfully states the shape is write-back compatible. Target selection and default are covered. Only minor gaps remain (auth requirements, whether a program must already exist), and none would block a correct call.

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 coverage is 100% and the single campaignId parameter is fully documented in the schema, including the GROWSURF_CAMPAIGN_ID default. The description restates the same targeting rule ('Targets campaignId if you pass it, otherwise GROWSURF_CAMPAIGN_ID') without adding syntax or format detail, so the baseline of 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?

Specific verb ('Fetch') plus specific resource ('Options tab configuration for your GrowSurf program'), and it enumerates the sub-areas the Options tab covers (triggers, anti-fraud, affiliate enrollment, notifications, languages). This distinguishes it clearly from siblings like growsurf_get_campaign and growsurf_update_campaign_options.

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?

Usage is implied rather than stated: 'the same shape you send back on update' anchors it as the read-side partner of growsurf_update_campaign_options, and the autoFulfillRewards note warns against a wrong inference. But there is no explicit when-to-use/when-not guidance or named alternative for cases where a different getter is appropriate.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.