GrowSurf MCP Server

Official

by growsurf

Overview Schema Source Related Servers Discussions Admin

TypeScript

Hybrid

Record Affiliate Refund or Chargeback

growsurf_refund_transaction

DestructiveIdempotent

Record a refund, partial refund, or chargeback for a previously recorded GrowSurf affiliate transaction. Adjust the referrer's commission without processing a payment provider refund.

Instructions

Record a refund, partial refund, or chargeback for a previously recorded affiliate transaction in GrowSurf and reverse or adjust the referrer's commission. This records the amendment without sending a refund through the payment provider. Requires the same transaction identifier as the original sale. Omitted amountRefunded means a full refund. Already-paid commissions are not clawed back and are recorded for tax only. Targets campaignId if supplied, otherwise GROWSURF_CAMPAIGN_ID.

Input Schema

TableJSON Schema

Name	Required	Description
`amount`	No
`orderId`	No
`chargeId`	No
`currency`	No
`refundId`	No	Stable per-refund identifier. Required when canceling a refund or changing the refunded total after a cancellation. Reuse the original refund's identifier for its cancellation. An amendment without enough refund identity returns `409` without applying the cancellation. Newly observed higher cumulative refunds and incomplete coverage are retained for reconciliation.
`testMode`	No	Original payment mode: `true` for test or `false` for live. Requires `paymentProvider`.
`invoiceId`	No
`paymentId`	No
`campaignId`	No	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.
`externalId`	No
`description`	No
`refundAmount`	No	Positive amount for this individual refund, no greater than the sale amount, in the sale currency's minor unit. Send it with `refundId` on each original refund to support cancellations and out-of-order amendments. The amount for a given `refundId` cannot change. A cancellation can omit it when the original amount is already recorded. Incomplete refund history returns `409` without applying the cancellation. Newly observed higher cumulative refunds and incomplete coverage are retained for reconciliation.
`refundStatus`	No
`amendmentType`	No
`participantId`	No
`transactionId`	No
`amountRefunded`	No
`paymentIntentId`	No
`paymentProvider`	No	Connected provider for the original payment. Requires its `transactionId` and `testMode`. This amends GrowSurf records without sending a refund through the provider.
`participantEmail`	No
`refundHistoryComplete`	No	Set true only after reconciling and recording every original refundId and refundAmount, including refunds later canceled. This confirmation resolves previously incomplete history. Omit during ordinary delivery. Replaying an old confirmation cannot resolve a later gap; confirm a newly reconciled refund or complete provider list.

Output Schema

TableJSON Schema

Name	Required	Description
`deleted`	No	Pending commissions deleted by the amendment.
`matched`	No	Commissions found for the provided identifiers.
`message`	No	Human-readable result message.
`success`	No	`true` when the amendment was processed; `false` when no matching transaction was found.
`adjusted`	No	Commissions partially adjusted.
`notFound`	No	Present and `true` when no commission matched the provided identifiers.
`reversed`	No	Commissions reversed (set to zero amount).
`amendmentType`	No	Amendment type that was processed.
`matchingCommissionIds`	No	Commission ids that matched the submitted identifiers.

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv0.19.9Oct 3, 2026

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."

Changed6 schema fields changedv0.14.0Sep 10, 2026

changedInput schema / allOf

Previous value: -[
-  {
-    "anyOf": [
-      {
-        "required": [
-          "participantId"
-        ]
-      },
-      {
-        "required": [
-          "participantEmail"
-        ]
-      }
-    ]
-  },
-  {
-    "anyOf": [
-      {
-        "required": [
-          "externalId"
-        ]
-      },
-      {
-        "required": [
-          "transactionId"
-        ]
-      },
-      {
-        "required": [
-          "orderId"
-        ]
-      },
-      {
-        "required": [
-          "paymentId"
-        ]
-      },
-      {
-        "required": [
-          "invoiceId"
-        ]
-      },
-      {
-        "required": [
-          "paymentIntentId"
-        ]
-      },
-      {
-        "required": [
-          "chargeId"
-        ]
-      }
-    ]
-  }
-]New value: +[
+  {
+    "anyOf": [
+      {
+        "required": [
+          "participantId"
+        ]
+      },
+      {
+        "required": [
+          "participantEmail"
+        ]
+      }
+    ]
+  },
+  {
+    "anyOf": [
+      {
+        "required": [
+          "externalId"
+        ]
+      },
+      {
+        "required": [
+          "transactionId"
+        ]
+      },
+      {
+        "required": [
+          "orderId"
+        ]
+      },
+      {
+        "required": [
+          "paymentId"
+        ]
+      },
+      {
+        "required": [
+          "invoiceId"
+        ]
+      },
+      {
+        "required": [
+          "paymentIntentId"
+        ]
+      },
+      {
+        "required": [
+          "chargeId"
+        ]
+      }
+    ]
+  },
+  {
+    "if": {
+      "required": [
+        "paymentProvider"
+      ]
+    },
+    "then": {
+      "required": [
+        "testMode",
+        "transactionId"
+      ]
+    }
+  },
+  {
+    "if": {
+      "not": {
+        "required": [
+          "paymentProvider"
+        ]
+      }
+    },
+    "then": {
+      "not": {
+        "required": [
+          "testMode"
+        ]
+      }
+    }
+  }
+]

