Model Context Protocol (MCP)

The Vignetim Partner API provides a full Model Context Protocol (MCP) server, enabling your AI assistant to directly interact with the API β€” browse products, create orders, manage webhooks, and search documentation β€” all without leaving your IDE.

What is MCP?

MCP is an open protocol that standardizes how AI applications connect to external tools and data sources. With Vignetim's MCP server, your AI coding assistant becomes a Vignetim API client.

Capabilities

CategoryToolsAuth Required
Productslist_tickets, get_ticket, list_esim_packages, list_insurance_products, get_insurance_product, list_vehicle_categories, list_vehicle_categories_by_type, list_geo_checkpointsYes
Orderscreate_order, list_orders, get_order, get_order_documents, get_order_statusYes
Webhookscreate_webhook, list_webhooks, update_webhook, delete_webhook, test_webhookYes
Walletget_wallet_balanceYes
Documentationlist_docs, get_doc, search_docs, get_openapi_specNo

MCP Endpoint

text
https://vignetim.com/api/mcp

Authentication

API operation tools require your Partner API credentials via HTTP headers:

HeaderDescription
X-API-KeyYour organization API key
X-API-SecretYour organization API secret
X-EnvironmentOptional. production (default) or staging β€” see below

Sandbox vs live mode is determined by the API key itself: vgn_test_ keys run in sandbox mode with simulated payments, vgn_live_ keys run against live data.

Which deployment the call reaches is a separate thing. API keys live in the database of the deployment that issued them, so a key created in the staging dashboard only authenticates against the staging API. Send X-Environment: staging for those keys:

bash
claude mcp add vignetim-staging --transport http https://vignetim.com/api/mcp \
  --header "X-API-Key: YOUR_STAGING_KEY" \
  --header "X-API-Secret: YOUR_STAGING_SECRET" \
  --header "X-Environment: staging"

A staging.vignetim.com/api/mcp endpoint also exists and serves the same tools; the header works from either host, so there is no need to switch hosts. Omitting the header with a staging-issued key returns 401 Authentication failed, because the call is made against production.

Documentation tools (list_docs, get_doc, search_docs, get_openapi_spec) work without authentication.

How It Works

  1. Your AI assistant connects to https://vignetim.com/api/mcp
  2. It discovers available tools (products, orders, webhooks, docs)
  3. When you ask "list Austrian vignettes", the assistant calls list_tickets with countryIsocode: "AT"
  4. The MCP server signs the request with HMAC-SHA256 and proxies it to the Partner API
  5. Results are returned directly to your assistant

The MCP server handles all authentication complexity β€” HMAC signing, timestamps, nonces β€” so your AI agent just calls tools with simple parameters.

Platform Support

PlatformTransportSetup Guide
Claude CodeStreamable HTTPVignetim Claude MCP β†’
Claude DesktopStreamable HTTPVignetim Claude MCP β†’
CursorStreamable HTTPVignetim OpenAI MCP β†’
WindsurfStreamable HTTPVignetim OpenAI MCP β†’
OpenAI Agents SDKStreamable HTTPVignetim OpenAI MCP β†’
ContinueStreamable HTTPVignetim OpenAI MCP β†’

Additional Resources

  • OpenAPI Spec: https://vignetim.com/api/partner-openapi
  • LLMs.txt: https://vignetim.com/llms.txt
  • AI Plugin: https://vignetim.com/.well-known/ai-plugin.json