OpenAPI MCP Server

by JacerOmri

Integrations

  • Embeds a terminal recording demonstration of the MCP server functionality

  • References GitHub for the project roadmap and contribution process

  • Enables GitHub Copilot to interact with OpenAPI services through the MCP server, allowing Copilot to use tools defined by the OpenAPI specification

🤖 OpenAPI MCP 서버

모든 OpenAPI 서비스를 MCP(Model Context Protocol) 서버로 변환하는 명령줄 도구로, MCP 사양을 지원하는 AI 에이전트 및 도구와 원활하게 통합할 수 있습니다.

[!NOTE] 이 도구는 아직 초기 개발 단계에 있습니다. 로드맵 은 여기에서 확인하세요.

모델 컨텍스트 프로토콜(MCP)이란 무엇입니까?

모델 컨텍스트 프로토콜(MCP)은 AI 에이전트가 외부 도구 및 서비스와 상호 작용할 수 있도록 하는 표준화된 프로토콜입니다. AI 모델이 통합된 인터페이스를 통해 다양한 기능을 발견하고 이해하고 활용할 수 있는 일관된 방식을 제공하여 여러 서비스와 상호 작용할 수 있는 AI 기반 애플리케이션을 더욱 쉽게 구축할 수 있도록 합니다.

OpenAPI란 무엇인가요?

OpenAPI(이전 명칭: Swagger)는 RESTful 웹 서비스를 설명, 생성, 사용 및 시각화하기 위한 기계 판독 가능 인터페이스 파일에 대한 사양입니다. OpenAPI를 사용하면 사람과 컴퓨터 모두 소스 코드나 추가 문서에 접근하지 않고도 서비스의 기능을 파악하고 이해할 수 있습니다.

이 프로젝트에 관하여

이 미들웨어는 OpenAPI 서비스와 MCP 클라이언트를 연결하는 다리 역할을 합니다. 다음과 같은 기능을 제공합니다.

  1. OpenAPI 사양 파일을 입력으로 사용합니다.
  2. MCP 호환 서버를 자동으로 생성합니다.
  3. 실제 OpenAPI 서비스에 대한 수신 요청을 프록시합니다.
  4. MCP와 REST 규칙 간 변환

이를 통해 MCP를 이해하는 AI 에이전트는 OpenAPI 사양을 갖춘 기존 REST API에 즉시 액세스할 수 있으며, 원래 서비스를 수정할 필요가 없습니다.

설치

지엑스피1

용법

npx openapi-mcp-proxy --spec ./path/to/openapi.yml --target http://your-api.com --port 3000

옵션

  • -s, --spec <path> (필수): OpenAPI 사양 파일 경로(env: OMP_OPENAPI_SPEC_FILE )
  • -t, --target <url> (선택 사항): API 서비스의 대상 URL(기본값: " http://localhost:8080 ", env: OMP_TARGET_BASE_URL )
  • -p, --port <number> (선택 사항): MCP 서버를 실행할 포트(기본값: "3000", env: PORT )
  • -V, --version : 버전 번호 표시
  • -h, --help : 명령어에 대한 도움말을 표시합니다.

Petstore API에 대한 MCP 서버 시작

npx openapi-mcp-proxy --spec resources/petstore.openapi.yml --target https://petstore.swagger.io/v2

테스트

MCP 검사관

MCP 서버를 테스트하려면 모델 컨텍스트 프로토콜을 사용할 수 있습니다.

  1. MCP 검사기 설치:
npx @modelcontextprotocol/inspector
  1. MCP 서버를 시작하세요
  2. 검사기 UI로 이동하여 http://localhost:3000/mcp 와 같이 /mcp 로 끝나는 올바른 서버 경로를 입력합니다.
  3. 이제 MCP 서버와 상호 작용할 수 있습니다. MCP 검사기가 요청 및 응답에 대한 자세한 정보를 표시합니다.
VS 코드로

VS Code의 기본 제공 에이전트 모드를 사용하면 더 쉽습니다.

  1. VS Code를 열고 에이전트 모드를 활성화하세요.
    • Cmd/Ctrl + Shift + P 누르세요
    • "GitHub Copilot Agent 모드 전환"을 입력하세요.
    • "활성화"를 선택하세요
  2. MCP 서버를 추가하세요:
    • Cmd/Ctrl + Shift + P 누르세요
    • "MCP: 서버 추가"를 입력하세요.
    • http://localhost:3000/mcp 처럼 MCP 서버 URL을 입력하고 /mcp 로 끝냅니다.
  3. 귀하의 github 조종사 채팅에서 새로운 도구를 활용할 수 있을 것입니다!
  4. 이제 VS Code의 에이전트 인터페이스를 통해 MCP 서버와 상호 작용할 수 있습니다. "지금 이용 가능한 애완동물이 몇 마리나 있나요?"라고 질문해 보세요.

VS 코드와 함께 MCP 서버를 사용하는 방법에 대한 자세한 내용은 다음을 참조하세요.

기여하다

기여를 환영합니다! 풀 리퀘스트를 제출해 주세요. 로드맵은 여기에 있습니다.

특허

MIT

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

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

모든 OpenAPI 서비스를 MCP(Model Context Protocol) 서버로 변환하는 명령줄 도구로, MCP 사양을 지원하는 AI 에이전트 및 도구와 원활하게 통합할 수 있습니다.

  1. 모델 컨텍스트 프로토콜(MCP)이란 무엇입니까?
    1. OpenAPI란 무엇인가요?
      1. 이 프로젝트에 관하여
        1. 설치
          1. 용법
            1. 옵션
            2. 테스트
          2. 기여하다
            1. 특허

              Related MCP Servers

              • -
                security
                A
                license
                -
                quality
                An MCP server that exposes HTTP methods defined in an OpenAPI specification as tools, enabling interaction with APIs via the Model Context Protocol.
                Last updated -
                2
                Python
                MIT License
              • -
                security
                A
                license
                -
                quality
                A Model Context Protocol (MCP) server implementation for the OpenLedger API. This server provides structured context to AI models according to the MCP specification.
                Last updated -
                8
                TypeScript
                Apache 2.0
              • -
                security
                F
                license
                -
                quality
                A Model Context Protocol server implementation that enables connection between OpenAI APIs and MCP clients for coding assistance with features like CLI interaction, web API integration, and tool-based architecture.
                Last updated -
                9
                Python
                • Linux
                • Apple
              • -
                security
                A
                license
                -
                quality
                A zero-configuration tool that automatically converts FastAPI endpoints into Model Context Protocol (MCP) tools, enabling AI systems to interact with your API through natural language.
                Last updated -
                1
                Python
                MIT License

              View all related MCP servers

              ID: yi6eicpb50