OpenAPI MCP Server

Integrations

  • Uses environment variables for configuration management, allowing users to specify API endpoints, credentials, and other settings through a .env file.

  • Leverages Pydantic for data validation and parsing of API request/response models defined in OpenAPI specifications.

  • Enables interaction with RESTful APIs defined in Swagger/OpenAPI specifications, supporting GET, PUT, POST, and PATCH operations. The example demonstrates integration with the Swagger Petstore API, including operations like addPet, updatePet, and findPetsByStatus.

OpenAPI MCP サーバー

概要

  • このプロジェクトでは、構成された REST API を LLM のコンテキストとして提供するMCP - Model Context Protocol Serverをインストールします。
  • これを使用すると、LLM が RestAPI と対話し、LLM プロンプトを使用して REST API 呼び出しを実行できるようになります。
  • 現在、HTTP API 呼び出しのGET/PUT/POST/PATCHサポートしています。

インストール

  • パッケージをインストールする
    pip install openapi_mcp_server
  • OPENAPI_SPEC_PATHAPI_BASE_URLの最小値を含むフォルダに .env を作成します。サンプルファイルはこちらから入手できます。
  • 上記のフォルダーからuv run openapi_mcp_serverを使用してopenapi_mcp_serverサーバーをテストします。

クロードデスクトップ

  • Claud Desktop の設定詳細
    { "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" } } } }

構成

  • 利用可能な環境変数のリスト
    • DEBUG : デバッグログを有効にする(オプション、デフォルトはFalse)
    • OPENAPI_SPEC_PATH : OpenAPI ドキュメントへのパス。(必須)
    • API_BASE_URL : APIリクエストのベースURL。(必須)
    • API_HEADERS : APIリクエストに含めるヘッダー(オプション)
    • API_WHITE_LIST : リスト形式のホワイトリスト操作ID ["operationId1", "operationId2"] (オプション)
    • API_BLACK_LIST : ブラックリストに登録された操作ID(リスト形式["operationId3", "operationId4"]、オプション)
    • HTTP_PROXY : HTTPプロキシの詳細(オプション)
    • HTTPS_PROXY : HTTPSプロキシの詳細(オプション)
    • NO_PROXY : プロキシの詳細なし(オプション)

貢献

貢献を歓迎します。
お気軽にプルリクエストを送信してください。

ライセンス

このプロジェクトは、MIT ライセンスの条件に基づいてライセンスされます。

Githubスター

付録

紫外線

mkdir -m777 openapi_mcp_server cd openapi_mcp_server uv init uv add mcp[cli] pydantic python-dotenv requests uv add --dev twine setuptools uv sync uv run openapi_mcp_server uv build pip install --force-reinstall --no-deps .\dist\openapi_mcp_server-*fileversion*.whl export TWINE_USERNAME="rahgadda" export TWINE_USERNAME="<<API Key>>" uv run twine upload --verbose dist/*

参照

-
security - not tested
A
license - permissive license
-
quality - not tested

LLM が自然言語プロンプトを通じて REST API 呼び出しと対話して実行できるようにし、構成された API での GET/PUT/POST/PATCH 操作をサポートするモデル コンテキスト プロトコル サーバー。

  1. Overview
    1. Installation
      1. Claud Desktop
        1. Configuration
      2. Contributing
        1. License
          1. Github Stars
            1. Appendix
              1. UV
            2. Reference
              ID: 1lurw1271g