Skip to main content
Glama
growsurf

GrowSurf MCP Server

Official

Update Participant

growsurf_update_participant
DestructiveIdempotent

Update a GrowSurf participant by ID or email, changing only the fields you send. Manage names, email, language, notes, referrals, and affiliate status; read-only fields are rejected.

Instructions

Update a participant by GrowSurf participant ID or email. Only the fields you send are changed; read-only fields such as counters, isAffiliate, origin, and fraud state are rejected with a 400. In affiliate programs, affiliateStatus accepts APPROVED, SUSPENDED, or BANNED; APPROVED enrolls the participant, while SUSPENDED and BANNED require an existing affiliate. Affiliate enrollment cannot be removed through REST. notes is freeform internal notes (never shown to participants). Targets campaignId if you pass it, otherwise GROWSURF_CAMPAIGN_ID.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
emailNoChange the participant's email address.
notesNoFreeform internal notes (internal only, never exposed to participants).
languageNoThe language of the participant's portal and program emails. Must be one of the program's languages (`languages` in `growsurf_get_campaign_options`); any other code returns a `400`. Send `null` or the program's base language to clear it, so the participant follows the base language. 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`.
lastNameNo
metadataNo
firstNameNo
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.
referredByNo
vanityKeysNo
unsubscribedNo
participantIdNo
referralStatusNo
affiliateStatusNoAffiliate programs only. Sets the affiliate status. `APPROVED` also enrolls a participant who is not yet an affiliate. `SUSPENDED` and `BANNED` are rejected for non-affiliates.
participantEmailNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.19.15
    • addedInput schema / properties / campaignId / minLength
      Added value: +1
    • addedInput schema / properties / language
      Added value: +{
      +  "description": "The language of the participant's portal and program emails. Must be one of the program's languages (`languages` in `growsurf_get_campaign_options`); any other code returns a `400`. Send `null` or the program's base language to clear it, so the participant follows the base language. 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",
      +    "null"
      +  ]
      +}
    • addedInput schema / required
      Added value: +[
      +  "campaignId"
      +]
  2. 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."
  3. First observedv0.12.2

TDQS

A4.6/5.0
Behavior5/5

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

Annotations only say mutation/destructive/idempotent; the description goes well beyond by naming exactly which fields are rejected (counters, isAffiliate, origin, fraud state) and with what error, disclosing that SUSPENDED/BANNED require an existing affiliate, that enrollment is not removable via REST, and that notes are never exposed to participants. The destructive hint is also implicitly qualified by the partial-update guarantee.

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?

Roughly six dense sentences, each carrying distinct operational information; the subject and lookup keys come first, followed by mutation semantics and then edge-case rules. No filler or restatement of the tool name.

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?

For a 14-parameter mutation tool with an output schema (so return values need not be described) and annotations covering safety, the description is close to complete: partial-update behavior, error conditions, affiliate constraints, and targeting are all covered. Minor gaps remain around auth/permission requirements and the unexplained free-form fields.

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 description coverage is only 36% across 14 params, so the description must compensate, and it does for the risky ones: affiliateStatus semantics (enroll vs. requires existing affiliate), notes privacy, and campaignId defaulting to GROWSURF_CAMPAIGN_ID. It leaves referredBy, vanityKeys, unsubscribed, referralStatus, and metadata behavior unexplained, which keeps it below 5.

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+resource ('Update a participant') plus the two accepted lookup keys (participant ID or email). It is immediately distinguishable from growsurf_get_participant, growsurf_add_participant, and growsurf_bulk_delete_participants without opening 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 usage conditions: partial-update semantics ('only the fields you send are changed'), the 400 rejection for read-only fields, and the affiliate-status rules including that enrollment cannot be removed via REST. It does not explicitly route to sibling tools (e.g. get_participant to read, add_participant to create), so it stops short of 5.

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