Skip to main content
Glama

Publish an invitation

lemonvite_publish_invitation
DestructiveIdempotent

Use this when the user explicitly wants their Lemonvite invitation made live. It opens the RSVP page to guests and DELIVERS the invitation to every guest with a pending email or phone invitation, so it contacts people outside this conversation: call it only when the user's intent to go live and send is clear, never merely because a draft exists. Before calling, read payment_status, required_credits and publishing_price with lemonvite_get_invitation. Publishing uses 1 credit plus one per extra phone batch; explain any extra charge and pass authorized_credits only after the host agrees. If payment_status is payment_required: Use lemonvite_start_checkout with event_id to create a payment link for the host, then publish. Only the event's primary host can publish; a co-host gets an error. Cancelled events cannot be published. Calling it on an already-published invitation is a safe no-op.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
event_idYesLemonvite event_id returned by lemonvite_create_invitation or lemonvite_list_invitations. Identifies the event to act on; not a guest invitation_id or RSVP URL.
authorized_creditsNoMaximum credits the host has agreed to use after reviewing required_credits.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
warningsNo
invitationYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • changedInput schema / properties / authorized_credits / description
      Previous value: -"Maximum credits the host has agreed to spend after reviewing the price."New value: +"Maximum credits the host has agreed to use after reviewing required_credits."
    • changedOutput schema / properties / invitation / properties / payment_status / description
      Previous value: -"paid = this event is already covered; credit_available = balance covers all required publishing and phone credits; payment_required = start_checkout first; not_applicable = cancelled, do not buy credits or publish. Always reflects the PRIMARY host's account — the one publishing charges."New value: +"paid = this event is already covered; credit_available = balance covers all required publishing and phone credits; payment_required = the account's credits do not cover publishing; not_applicable = cancelled, cannot be published. Always reflects the PRIMARY host's account — the one whose credits publishing uses."
    • changedOutput schema / properties / invitation / properties / phone_guest_allowance / description
      Previous value: -"Included or already purchased phone guests; null = no phone cap."New value: +"Phone guests this event already allows; null = no phone cap."
  2. Changed11 schema fields changed
    • addedInput schema / properties / authorized_credits
      Added value: +{
      +  "default": 1,
      +  "description": "Maximum credits the host has agreed to spend after reviewing the price.",
      +  "maximum": 9007199254740991,
      +  "minimum": 1,
      +  "type": "integer"
      +}
    • changedOutput schema / properties / invitation / properties / can_publish / description
      Previous value: -"True when this account is the event's primary host — the only account that can publish it or pay for it. Co-hosts can edit the invitation and manage guests, but must ask the primary host to publish."New value: +"True when this account is the event's primary host and the event is not cancelled. Co-hosts can edit the invitation and manage guests, but must ask the primary host to publish."
    • addedOutput schema / properties / invitation / properties / guest_limit
      Added value: +{
      +  "description": "Total cap; only support can raise it. null = verified host.",
      +  "type": [
      +    "number",
      +    "null"
      +  ]
      +}
    • changedOutput schema / properties / invitation / properties / payment_status / description
      Previous value: -"paid = this event is already covered; credit_available = publish will consume an existing credit; payment_required = start_checkout first. Always reflects the PRIMARY host's account — the one publishing charges."New value: +"paid = this event is already covered; credit_available = balance covers all required publishing and phone credits; payment_required = start_checkout first; not_applicable = cancelled, do not buy credits or publish. Always reflects the PRIMARY host's account — the one publishing charges."
    • changedOutput schema / properties / invitation / properties / payment_status / enum
      Previous value: -[
      -  "paid",
      -  "credit_available",
      -  "payment_required"
      -]New value: +[
      +  "paid",
      +  "credit_available",
      +  "payment_required",
      +  "not_applicable"
      +]
    • addedOutput schema / properties / invitation / properties / phone_batch_size
      Added value: +{
      +  "type": [
      +    "number",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / invitation / properties / phone_guest_allowance
      Added value: +{
      +  "description": "Included or already purchased phone guests; null = no phone cap.",
      +  "type": [
      +    "number",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / invitation / properties / phone_guest_count
      Added value: +{
      +  "type": "number"
      +}
    • addedOutput schema / properties / invitation / properties / publishing_price
      Added value: +{
      +  "anyOf": [
      +    {
      +      "additionalProperties": false,
      +      "properties": {
      +        "amount_due": {
      +          "type": "number"
      +        },
      +        "credits_to_buy": {
      +          "type": "number"
      +        },
      +        "existing_credits": {
      +          "type": "number"
      +        },
      +        "phone_batch_count": {
      +          "type": "number"
      +        },
      +        "phone_batch_price": {
      +          "type": "number"
      +        },
      +        "publish_price": {
      +          "type": "number"
      +        },
      +        "total_price": {
      +          "type": "number"
      +        }
      +      },
      +      "required": [
      +        "publish_price",
      +        "phone_batch_count",
      +        "phone_batch_price",
      +        "total_price",
      +        "existing_credits",
      +        "credits_to_buy",
      +        "amount_due"
      +      ],
      +      "type": "object"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • addedOutput schema / properties / invitation / properties / required_credits
      Added value: +{
      +  "description": "Publishing plus phone batches. Review with the host before authorizing this many credits.",
      +  "type": [
      +    "number",
      +    "null"
      +  ]
      +}
    • changedOutput schema / properties / invitation / required
      Previous value: -[
      -  "event_id",
      -  "publish_status",
      -  "payment_status",
      -  "can_publish",
      -  "title",
      -  "event_type",
      -  "description",
      -  "start_datetime",
      -  "end_datetime",
      -  "timezone",
      -  "location",
      -  "host_name",
      -  "rsvp_deadline",
      -  "image_url",
      -  "has_invitation_image",
      -  "price_display",
      -  "guest_count",
      -  "rsvp_summary",
      -  "public_rsvp_url",
      -  "manage_url",
      -  "custom_fields",
      -  "guest_settings"
      -]New value: +[
      +  "event_id",
      +  "publish_status",
      +  "payment_status",
      +  "can_publish",
      +  "title",
      +  "event_type",
      +  "description",
      +  "start_datetime",
      +  "end_datetime",
      +  "timezone",
      +  "location",
      +  "host_name",
      +  "rsvp_deadline",
      +  "image_url",
      +  "has_invitation_image",
      +  "price_display",
      +  "guest_count",
      +  "phone_guest_count",
      +  "guest_limit",
      +  "phone_guest_allowance",
      +  "phone_batch_size",
      +  "required_credits",
      +  "publishing_price",
      +  "rsvp_summary",
      +  "public_rsvp_url",
      +  "manage_url",
      +  "custom_fields",
      +  "guest_settings"
      +]
  3. Changed1 schema field changed
    • addedInput schema / properties / event_id / description
      Added value: +"Lemonvite event_id returned by lemonvite_create_invitation or lemonvite_list_invitations. Identifies the event to act on; not a guest invitation_id or RSVP URL."
  4. Changed2 schema fields changed
    • addedOutput schema / properties / invitation / properties / custom_fields
      Added value: +{
      +  "description": "The host's custom fields, in display order: `info` details shown on the invitation (gift registry, dress code) and `question` inputs on the RSVP form (dietary restrictions, meal choice). Change them with custom_fields on lemonvite_update_invitation.",
      +  "items": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "field_id": {
      +        "type": "string"
      +      },
      +      "input_type": {
      +        "anyOf": [
      +          {
      +            "enum": [
      +              "text",
      +              "select"
      +            ],
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "description": "question fields only."
      +      },
      +      "kind": {
      +        "enum": [
      +          "info",
      +          "question"
      +        ],
      +        "type": "string"
      +      },
      +      "label": {
      +        "type": "string"
      +      },
      +      "options": {
      +        "anyOf": [
      +          {
      +            "items": {
      +              "type": "string"
      +            },
      +            "type": "array"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "description": "select questions only: the choices offered."
      +      },
      +      "required": {
      +        "description": "question fields only: must be answered by a guest who says yes or maybe.",
      +        "type": "boolean"
      +      },
      +      "value": {
      +        "description": "info fields only: the text shown on the invitation (may contain a URL).",
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      }
      +    },
      +    "required": [
      +      "field_id",
      +      "kind",
      +      "label",
      +      "value",
      +      "input_type",
      +      "options",
      +      "required"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • changedOutput schema / properties / invitation / required
      Previous value: -[
      -  "event_id",
      -  "publish_status",
      -  "payment_status",
      -  "can_publish",
      -  "title",
      -  "event_type",
      -  "description",
      -  "start_datetime",
      -  "end_datetime",
      -  "timezone",
      -  "location",
      -  "host_name",
      -  "rsvp_deadline",
      -  "image_url",
      -  "has_invitation_image",
      -  "price_display",
      -  "guest_count",
      -  "rsvp_summary",
      -  "public_rsvp_url",
      -  "manage_url",
      -  "guest_settings"
      -]New value: +[
      +  "event_id",
      +  "publish_status",
      +  "payment_status",
      +  "can_publish",
      +  "title",
      +  "event_type",
      +  "description",
      +  "start_datetime",
      +  "end_datetime",
      +  "timezone",
      +  "location",
      +  "host_name",
      +  "rsvp_deadline",
      +  "image_url",
      +  "has_invitation_image",
      +  "price_display",
      +  "guest_count",
      +  "rsvp_summary",
      +  "public_rsvp_url",
      +  "manage_url",
      +  "custom_fields",
      +  "guest_settings"
      +]
  5. First observed

TDQS

A4.8/5.0
Behavior5/5

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

With annotations already flagging destructive/openWorld/idempotent, the description still adds substantial context: it contacts people outside the conversation, costs 1 credit plus one per phone batch, requires host authorization before charges, errors for co-hosts, blocks cancelled events, and is a safe no-op when already published. This exceeds the annotation baseline considerably.

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?

Long but well-organized and front-loaded with the trigger condition and its most important caveat. The payment paragraph is dense, but for a high-stakes outbound-and-billing operation nearly every sentence earns its place.

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

Completeness5/5

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

An output schema exists so return values needn't be explained, and the description fully covers the tool's complexity: triggers, payment flow, credit cost, permissions, and edge cases (co-host, cancelled, already-published). Nothing an agent needs to call it correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% (baseline 3), and the description adds genuine meaning: it explains authorized_credits should be passed only after the host agrees and describes the credit mechanics (1 credit + one per extra phone batch) that the schema's terse note does not fully convey.

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

Purpose5/5

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

States a specific verb and resource ('invitation made live') and, crucially, describes the actual effect: it opens the RSVP page and delivers the invitation to every pending guest. This lets an agent distinguish it from siblings like lemonvite_update_invitation or lemonvite_create_invitation without opening schemas.

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

Usage Guidelines5/5

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

Explicit when-to-use ('when the user explicitly wants their invitation made live'), when-not ('never merely because a draft exists'), and a named alternative for a blocker case (payment_required → lemonvite_start_checkout). It also states prerequisites (read payment_status/required_credits via get_invitation) and constraints (primary host only).

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