addedInput schema / properties / paymentProvider

Added value: +{
+  "description": "Connected provider for the original payment. Requires its `transactionId` and `testMode`. This amends GrowSurf records without sending a refund through the provider.",
+  "enum": [
+    "stripe",
+    "chargebee",
+    "recurly"
+  ],
+  "type": "string"
+}

addedInput schema / properties / refundAmount / description

Added value: +"Positive amount for this individual refund, no greater than the sale amount, in the sale currency's minor unit. Send it with `refundId` on each original refund to support cancellations and out-of-order amendments. The amount for a given `refundId` cannot change. A cancellation can omit it when the original amount is already recorded. Incomplete refund history returns `409` without applying the cancellation. Newly observed higher cumulative refunds and incomplete coverage are retained for reconciliation."

addedInput schema / properties / refundHistoryComplete

Added value: +{
+  "description": "Set true only after reconciling and recording every original refundId and refundAmount, including refunds later canceled. This confirmation resolves previously incomplete history. Omit during ordinary delivery. Replaying an old confirmation cannot resolve a later gap; confirm a newly reconciled refund or complete provider list.",
+  "type": "boolean"
+}

addedInput schema / properties / refundId / description

Added value: +"Stable per-refund identifier. Required when canceling a refund or changing the refunded total after a cancellation. Reuse the original refund's identifier for its cancellation. An amendment without enough refund identity returns `409` without applying the cancellation. Newly observed higher cumulative refunds and incomplete coverage are retained for reconciliation."

addedInput schema / properties / testMode

Added value: +{
+  "description": "Original payment mode: `true` for test or `false` for live. Requires `paymentProvider`.",
+  "type": "boolean"
+}

First observedv0.12.2Aug 25, 2026

TDQS

A4.1/5.0

Behavior4/5

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

Annotations already declare destructiveHint=true, idempotentHint=true, and openWorldHint=true, so the safety profile is covered. The description adds genuinely non-derived behavior: already-paid commissions are not clawed back (tax-only recording), omitted amountRefunded implies a full refund, and no money moves through the provider. This meaningfully exceeds what the annotations 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?

Six sentences, front-loaded with the core action, then the provider caveat, prerequisite, and default behaviors. Each sentence carries distinct information; no redundant restatement of the title, though it is on the longer side.

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?

An output schema exists so return values need not be explained. Given the conditional schema and 21 parameters, the description covers the critical prerequisites and default behaviors well, though it does not touch on the error states (e.g. 409 handling) that live in the schema property descriptions.

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 low (29%) across 21 parameters, so the description is expected to compensate but only covers a few: amountRefunded default semantics, the transaction-identifier requirement, and the campaignId fallback. The remaining parameters either carry their own schema descriptions (refundId, refundAmount, refundHistoryComplete) or are undocumented in both places.

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 ('Record a refund, partial refund, or chargeback') and resource ('a previously recorded affiliate transaction in GrowSurf') with the downstream effect ('reverse or adjust the referrer's commission'). An agent can distinguish this from the sibling growsurf_record_sale 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 Guidelines4/5

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

Gives the key prerequisite ('Requires the same transaction identifier as the original sale') and clarifies the operating context ('without sending a refund through the payment provider'), which tells the agent this is a record-only amendment. It does not explicitly name alternatives or state when *not* to use it, but the context is clear.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server