Skip to main content
Glama
growsurf

GrowSurf MCP Server

Official
by growsurf
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Get Payout Destination

growsurf_get_participant_payout_destination
Read-onlyIdempotent

Retrieve a participant's payout-destination status by ID or email across PayPal and Wise, including active provider, confirmed payout email, recipient type, and repair reasons.

Instructions

Get a participant's payout-destination status (by GrowSurf participant ID or email) across every payout provider enabled for the program (PayPal and/or Wise). For each provider it reports the current status, the confirmed payout email, the legal recipient type, and — when a delivery bounced or a recipient was invalidated — the repair reason. activeProvider is the provider that currently gets paid, or null until the participant confirms one. Targets campaignId if you pass it, otherwise GROWSURF_CAMPAIGN_ID.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
campaignIdNoTarget program (campaign) id for this call. Defaults to GROWSURF_CAMPAIGN_ID when omitted. Program IDs also identify newly created programs without restarting the server.
participantIdNo
participantEmailNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
destinationsNoOne entry per enabled payout provider describing the participant's destination for it.
activeProviderNoThe payout provider currently selected, or `null` until the participant confirms one. Provider identifiers are open-ended; current examples include `PAYPAL`, `VENMO`, and `WISECOM`.
enabledProvidersNoPayout provider identifiers enabled for this program. Values are open-ended; current examples include `PAYPAL`, `VENMO`, and `WISECOM`.

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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."
  2. Changed3 schema fields changedv0.19.7
    • changedOutput schema / properties / activeProvider / description
      Previous value: -"The payout provider currently selected, or `null` until the participant confirms one. Provider identifiers are open-ended; current examples include `PAYPAL` and `WISECOM`."New value: +"The payout provider currently selected, or `null` until the participant confirms one. Provider identifiers are open-ended; current examples include `PAYPAL`, `VENMO`, and `WISECOM`."
    • changedOutput schema / properties / destinations / items / properties / provider / description
      Previous value: -"The payout provider identifier for this entry. Values are open-ended; current examples include `PAYPAL` and `WISECOM`."New value: +"The payout provider identifier for this entry. Values are open-ended; current examples include `PAYPAL`, `VENMO`, and `WISECOM`."
    • changedOutput schema / properties / enabledProviders / description
      Previous value: -"Payout provider identifiers enabled for this program. Values are open-ended; current examples include `PAYPAL` and `WISECOM`."New value: +"Payout provider identifiers enabled for this program. Values are open-ended; current examples include `PAYPAL`, `VENMO`, and `WISECOM`."
  3. First observedv0.12.2

TDQS

A4.1/5.0
Behavior5/5

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

Annotations already cover the read-only/idempotent/non-destructive profile, and the description goes well beyond them: it discloses what fields are returned per provider (status, confirmed email, recipient type, repair reason) and the semantics of activeProvider being null until confirmation. Rich behavioral context that the annotations could not convey.

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?

Front-loads the core purpose, then layers output detail and targeting logic without redundancy. Slightly dense but every clause carries information; nothing reads as filler.

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, return values need not be documented, yet the description helpfully characterizes them. Targeting defaults are covered; the only gap is the missing when-to-use guidance, which is minor for a read tool.

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 only 33% (campaignId documented, participantId/participantEmail bare). The description compensates partially by noting the participant can be identified by ID or email and by explaining the campaignId fallback to GROWSURF_CAMPAIGN_ID, but it adds no format or validation detail for the identifier params.

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 (Get) and resource (participant's payout-destination status), plus scope (across every payout provider enabled for the program). An agent can distinguish it from the sibling growsurf_request_participant_payout_destination_confirmation purely from the description.

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?

Explains how to target the program (campaignId or GROWSURF_CAMPAIGN_ID), which is useful context, but never says when to use this versus alternatives like get_participant or request_participant_payout_destination_confirmation. Usage is implied rather than stated.

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