Skip to main content
Glama
growsurf

GrowSurf MCP Server

Official

Bulk Delete Participants

growsurf_bulk_delete_participants
DestructiveIdempotent

Permanently delete up to 200 GrowSurf participants by ID or email in one request, removing their referrals, rewards, commissions, and payout records.

Instructions

Bulk delete participants from your GrowSurf program in one request. DESTRUCTIVE: deletion is permanent, cannot be undone, and removes the participants' referrals, rewards, commissions, and payout records. Each entry in participants is a GrowSurf participant ID or an email address (mixed lists are allowed), up to 200 entries per request — chunk larger lists across multiple calls. Returns a summary (total, deletedCount, notFoundCount, duplicateCount, errorCount) plus per-row results in request order, each with status DELETED, NOT_FOUND, DUPLICATE (resolves to the same participant as an earlier entry), or ERROR — both 200 and 202 responses can include NOT_FOUND or ERROR rows, and the summary reports these outcomes. A 202 response includes analyticsErasure when analytics erasure is pending. DELETED means participant cleanup completed; reports can retain the participant until analytics erasure completes. Repeating successful rows does not finish analytics erasure. 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.
participantsYesGrowSurf participant IDs and/or email addresses to delete (1-200 entries; mixed lists allowed).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultsNoOne entry per submitted identifier, in request order.
summaryNoCounts across all submitted entries.
analyticsErasureNoAnalytics erasure is pending. Reports can retain removed participants until erasure completes. Do not repeat successful deletions.

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. Changed2 schema fields changedv0.15.1
    • changedOutput schema / description
      Previous value: -"Bulk delete outcome. A `200` response can still include `NOT_FOUND` or `ERROR` rows, so check the summary."New value: +"Bulk delete outcome. A `202` response includes `analyticsErasure` when analytics erasure is pending. Both `200` and `202` responses can include `NOT_FOUND` or `ERROR` rows, so check the summary."
    • addedOutput schema / properties / analyticsErasure
      Added value: +{
      +  "description": "Analytics erasure is pending. Reports can retain removed participants until erasure completes. Do not repeat successful deletions.",
      +  "properties": {
      +    "operationId": {
      +      "description": "Opaque reference for support inquiries about this analytics erasure.",
      +      "type": "string"
      +    },
      +    "status": {
      +      "description": "Erasure has been accepted but is not confirmed complete.",
      +      "enum": [
      +        "pending"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  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 already flag destructiveHint and idempotentHint, but the description adds substantial context beyond them: deletion removes referrals, rewards, commissions, and payout records; 200 and 202 both can carry NOT_FOUND or ERROR rows; 202 signals pending analyticsErasure; repeating successful rows does not complete erasure. This is exactly the behavioral depth the annotations cannot 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-loaded with the destructive warning, then entry format, limits, and response semantics in a logical order. It is dense rather than wasteful, but the run of response-code detail (200/202, DELETED/NOT_FOUND/DUPLICATE/ERROR, analyticsErasure) is long enough that a tighter phrasing would still convey the same guidance.

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 bulk mutation with two parameters, the description covers safety, input limits, chunking, target resolution, and partial-failure semantics (per-row statuses, summary counts, 202 erasure state). Nothing an agent needs to invoke it safely and interpret mixed outcomes is missing.

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 schema itself documents mixed ID/email lists and the 1-200 bound. The description still adds value by clarifying the chunking strategy for lists over 200 and restating how campaignId falls back to the environment variable, which helps an agent plan multi-call deletions.

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 ('Bulk delete participants from your GrowSurf program') plus scope (single request, up to 200 entries) and target (campaignId or GROWSURF_CAMPAIGN_ID). An agent can distinguish it from growsurf_list_participants, growsurf_add_participant, and growsurf_update_participant without opening any 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 clear operational context: bulk deletion in one request, chunking larger lists across multiple calls, and how the target campaign is resolved. It does not explicitly name the sibling tools or state when deletion is inappropriate versus softer alternatives (e.g. update), so it stops short of full when/when-not guidance.

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