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 서버

개요

  • 이 프로젝트에서는 LLM에 대한 컨텍스트로 구성된 REST API를 제공하는 MCP - Model Context Protocol Server 설치합니다.
  • 이를 사용하면 LLM이 RestAPI와 상호 작용하고 LLM 프롬프트를 사용하여 REST API 호출을 수행할 수 있습니다.
  • 현재 HTTP API 호출의 GET/PUT/POST/PATCH 지원합니다.

설치

  • 패키지 설치지엑스피1
  • 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 : 목록 형식 ["operationId1", "operationId2"]의 허용 목록에 있는 작업 ID(선택 사항)
    • API_BLACK_LIST : 블랙리스트에 등록된 operationId(목록 형식: ["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