Skip to main content
Glama
GrowSurf MCP Server

GrowSurf MCP Server

Official

Get Program Installation

growsurf_get_campaign_installation
Read-onlyIdempotent

Retrieve a GrowSurf program's Installation tab configuration, including embed and tracking setup fields, to inspect current values for updates or setup checks.

Instructions

Fetch the Installation tab configuration for your GrowSurf program (embed/installation and tracking setup). Returns the full object with every field and its current value — the same shape you send back on update. 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_installation"
  }
}

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
mobileNoGrowSurf iOS and Android SDK settings.
signupNoCustom signup-form settings (used with `FORM_DETECTION`).
shareUrlNoThe landing page referred friends reach from a referral link. Set this before adding other origins to `allowedUrls`.
allowedUrlsNoEvery additional browser origin where the GrowSurf Window or SDK may run, including development origins such as `http://localhost:3000`. Preserve the full array when patching it. An origin absent from both `shareUrl` and this list can return `403`. Known shared-platform root domains, such as `github.io`, do not grant access. Add your site's hostname, such as `https://piedpiper.github.io`, or a domain you own. Path-based shared hosts, such as `unbouncepages.com`, require a domain you own. Each new entry must be a full URL that includes its scheme, such as `https://`.
signupEventNoThe signup tracking method: automatic form detection, or participants added via the SDKs and REST API.
referralTriggerNoReferral programs only. `ON_SIGNUP` counts a referral as soon as the friend signs up; `CUSTOM` also requires a qualifying action. `CUSTOM` is available for programs installed on a website or a GrowSurf landing page.
instructionSelectionsNoSaved choices shown in the Program Editor installation guide.
useGrowSurfHostedLinksNoUse GrowSurf-hosted referral links that route clicks by the visitor's device. Mainly for mobile apps.
offerPageRedirectSecondsNoSeconds a GrowSurf page with the Claim Offer Popup waits before redirecting a referred friend. Needs `useGrowSurfHostedLinks`. `null` means the page is off.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.19.31
    • addedOutput schema / properties / instructionSelections / properties / webTracking
      Added value: +{
      +  "description": "Web referral tracking guide shown in step 1. Referral programs only; does not change the referral setup.",
      +  "enum": [
      +    "hosted",
      +    "website"
      +  ],
      +  "type": "string"
      +}
  2. Changed8 schema fields changedv0.19.27
    • changedOutput schema / properties / allowedUrls / description
      Previous value: -"Every additional browser origin where the GrowSurf Window or SDK may run, including development origins such as `http://localhost:3000`. Preserve the full array when patching it. An origin absent from both `shareUrl` and this list can return `403`. Known shared-platform root domains, such as `github.io`, do not grant access. Add your site's hostname, such as `https://piedpiper.github.io`, or a domain you own. Path-based shared hosts, such as `unbouncepages.com`, require a domain you own."New value: +"Every additional browser origin where the GrowSurf Window or SDK may run, including development origins such as `http://localhost:3000`. Preserve the full array when patching it. An origin absent from both `shareUrl` and this list can return `403`. Known shared-platform root domains, such as `github.io`, do not grant access. Add your site's hostname, such as `https://piedpiper.github.io`, or a domain you own. Path-based shared hosts, such as `unbouncepages.com`, require a domain you own. Each new entry must be a full URL that includes its scheme, such as `https://`."
    • changedOutput schema / properties / instructionSelections / properties / stepProviders / properties / step2Referral / description
      Previous value: -"Referral step 2 method."New value: +"Referral step 2 method. `baskHealth`, `telegra`, `mdIntegrations`, `lithos`, and `carevalidate` are available only for programs with the `TELEHEALTH` goal."
    • changedOutput schema / properties / instructionSelections / properties / stepProviders / properties / step2Referral / enum
      Previous value: -[
      -  "restApi",
      -  "zapier",
      -  "stripe",
      -  "chargebee",
      -  "recurly",
      -  "paypal",
      -  "hubspot",
      -  "salesforce"
      -]New value: +[
      +  "restApi",
      +  "zapier",
      +  "stripe",
      +  "chargebee",
      +  "recurly",
      +  "paypal",
      +  "hubspot",
      +  "salesforce",
      +  "klaviyo",
      +  "customerio",
      +  "baskHealth",
      +  "telegra",
      +  "mdIntegrations",
      +  "lithos",
      +  "carevalidate"
      +]
    • changedOutput schema / properties / instructionSelections / properties / stepProviders / properties / step3Referral / description
      Previous value: -"Referral reward method shown in step 3."New value: +"Referral reward method shown in step 3. `baskHealth` is available only for programs with the `TELEHEALTH` goal."
    • changedOutput schema / properties / instructionSelections / properties / stepProviders / properties / step3Referral / enum
      Previous value: -[
      -  "webhooks",
      -  "zapier",
      -  "paypal",
      -  "tangocard",
      -  "stripe",
      -  "chargebee",
      -  "recurly"
      -]New value: +[
      +  "webhooks",
      +  "zapier",
      +  "paypal",
      +  "tangocard",
      +  "tremendous",
      +  "stripe",
      +  "chargebee",
      +  "recurly",
      +  "baskHealth"
      +]
    • changedOutput schema / properties / referralTrigger / description
      Previous value: -"Referral programs only. `ON_SIGNUP` counts a referral as soon as the friend signs up; `CUSTOM` also requires a qualifying action."New value: +"Referral programs only. `ON_SIGNUP` counts a referral as soon as the friend signs up; `CUSTOM` also requires a qualifying action. `CUSTOM` is available for programs installed on a website or a GrowSurf landing page."
    • addedOutput schema / properties / signup / properties / additionalSignupUrls
      Added value: +{
      +  "description": "Extra pages where GrowSurf watches signup form fields when `trackInputFields` is on. Each URL must include an `http(s)://` scheme and contain no `#!` or `??`. Duplicates are removed. Sending this array replaces the entire list.",
      +  "items": {
      +    "maxLength": 500,
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / signup / properties / forms
      Added value: +{
      +  "description": "Forms GrowSurf listens to when `signupEvent` is `FORM_DETECTION`, as found by the dashboard form scan. A form counts only when `isSelected` is `true`; a selected form must have exactly one field whose `key` is `email`. A form sent back unchanged is not checked again. Sending this array replaces the entire list.",
      +  "items": {
      +    "properties": {
      +      "className": {
      +        "description": "The form's `class` attribute, if any.",
      +        "maxLength": 500,
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "fields": {
      +        "description": "The form's input fields and the participant value each one fills.",
      +        "items": {
      +          "properties": {
      +            "className": {
      +              "description": "The input's `class` attribute, if any.",
      +              "maxLength": 500,
      +              "type": [
      +                "string",
      +                "null"
      +              ]
      +            },
      +            "id": {
      +              "description": "The input's `id` attribute, if any.",
      +              "maxLength": 500,
      +              "type": [
      +                "string",
      +                "null"
      +              ]
      +            },
      +            "include": {
      +              "description": "Whether GrowSurf reads this input when the form is submitted.",
      +              "type": "boolean"
      +            },
      +            "key": {
      +              "description": "The participant value this input fills: `email`, `firstName`, `lastName`, `ignore`, or a metadata key. An empty string means no value is chosen yet.",
      +              "maxLength": 100,
      +              "type": "string"
      +            },
      +            "name": {
      +              "description": "The input's `name` attribute, if any.",
      +              "maxLength": 500,
      +              "type": [
      +                "string",
      +                "null"
      +              ]
      +            },
      +            "selector": {
      +              "description": "CSS selector for the input inside the form.",
      +              "maxLength": 500,
      +              "type": "string"
      +            },
      +            "type": {
      +              "description": "The input's `type` attribute, if any.",
      +              "maxLength": 500,
      +              "type": [
      +                "string",
      +                "null"
      +              ]
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "maxItems": 500,
      +        "type": "array"
      +      },
      +      "id": {
      +        "description": "The form's `id` attribute, if any.",
      +        "maxLength": 500,
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "isSelected": {
      +        "description": "Whether GrowSurf adds participants when this form is submitted.",
      +        "type": "boolean"
      +      },
      +      "name": {
      +        "description": "The form's `name` attribute, if any.",
      +        "maxLength": 500,
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "selector": {
      +        "description": "CSS selector for the form on the signup page.",
      +        "maxLength": 500,
      +        "type": "string"
      +      }
      +    },
      +    "type": "object"
      +  },
      +  "maxItems": 500,
      +  "type": "array"
      +}
  3. Changed1 schema field changedv0.19.23
    • addedOutput schema / properties / offerPageRedirectSeconds
      Added value: +{
      +  "description": "Seconds a GrowSurf page with the Claim Offer Popup waits before redirecting a referred friend. Needs `useGrowSurfHostedLinks`. `null` means the page is off.",
      +  "enum": [
      +    5,
      +    10,
      +    15,
      +    null
      +  ],
      +  "type": [
      +    "integer",
      +    "null"
      +  ]
      +}
  4. Changed2 schema fields changedv0.19.15
    • addedInput schema / properties / campaignId / minLength
      Added value: +1
    • addedInput schema / required
      Added value: +[
      +  "campaignId"
      +]
  5. 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."
  6. Changed1 schema field changedv0.19.8
    • changedOutput schema / properties / allowedUrls / description
      Previous value: -"Every additional browser origin where the GrowSurf Window or SDK may run, including development origins such as `http://localhost:3000`. Preserve the full array when patching it. An origin absent from both `shareUrl` and this list can return `403`."New value: +"Every additional browser origin where the GrowSurf Window or SDK may run, including development origins such as `http://localhost:3000`. Preserve the full array when patching it. An origin absent from both `shareUrl` and this list can return `403`. Known shared-platform root domains, such as `github.io`, do not grant access. Add your site's hostname, such as `https://piedpiper.github.io`, or a domain you own. Path-based shared hosts, such as `unbouncepages.com`, require a domain you own."
  7. Changed1 schema field changedv0.19.7
    • addedOutput schema / properties / instructionSelections
      Added value: +{
      +  "description": "Saved choices shown in the Program Editor installation guide.",
      +  "properties": {
      +    "mobileAttributionProvider": {
      +      "description": "Mobile attribution provider selected for the guide.",
      +      "enum": [
      +        "branch",
      +        "appsflyer",
      +        "adjust",
      +        "singular",
      +        "other"
      +      ],
      +      "type": "string"
      +    },
      +    "platform": {
      +      "description": "Platform shown in step 1.",
      +      "enum": [
      +        "web",
      +        "ios",
      +        "android"
      +      ],
      +      "type": "string"
      +    },
      +    "stepProviders": {
      +      "description": "Selected method for each installation step; affiliate and referral choices depend on program type.",
      +      "properties": {
      +        "step2Affiliate": {
      +          "description": "Affiliate step 2 method.",
      +          "enum": [
      +            "stripe",
      +            "chargebee",
      +            "recurly",
      +            "restApi"
      +          ],
      +          "type": "string"
      +        },
      +        "step2Referral": {
      +          "description": "Referral step 2 method.",
      +          "enum": [
      +            "restApi",
      +            "zapier",
      +            "stripe",
      +            "chargebee",
      +            "recurly",
      +            "paypal",
      +            "hubspot",
      +            "salesforce"
      +          ],
      +          "type": "string"
      +        },
      +        "step2Signup": {
      +          "description": "Signup method shown in step 2.",
      +          "enum": [
      +            "restApi",
      +            "javascript"
      +          ],
      +          "type": "string"
      +        },
      +        "step3Affiliate": {
      +          "description": "Affiliate payout method shown in step 3.",
      +          "enum": [
      +            "paypal",
      +            "wise"
      +          ],
      +          "type": "string"
      +        },
      +        "step3Referral": {
      +          "description": "Referral reward method shown in step 3.",
      +          "enum": [
      +            "webhooks",
      +            "zapier",
      +            "paypal",
      +            "tangocard",
      +            "stripe",
      +            "chargebee",
      +            "recurly"
      +          ],
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    }
      +  },
      +  "type": "object"
      +}
  8. First observedv0.12.2

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and closed-world scope, so the safety profile is covered. The description adds genuinely useful behavior beyond that: it returns the full object with every field's current value and matches the update payload shape, enabling a read-modify-write round trip, plus the campaign-id fallback behavior.

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?

Two sentences, front-loaded with the resource being fetched, then the return-shape note, then the targeting rule. No filler or redundancy; every clause carries information an agent can act on.

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 needn't enumerate return fields, and it correctly avoids doing so while still telling the agent the response mirrors the update payload. For a one-parameter read tool this is nearly complete; only error/not-found behavior is left unaddressed.

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% with a single parameter whose schema text already documents the GROWSURF_CAMPAIGN_ID fallback. The description's 'Targets campaignId if you pass it, otherwise GROWSURF_CAMPAIGN_ID' restates the schema rather than adding new semantics, so the baseline 3 applies.

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?

The description opens with a specific verb and resource ('Fetch the Installation tab configuration') and clarifies the domain with '(embed/installation and tracking setup)'. The clause 'the same shape you send back on update' implicitly points at the update sibling, but it never names growsurf_update_campaign_installation, so differentiation stops short of fully explicit.

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?

There is no explicit when-to-use / when-not-to-use statement and no named alternative (e.g. 'use growsurf_update_campaign_installation to change these values'). The only targeting guidance — campaignId vs GROWSURF_CAMPAIGN_ID — is usage-adjacent but addresses parameter selection rather than tool selection, leaving the agent to infer when this read is appropriate.

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