Skip to main content
Glama

Update invitation link

update_invitation_link
Destructive

Modify an existing invitation link's settings for a Circle community, including name, paywall, member tags, access groups, and redirect space. Requires confirm=true to proceed.

Instructions

Update invitation link. Changes community state and requires confirm=true for the user-requested action.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoName for the invitation link
accountNoNamed private Circle account; selects credentials, not a remote community ID.
confirmNoSet true only when the user asked for exactly this action.
payloadNoComplete JSON request body instead of body flags. Supports nested Tiptap, maps and nullable values.
paywallNo
payload_fileNoRegular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload.
invitation_idYesInvitation link ID
member_tag_idsNoMember tag IDs to apply when the link is used
access_group_idsNoAccess group IDs to attach; fully replaces the current set (empty array detaches all)
redirect_space_idNoID of the space to open after signup. Set to null to remove the existing redirect

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changedv3.0.1
    • addedInput schema / $defs
      Added value: +{
      +  "paywall": {
      +    "description": "Paywall configuration. Set to null to remove the existing paywall configuration",
      +    "properties": {
      +      "paywall_coupon_code": {
      +        "description": "Optional coupon code for the paywall trial",
      +        "type": "string"
      +      },
      +      "paywall_id": {
      +        "description": "Paywall ID; requires paywall_price_id and paywall_trial_days",
      +        "type": "integer"
      +      },
      +      "paywall_price_id": {
      +        "description": "Eligible recurring paywall price ID",
      +        "type": "integer"
      +      },
      +      "paywall_trial_days": {
      +        "description": "Free trial length in days",
      +        "maximum": 730,
      +        "minimum": 1,
      +        "type": "integer"
      +      }
      +    },
      +    "type": [
      +      "object",
      +      "null"
      +    ]
      +  }
      +}
    • 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."
    • addedInput schema / properties / payload / properties / paywall / $ref
      Added value: +"#/$defs/paywall"
    • removedInput schema / properties / payload / properties / paywall / description
      Removed value: -"Paywall configuration. Set to null to remove the existing paywall configuration"
    • removedInput schema / properties / payload / properties / paywall / properties
      Removed value: -{
      -  "paywall_coupon_code": {
      -    "description": "Optional coupon code for the paywall trial",
      -    "type": "string"
      -  },
      -  "paywall_id": {
      -    "description": "Paywall ID; requires paywall_price_id and paywall_trial_days",
      -    "type": "integer"
      -  },
      -  "paywall_price_id": {
      -    "description": "Eligible recurring paywall price ID",
      -    "type": "integer"
      -  },
      -  "paywall_trial_days": {
      -    "description": "Free trial length in days",
      -    "maximum": 730,
      -    "minimum": 1,
      -    "type": "integer"
      -  }
      -}
    • removedInput schema / properties / payload / properties / paywall / type
      Removed value: -[
      -  "object",
      -  "null"
      -]
    • addedInput schema / properties / paywall / $ref
      Added value: +"#/$defs/paywall"
    • removedInput schema / properties / paywall / description
      Removed value: -"Paywall configuration. Set to null to remove the existing paywall configuration"
    • removedInput schema / properties / paywall / properties
      Removed value: -{
      -  "paywall_coupon_code": {
      -    "description": "Optional coupon code for the paywall trial",
      -    "type": "string"
      -  },
      -  "paywall_id": {
      -    "description": "Paywall ID; requires paywall_price_id and paywall_trial_days",
      -    "type": "integer"
      -  },
      -  "paywall_price_id": {
      -    "description": "Eligible recurring paywall price ID",
      -    "type": "integer"
      -  },
      -  "paywall_trial_days": {
      -    "description": "Free trial length in days",
      -    "maximum": 730,
      -    "minimum": 1,
      -    "type": "integer"
      -  }
      -}
    • removedInput schema / properties / paywall / type
      Removed value: -[
      -  "object",
      -  "null"
      -]
  2. First observedv2.0.0

TDQS

C2.8/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=false and openWorldHint=true, so the safety profile is largely covered. The description adds the non-obvious requirement of confirm=true and confirms it mutates community state, but says nothing about which fields get overwritten, whether omitted fields are preserved, or the payload/payload_file/body-flags exclusivity.

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 with no filler, and the state-changing/confirm requirement is front-loaded right after the purpose. It is efficient but under-specified rather than tight-by-design.

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 destructive, non-idempotent mutation with 10 parameters (including nested paywall, tags, access groups, redirect and three mutually exclusive body-passing modes) and no output schema, the description omits too much: overwrite semantics, confirm behavior, and how to choose among payload, payload_file, and body flags.

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 90%, so the schema already documents nearly all 10 parameters in detail, including mutual exclusivity of payload_file and nested paywall semantics. The description contributes no additional parameter meaning, making the baseline 3 appropriate.

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

Purpose3/5

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

The description states a verb (Update) and resource (invitation link), but adds essentially nothing beyond the tool title of the same wording. It never says what aspects of the link are updatable (name, paywall, tags, access groups, redirect) even though those are the core fields, and it does not distinguish itself from close siblings like revoke_invitation_link or delete_invitation_link.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

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

The only guidance is procedural: confirm=true is needed for the user-requested action. There is no statement of when to update versus revoke, delete, or create an invitation, nor any prerequisite or context condition for choosing this tool.

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