Welcome to our new Vignette ID Developer Portal documentation!
Vignette ID API Documentation
Wiki

MCP Server

The MCP (Model Context Protocol) Server is a smart way to connect your Large Language Models (LLMs) with our e-vignette API. This allows you to automate the process of purchasing vignettes based on user requests.

  1. Add MCP Server

    You can use OpenAI playground or another tool – Add MCP Server

    MCP Server URL
    https://sandbox-api.vignette.id/mcp

    API Key

    You can find your API key in the Partner Panel -> For Developers section. Make sure to use the SANDBOX key for testing purposes.

    Add MCP Server Add MCP Server

  2. Define Instructions for your Agent

    You can define specific instructions for your agent to ensure it understands how to interact with the e-vignette API effectively. Here are some example instructions you can use:

    Code
    You are an expert in purchasing vignettes for various countries. Your task is to assist users in selecting and purchasing the appropriate vignette based on their vehicle type, country of travel, and duration of stay. 

When a user requests a vignette, follow these steps:

1. Ask for the user's vehicle type (e.g., car, van, moto).
2. Ask for the country where the vignette is needed.
3. Ask for the duration of stay (e.g., 10 days, 1 month).
4. Use the e-vignette API to find the appropriate vignette based on the provided information.
5. Validate the vehicle plate using the validate_vehicle tool.
6. Create the order using the create_order tool.
7. Provide the user with a summary of their order, including the total cost and payment link if applicable.

Ensure that you handle any errors gracefully and provide clear instructions to the user throughout the process.

  3. Available MCP Tools

    The following tools are available through the MCP Server:

    ToolDescriptionUse case
    get_productsGet available vignettes, tunnels, and bridgesBrowse catalog by country, type, vehicle
    get_products_statusCheck provider statusVerify if a country provider is online
    get_usersList partner usersView all users created through your integration
    get_user_ordersGet orders for a specific userView order history for a user by ID
    validate_vehicleValidate vehicle plate numberCheck plate format before creating order
    create_orderCreate a new vignette orderPurchase a vignette for a vehicle
    get_ordersList all ordersView order history
    get_orderGet a specific order by IDCheck order details
    get_order_statusCheck order statusTrack order progress (PENDING → ACTIVE)
    cancel_pending_orderCancel a pending orderCancel before activation
    cancel_deferred_orderCancel a deferred orderCancel a future-dated order

  4. Example Agent Flow

    A typical vignette purchase flow through the MCP Server:

    Code
    User: "I need a 10-day vignette for Hungary for my car with plate W-12345X"

Agent flow:
1. get_products(country=hu, type=vignette)     → find matching product
2. validate_vehicle(plate=W-12345X, country=at) → validate plate format  
3. create_order(product, vehicle, user data)     → create the order
4. get_order_status(order_id)                    → confirm order status

    Sandbox vs Production

    Use https://sandbox-api.vignette.id/mcp for testing. Switch to https://api.vignette.id/mcp for production orders.

Last modified on
Flexible Servicellms.txt