Skip to main content
Glama

Get invitation details

lemonvite_get_invitation
Read-only

Use this when the user wants the full current state of one Lemonvite invitation: its details, publication and payment status, credits needed to publish, guest and RSVP counts, custom fields and guest settings. Co-hosts can read it too. Get event_id from lemonvite_list_invitations. Check payment_status here before calling lemonvite_publish_invitation. For each guest's response use lemonvite_list_guests instead, and for RSVP counts alone use lemonvite_get_rsvp_summary.

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.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
warningsNo
invitationYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • 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. Changed10 schema fields changed
    • 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.5/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnlyHint=true, destructiveHint=false, openWorldHint=false), so the bar is lower. The description still adds value by disclosing that co-hosts may read the invitation and by scoping exactly which fields are returned. It does not discuss rate limits or freshness of the data, so it falls short of a 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the trigger condition ('Use this when...'), followed by permission context and then three routing sentences. Every sentence either defines scope, clarifies access, or redirects to an alternative — nothing is filler.

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 need not be detailed, and the description still previews them. With a single fully-documented required parameter, complete annotations, and explicit sibling routing, an agent has everything needed to select and invoke this correctly.

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 the schema already explains that event_id comes from create/list and is not a guest invitation_id or RSVP URL. The description's 'get event_id from lemonvite_list_invitations' partially repeats that. Baseline 3 applies when the schema does the heavy lifting.

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 read operation on a single named resource and enumerates the exact payload contents (publication/payment status, credits needed, guest and RSVP counts, custom fields, guest settings). This is clearly distinguishable from sibling read tools like get_rsvp_summary and list_guests.

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?

Explicitly routes the agent: get event_id from lemonvite_list_invitations, check payment_status here before lemonvite_publish_invitation, and use lemonvite_list_guests or lemonvite_get_rsvp_summary for guest-level or count-only needs. Both when-to-use and when-to-use-something-else are stated.

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