OpenAPI MCP Server

Name: OpenAPI MCP Server
Author: rahgadda

@rahgadda

代码仓库

关于 OpenAPI MCP Server

OpenAPI MCP Server

基本信息

分类

其他

许可证

Apache-2.0

运行时

python

传输方式

stdio

发布者

rahgadda

配置

使用下面的配置,将此服务器添加到你的 MCP 客户端。

{
  "mcpServers": {
    "openapi_mcp_server": {
      "command": "uv",
      "args": [
        "init"
      ]
    }
  }
}

工具

未检测到工具

工具是从 README 中自动提取的。维护者可以在 ## Tools 标题下列出工具,即可填充这部分内容。

概览

What is OpenAPI MCP Server?

OpenAPI MCP Server is a Model Context Protocol server that exposes configured REST APIs as context tools for large language models (LLMs). It enables LLMs to interact with REST APIs via natural language prompts, supporting GET, PUT, POST, and PATCH methods.

How to use OpenAPI MCP Server?

Install the package with pip install openapi_mcp_server, then create a .env file with the mandatory OPENAPI_SPEC_PATH and API_BASE_URL variables. Test the server using uv run openapi_mcp_server. For Claude Desktop, add the server configuration to the mcpServers section in the Claude Desktop JSON config, specifying the command uv run openapi_mcp_server and any optional environment variables (e.g., API_HEADERS, API_WHITE_LIST).

Key features of OpenAPI MCP Server

Integrates REST APIs as context for LLMs.
Supports GET, PUT, POST, and PATCH HTTP methods.
Configured via environment variables (OPENAPI_SPEC_PATH, API_BASE_URL).
Optional API headers, operation ID whitelist/blacklist.
Optional HTTP/HTTPS proxy support.
Debug logging available (DEBUG environment variable).

Use cases of OpenAPI MCP Server

Enable LLMs to query and modify data via REST APIs using natural language.
Automate API interactions (CRUD operations) through conversational prompts.
Connect LLM assistants to existing API endpoints without custom code.
Filter operations by whitelist/blacklist to control API exposure.

FAQ from OpenAPI MCP Server

What configuration is required to run OpenAPI MCP Server?

You must set the OPENAPI_SPEC_PATH (path to the OpenAPI document) and API_BASE_URL (base URL for API requests) in a .env file or as environment variables.

Which HTTP methods does OpenAPI MCP Server support?

It supports GET, PUT, POST, and PATCH requests.

Can I restrict which API operations the server exposes?

Yes, use the API_WHITE_LIST (allow only listed operationIds) or API_BLACK_LIST (block listed operationIds) environment variables.

Does OpenAPI MCP Server support proxy servers?

Yes, you can configure HTTP_PROXY, HTTPS_PROXY, and NO_PROXY environment variables for proxy support.

How do I use OpenAPI MCP Server with Claude Desktop?

Add a server entry to the mcpServers section of your Claude Desktop configuration JSON, using the command uv run openapi_mcp_server and specifying the required environment variables such as OPENAPI_SPEC_PATH and API_BASE_URL.