Skip to main content
Glama

set_sales_payment_link_active

DestructiveIdempotent

Pause or resume accepting payments through an existing payment link.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "id": "<id>",
      "active": "<active>"
    },
    "name": "set_sales_payment_link_active"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes
activeYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=true, idempotentHint=true, and openWorldHint=false, so the safety profile is covered structurally. The description adds useful semantics beyond that — that the operation is a reversible-sounding pause/resume toggle on an existing link — but says nothing about what pausing actually does to existing payments, in-flight checkouts, or the link URL, which matters for a tool flagged destructive.

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?

A single front-loaded sentence with no filler or repetition. It is efficient, though its brevity is partly the source of the definition's gaps rather than a sign of tight authoring.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutating tool flagged destructiveHint=true, with two undocumented parameters (0% schema coverage) and no output schema, the description leaves key questions unanswered: what pausing does to existing payment flows, whether resuming restores the original URL, and what the boolean polarity means. Annotations cover idempotency and destructiveness, but the description does not fill the remaining behavioral gap.

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 0%, so the description must carry the parameter burden, and it partially does: 'existing payment link' maps to 'id' and 'pause or resume' maps to the 'active' boolean polarity. It never states explicitly which boolean value means paused versus resumed, nor any format or constraint on the id string.

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?

The description gives a specific verb pair ('pause or resume') and resource ('accepting payments through an existing payment link'), so an agent immediately knows this toggles the payment acceptance state of an existing link rather than creating one. It falls short of a 5 only because it does not explicitly name the sibling it differs from (create_sales_payment_link).

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?

The word 'existing' implies this applies only to already-created links, implicitly distinguishing it from create_sales_payment_link. However, there is no explicit when-to-use versus alternatives, no stated prerequisites (permissions, link status), and no indication of when pausing is inappropriate (e.g., links with active subscriptions).

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.

Resources