Skip to main content
Glama
GrowSurf MCP Server

GrowSurf MCP Server

Official

Update Program Installation

growsurf_update_campaign_installation
DestructiveIdempotent

Update a GrowSurf program's Installation tab configuration by patching selected fields; omitted fields stay unchanged and arrays are replaced wholesale.

Instructions

Update the Installation tab configuration for your GrowSurf program under fields. Only supplied fields change; omitted fields retain their existing values and arrays replace wholesale. allowedUrls includes permitted browser origins such as http://localhost:3000. An origin missing from both shareUrl and allowedUrls can return 403. Referral links already shared point at the current shareUrl. Replacing an existing Share URL requires the customer's explicit approval and replaceExistingShareUrl: true; otherwise the patch is refused. One call can change many fields, so send related changes together instead of one field per call. Read growsurf_get_campaign_installation first and use its field names and allowed values exactly. An invalid field returns an error that names the field. Targets campaignId if supplied, 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": {
      "fields": "<fields>",
      "campaignId": "<campaignId>"
    },
    "name": "growsurf_update_campaign_installation"
  }
}

Input Schema

NameRequiredDescriptionDefault
fieldsYesInstallation fields to patch. Common keys include `shareUrl`, `allowedUrls`, `signupEvent`, `referralTrigger`, `signup`, `useGrowSurfHostedLinks`, `mobile`, `offerPageRedirectSeconds`, and `instructionSelections`. Arrays replace wholesale.
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.
replaceExistingShareUrlNoSet this to `true` only after the customer confirms they want a different landing page. Without it, a patch that would replace a Share URL that is already set is refused.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.19.34
    • changedInput schema / properties / fields / description
      Previous value: -"Installation fields to patch. Common keys include `shareUrl`, `allowedUrls`, `signupEvent`, `referralTrigger`, `signup`, `offerPageRedirectSeconds`, and `instructionSelections`. Arrays replace wholesale."New value: +"Installation fields to patch. Common keys include `shareUrl`, `allowedUrls`, `signupEvent`, `referralTrigger`, `signup`, `useGrowSurfHostedLinks`, `mobile`, `offerPageRedirectSeconds`, and `instructionSelections`. Arrays replace wholesale."
  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.31
    • addedInput schema / properties / fields / 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"
      +}
  4. Changed7 schema fields changedv0.19.27
    • changedInput schema / properties / fields / properties / allowedUrls / description
      Previous value: -"Every browser origin allowed to use the program, including local and staging origins. Send the full array because arrays replace wholesale. 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 browser origin allowed to use the program, including local and staging origins. Send the full array because arrays replace wholesale. 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://`."
    • addedInput schema / properties / fields / properties / instructionSelections / properties / stepProviders / properties / step2Referral / description
      Added value: +"`baskHealth`, `telegra`, `mdIntegrations`, `lithos`, and `carevalidate` are available only for programs with the `TELEHEALTH` goal."
    • changedInput schema / properties / fields / 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"
      +]
    • addedInput schema / properties / fields / properties / instructionSelections / properties / stepProviders / properties / step3Referral / description
      Added value: +"`baskHealth` is available only for programs with the `TELEHEALTH` goal."
    • changedInput schema / properties / fields / 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"
      +]
    • addedInput schema / properties / fields / 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. Sending this array replaces the entire list.",
      +  "items": {
      +    "maxLength": 500,
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedInput schema / properties / fields / properties / signup / properties / forms
      Added value: +{
      +  "description": "Forms GrowSurf listens to when `signupEvent` is `FORM_DETECTION`, in the shape `growsurf_get_campaign_installation` returns. A selected form (`isSelected: true`) 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": {
      +    "additionalProperties": true,
      +    "type": "object"
      +  },
      +  "maxItems": 500,
      +  "type": "array"
      +}
  5. Changed2 schema fields changedv0.19.23
    • changedInput schema / properties / fields / description
      Previous value: -"Installation fields to patch. Common keys include `shareUrl`, `allowedUrls`, `signupEvent`, `referralTrigger`, `signup`, and `instructionSelections`. Arrays replace wholesale."New value: +"Installation fields to patch. Common keys include `shareUrl`, `allowedUrls`, `signupEvent`, `referralTrigger`, `signup`, `offerPageRedirectSeconds`, and `instructionSelections`. Arrays replace wholesale."
    • addedInput schema / properties / fields / properties / offerPageRedirectSeconds
      Added value: +{
      +  "description": "Shows the Claim Offer Popup on a GrowSurf page before a referred friend reaches the customer's site, then redirects after this many seconds. Requires `useGrowSurfHostedLinks: true`. `null` turns the page off. Set the page's side content with `referredExperience.offerPageDescription`, `offerPageSteps`, and `offerPageLinks` through `growsurf_update_campaign_design`.",
      +  "enum": [
      +    5,
      +    10,
      +    15,
      +    null
      +  ],
      +  "type": [
      +    "integer",
      +    "null"
      +  ]
      +}
  6. Changed2 schema fields changedv0.19.15
    • addedInput schema / properties / campaignId / minLength
      Added value: +1
    • changedInput schema / required
      Previous value: -[
      -  "fields"
      -]New value: +[
      +  "fields",
      +  "campaignId"
      +]
  7. 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."
  8. Changed1 schema field changedv0.19.8
    • changedInput schema / properties / fields / properties / allowedUrls / description
      Previous value: -"Every browser origin allowed to use the program, including local and staging origins. Send the full array because arrays replace wholesale."New value: +"Every browser origin allowed to use the program, including local and staging origins. Send the full array because arrays replace wholesale. 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."
  9. Changed2 schema fields changedv0.19.7
    • changedInput schema / properties / fields / description
      Previous value: -"Installation fields to patch. Common keys include `shareUrl`, `allowedUrls`, `signupEvent`, `referralTrigger`, and `signup`. Arrays replace wholesale."New value: +"Installation fields to patch. Common keys include `shareUrl`, `allowedUrls`, `signupEvent`, `referralTrigger`, `signup`, and `instructionSelections`. Arrays replace wholesale."
    • addedInput schema / properties / fields / properties / instructionSelections
      Added value: +{
      +  "additionalProperties": true,
      +  "description": "Guide choices. Send only the choices to change.",
      +  "properties": {
      +    "mobileAttributionProvider": {
      +      "enum": [
      +        "branch",
      +        "appsflyer",
      +        "adjust",
      +        "singular",
      +        "other"
      +      ],
      +      "type": "string"
      +    },
      +    "platform": {
      +      "enum": [
      +        "web",
      +        "ios",
      +        "android"
      +      ],
      +      "type": "string"
      +    },
      +    "stepProviders": {
      +      "additionalProperties": true,
      +      "description": "Selected method for each guide step. Available keys depend on program type.",
      +      "properties": {
      +        "step2Affiliate": {
      +          "enum": [
      +            "stripe",
      +            "chargebee",
      +            "recurly",
      +            "restApi"
      +          ],
      +          "type": "string"
      +        },
      +        "step2Referral": {
      +          "enum": [
      +            "restApi",
      +            "zapier",
      +            "stripe",
      +            "chargebee",
      +            "recurly",
      +            "paypal",
      +            "hubspot",
      +            "salesforce"
      +          ],
      +          "type": "string"
      +        },
      +        "step2Signup": {
      +          "enum": [
      +            "restApi",
      +            "javascript"
      +          ],
      +          "type": "string"
      +        },
      +        "step3Affiliate": {
      +          "enum": [
      +            "paypal",
      +            "wise"
      +          ],
      +          "type": "string"
      +        },
      +        "step3Referral": {
      +          "enum": [
      +            "webhooks",
      +            "zapier",
      +            "paypal",
      +            "tangocard",
      +            "stripe",
      +            "chargebee",
      +            "recurly"
      +          ],
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    }
      +  },
      +  "type": "object"
      +}
  10. Changed1 schema field changedv0.14.0
    • addedInput schema / properties / replaceExistingShareUrl
      Added value: +{
      +  "description": "Set this to `true` only after the customer confirms they want a different landing page. Without it, a patch that would replace a Share URL that is already set is refused.",
      +  "type": "boolean"
      +}
  11. First observedv0.12.2

TDQS

A4.8/5.0
Behavior5/5

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

Goes well beyond the destructive/idempotent/openWorld annotations: patch semantics (only supplied fields change, arrays replace wholesale), a 403 failure mode when an origin is missing from both `shareUrl` and `allowedUrls`, a refused patch when replacing an existing Share URL without explicit approval, and an error that names the invalid field.

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 and nearly every sentence carries operational content. It is dense and reads as a run of short clauses rather than grouped sections, so scanning for the approval rule takes a second pass, but there is little outright waste.

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 destructive, idempotent patch tool with a nested free-form `fields` object, the description covers the essentials an agent needs: read-before-write, merge semantics, array replacement, approval gate, failure modes, and target resolution. An output schema exists, so return values need no explanation.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description adds real meaning: `allowedUrls` holds permitted browser origins (e.g. `http://localhost:3000`), `replaceExistingShareUrl` encodes an approval precondition, and `campaignId` defaults to the env var. It stops short of explaining the many nested `fields` keys, which the schema carries.

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 and resource: 'Update the Installation tab configuration for your GrowSurf program under `fields`.' The mention of the Installation tab, plus the explicit hand-off of offer-page side content to growsurf_update_campaign_design, lets an agent separate this from the design/emails/options siblings.

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

Usage Guidelines5/5

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

Gives ordered guidance: read growsurf_get_campaign_installation first and reuse its field names and allowed values, batch related changes into one call rather than one field per call, and require customer approval plus `replaceExistingShareUrl: true` before replacing a Share URL. Fallback targeting via `campaignId` or `GROWSURF_CAMPAIGN_ID` is spelled out.

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