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.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds meaningful behavioral context: co-hosts can read it, and it returns payment/publication status and credits needed to publish. It could mention potential errors or response format, but the output schema covers that. No contradictions with annotations.

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?

The description is a single long sentence but is front-loaded with the primary purpose and then packed with useful routing and usage context. It avoids fluff and every clause adds value. Slightly verbose but not redundant.

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?

Given the tool has an output schema and annotations, the description need not repeat return details. It covers when to use, what it returns, how to obtain the parameter, and how it relates to sibling tools. Nothing essential is missing for an agent to invoke it correctly.

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% and the parameter description already clarifies that event_id is not a guest invitation_id or RSVP URL. The description adds cross-tool guidance ('Get event_id from lemonvite_list_invitations') which aids retrieval. While not strictly necessary, this additional context earns above the baseline 3.

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?

The description clearly states the tool retrieves the full current state of a Lemonvite invitation, enumerating specific fields (details, publication/payment status, credits, guest/RSVP counts, custom fields, guest settings). It also distinguishes itself from sibling tools by specifying what it is not (e.g., not for guest responses or RSVP summaries). This is a specific verb+resource with strong sibling differentiation.

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?

It explicitly instructs when to use this tool ('Use this when the user wants the full current state'), provides an alternative for obtaining event_id, and gives clear exclusions: use lemonvite_list_guests for per-guest responses, lemonvite_get_rsvp_summary for counts alone, and check payment_status here before calling lemonvite_publish_invitation. This is thorough and leaves no ambiguity about routing.

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