Openapi MCP Server

🚀 OpenAPI MCP Server

This project focuses on installing the MCP - Model Context Protocol Server, which offers pre - configured REST APIs as the context for LLMs. By leveraging this server, we can enable LLMs to interact with REST APIs and execute REST API calls through LLM prompts. Currently, it supports HTTP request methods such as GET/PUT/POST/PATCH.

🚀 Quick Start

✨ Features

• Install the MCP - Model Context Protocol Server, providing configured REST APIs as the context for LLMs.
• Enable LLM interaction with REST APIs and execute REST API calls via LLM prompts.
• Support GET/PUT/POST/PATCH HTTP request methods.

📦 Installation

1. Install the package:

   pip install openapi_mcp_server
   

2. Create a .env file in the folder and set the necessary values to configure OPENAPI_SPEC_PATH and API_BASE_URL. You can download an example file here.
3. Test the openapi_mcp_server using the following command:

   uv run openapi_mcp_server
   

💻 Usage Examples

Claud Desktop Configuration

• Configuration example:

  {
      "mcpServers": {
          "openapi_mcp_server":{
              "command": "uv",
              "args": ["run","openapi_mcp_server"],
              "env": {
                  "DEBUG":"1",
                  "API_BASE_URL":"https://petstore.swagger.io/v2",
                  "OPENAPI_SPEC_PATH":"https://petstore.swagger.io/v2/swagger.json",
                  "API_HEADERS":"Accept:application/json",
                  "API_WHITE_LIST":"addPet,updatePet,findPetsByStatus"
              }
          }
      }
  }
  

Configuration

• List of available environment variables:
  • DEBUG: Enable debug logging (optional, default is False).
  • OPENAPI_SPEC_PATH: Path to the OpenAPI documentation (required).
  • API_BASE_URL: Base URL for API requests (required).
  • API_HEADERS: Headers to include in API requests (optional).
  • API_WHITE_LIST: List of whitelisted operation IDs (format: ["operationId1", "operationId2"], optional).
  • API_BLACK_LIST: List of blacklisted operation IDs (format: ["operationId3", "operationId4"], optional).
  • HTTP_PROXY: HTTP proxy information (optional).
  • HTTPS_PROXY: HTTPS proxy information (optional).
  • NO_PROXY: No - proxy information (optional).

🔧 Technical Details

UV Commands

mkdir -m777 openapi_mcp_server
cd openapi_mcp_server
uv init
uv add mcp 协议 协议、协议、协议
uv sync
uv run
uv build

• uv init: Initialize the project.
• uv add [dependencies...]: Add required dependencies. For example, running uv add openapi - spec 协议 may automatically add OpenAPI - related dependencies.
• uv sync: Synchronize the code.
• uv run: Run the server.
• uv build: Build the project.

These commands assist developers in quickly initializing, configuring, and deploying the MCP server, ensuring that all dependencies are correctly installed and the code is up - to - date. In this way, users can easily integrate the server into their existing development environment for further customization and expansion.

📄 License

This project is licensed under the terms of the MIT License.

GitHub Stars

[](https://star - history.com/#rahgadda/openapi_mcp_server&Date)

Feedback and Support

If you encounter any issues during use or need further support, please feel free to refer to the project documentation or contact the maintainers. Your feedback is invaluable for us to improve the project!