ZuploZuplo
LoginStart for Free
  • Documentation
  • API Reference
Getting Started
Concepts
API Management
AI Gateway
MCP Gateway
MCP Server
    Overview
    Getting Started
      ToolsPromptsResourcesTestingTroubleshootingGraphQLCustom ToolsOpenAI Apps SDK
      Guides
      Configuration Migration Guide
    Developer Portal
    Development
    Deploying & Source Control
    Analytics
    Observability
    Networking & Infrastructure
    Account Management
    Programming API
    Build with AI
    Zuplo CLI
    Migration Guides
    Platform LimitsVersion Support PolicySecuritySupportTrust & ComplianceChangelog
    powered by Zuplo
    MCP Server

    Getting Started with MCP Server - Portal

    1. Choose a productMCP Server
    2. Choose a workflowZuplo Portal
    3. 3Build and testFollow your tutorial

    MCP Server tutorial/Zuplo Portal

    Expose a sample Todo API as an MCP server and test its tools with an MCP client.

    Follow along using

    Zuplo PortalLocal with an editorLocal with an AI agent

    Turn an OpenAPI-described API into a managed MCP server. This path builds it in the Zuplo Portal.

    Zuplo allows you to instantly add a managed MCP Server to your existing API, powered by OpenAPI.

    If you're not familiar with Zuplo, it's recommended to go through the Step 1 first.

    1. Create a new project

      In the Zuplo Portal, open Projects, click New Project, select API & MCP Gateway, enter a project name, and click Create Project.

      New Zuplo project dialog with API & MCP Gateway selected

    2. Import an OpenAPI document

      Let's import an OpenAPI document. You can download this one here todo-openapi.json.

      Import OpenAPI

      Select the Code tab (1), then choose the routes.oas.json file (2) and choose Import OpenAPI (3).

      Complete Import

      Click Complete Import to import the routes.

      Now save your changes (press Save at bottom left of CMD+S).

    3. Test the Get all todos route

      The first route you imported is called Get all todos. Select it and click the Test button next to the Path field.

      A test dialog will open, click Test and you should see a 200 OK response with a few todos.

      This is the basic API we're going to turn into a fully functioning MCP Server.

    4. Create an MCP Server

      On your routes.oas.json file, choose Add and then Dynamic OpenAPI to MCP Server (3)

      Add Route

      A new route will appear. Confirm the following values:

      • Summary: enter MCP Server
      • Method: choose POST
      • Path: enter /mcp (the path can be anything, but /mcp is common)

      Click the Select Tools option for your new MCP Server endpoint (1).

      Select Tools

      You should see the MCP tools dialog. Check the tools from your *.oas.json files, that you want to surface in your MCP Server.

      MCP Server

      Click Update Tools (1)

      Now click Save at the bottom left. Congratulations, you just published your first MCP Server!

    5. Connect your MCP Client

      You can use any MCP client you like. We like the OpenAI platform's playground.

      Go to platform.openai.com/playground (you'll need an OpenAI account).

      Add tool

      Click Create... next to the Tools label and choose MCP Server.

      Click Add new to register your custom MCP Server with the playground.

      You'll need the URL of your MCP server - you can get this by going back to Zuplo, clicking on your MCP Server route and then clicking Test. At the top you'll see a button to copy the URL to your clipboard.

      Copy MCP Server URL

      Back to the OpenAI playground...

      Connect MCP Server

    6. Enter the URL of your MCP Server

    7. Enter a label, try todos

    8. Choose None for Authentication as we didn't add auth to our API

    9. Click Connect

      If successfully connected, you'll see your 'tools' listed in the playground.

      Add tools

      No need to deselect any tools, let's add them all!

    10. Test your MCP Server via the playground

      Let's prompt the LLM in the playground. Ask the model to

      list out all the todos

      The model should recognize that it needs to call the todos MCP Server and will ask for your approval.

      Click Approve and you should see the todos listed 👏

      The prompt

    Congratulations! Now go read more about the MCP Server handler.

    Getting StartedGetting Started with MCP Server - Editor
    On this page
    • Create a new project
    • Import an OpenAPI document
    • Test the Get all todos route
    • Create an MCP Server
    • Connect your MCP Client
    • Enter the URL of your MCP Server
    • Enter a label, try todos
    • Choose None for Authentication as we didn't add auth to our API
    • Click Connect
    • Test your MCP Server via the playground