Skip to main content
Glama

Cancel Community Member Subscription

cancel_community_member_subscription
Destructive

Cancel a community member's subscription by ID, with immediate or period-end timing and optional refund. Requires confirm=true to proceed.

Instructions

Cancel Community Member Subscription. Changes community state and requires confirm=true for the user-requested action.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
accountNoNamed private Circle account; selects credentials, not a remote community ID.
confirmNoSet true only when the user asked for exactly this action.
ends_atNoCancellation timing: 'now' or 'at_period_end'.
payloadNoComplete JSON request body instead of body flags. Supports nested Tiptap, maps and nullable values.
refund_typeNoOptional refund type when canceling immediately: 'prorated' or 'full'.
payload_fileNoRegular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload.
subscription_idYesCommunity Member Subscription ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv3.0.1
    • changedInput schema / properties / confirm / description
      Previous value: -"Must be true for the specific user-requested write."New value: +"Set true only when the user asked for exactly this action."
  2. First observedv2.0.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true, readOnlyHint=false, and idempotentHint=false, so the safety profile is known. The description adds that it 'changes community state' and imposes a confirm gate, but says nothing about reversibility, whether cancellation is immediate vs period-end, or refund implications.

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 followed by the key constraint. The first sentence restates the title, which is mildly redundant but not wasteful.

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

Completeness3/5

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

For a destructive mutation with no output schema, the description covers the confirm gate but omits the meaningful behavioral choices (ends_at 'now' vs 'at_period_end', refund_type) that the schema documents. Adequate but leaves the agent to rely entirely on structured fields for operational nuance.

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 all seven parameters (including nested payload and payload_file) are documented in the schema. The description only echoes the confirm requirement, adding no meaning beyond the schema, so the baseline 3 applies.

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?

States a specific verb (Cancel) and resource (Community Member Subscription) that an agent can distinguish from the sibling resume_community_member_subscription. Clear, though it does not explicitly name the counterpart operation.

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?

Provides a precondition ('requires confirm=true for the user-requested action') which implies usage, but gives no explicit when-to-use vs when-not, nor does it point to resume_community_member_subscription as the alternative.

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