Skip to main content
Glama

Update a campaign

rewardful_update_campaign
Destructive

Change a campaign's name, URL, visibility, reward rule, payout minimum or coupon. Only the fields you pass change. Rewardful: PUT /v1/campaigns/:id.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlNoBase URL used to build affiliate links, e.g. https://example.com.
nameNoThe campaign's name.
privateNotrue = invite-only; false = anyone can sign up.
campaign_idYesThe campaign's id (UUID).
reward_typeNoPercent of each sale, or a fixed amount.
stripe_coupon_idNoStripe coupon for double-sided incentives. Growth/Enterprise plans only.
commission_percentNoCommission percentage. Required when reward_type is percent.
minimum_payout_centsNoMinimum cumulative commissions before a payout, in cents of the company's display currency.
commission_amount_centsNoFixed commission in cents. Required when reward_type is amount.
commission_amount_currencyNoISO currency code of the fixed commission, e.g. USD. Required when reward_type is amount.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

The destructiveHint annotation already flags this as a mutating operation, so the bar is lower. The description usefully clarifies that it is a partial update rather than a full overwrite, but says nothing about reversibility, permission/plan requirements, or what happens to fields left unset beyond that one clause.

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?

Two short sentences, front-loaded with the action and field scope, followed by a compact endpoint reference. Nothing is padded, though the 'Rewardful: PUT /v1/campaigns/:id' line is informational rather than decision-relevant.

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 mutation tool with 10 schema-documented parameters, a destructive annotation and no output schema, the description covers the essential action and partial-update behavior. Side effects on downstream artifacts (affiliate links, coupons) and the response shape are unspecified, but the structured fields carry most of the remaining burden.

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 description coverage is 100% and every parameter (including the conditional 'required when reward_type is X' rules) is documented in the schema itself. The description's field list merely restates a subset of those names, adding no format, unit, or constraint detail beyond what the schema provides.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Clear specific verb+resource ('Change a campaign's...') with an explicit enumeration of the mutable fields (name, URL, visibility, reward rule, payout minimum, coupon). The verb alone separates it from rewardful_create_campaign, rewardful_get_campaign and rewardful_list_campaigns, though no sibling is named outright.

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?

'Only the fields you pass change' communicates partial-update semantics, which tells the agent it need not supply all ten parameters. However there is no guidance on when to prefer this over create_campaign or update_affiliate, and no stated prerequisites (e.g. the Growth/Enterprise requirement that only appears in the schema).

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.