Skip to main content
Glama

Create invitation link

create_invitation
Destructive

Generate an invitation link for a Circle community, with optional paywall, tags, access groups, and redirect space. Requires confirm=true before changing community state.

Instructions

Create 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.
member_tag_idsNoMember tag IDs to apply when the link is used
access_group_idsNoAccess group IDs to attach. Presence, including an empty array, selects access-group mode
redirect_space_idNoID of the space to open after signup

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changedv3.0.1
    • addedInput schema / $defs
      Added value: +{
      +  "paywall": {
      +    "description": "Optional 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: -"Optional 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: -"Optional 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

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, destructiveHint=true and idempotentHint=false, so the safety profile is covered. The description adds value beyond that by disclosing the confirm=true gating requirement and that community state changes, which are operational details the annotations do not express.

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 the purpose front-loaded and no filler. It is efficient, though it stops short of adding the operational detail a 9-parameter nested mutation tool would benefit from.

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 mutating tool with 9 parameters, nested objects and multiple mutually exclusive body-input modes (payload, payload_file, body flags), the description is thin. It covers the confirm gate but says nothing about the body-mode selection constraints documented only in the schema, and there is no output schema to compensate.

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 89%, so the schema already documents name, account, confirm, payload and the paywall/nested fields thoroughly. The description's only parameter-related content (confirm=true) duplicates the schema's own confirm description, so it adds little beyond the structured data. 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?

The description states a specific verb+resource ("Create invitation link"), making it distinguishable from siblings like update_invitation_link, revoke_invitation_link and list_invitations. It does not, however, explicitly name an alternative or scope constraint for differentiation.

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?

It gives one operational condition (confirm=true must be set when the user asked for exactly this action), which implies when the tool is appropriate. But there is no guidance on when to prefer this over update_invitation_link or revoke_invitation_link, leaving alternative selection to inference.

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