Model Context Protocol(MCP)을 통해 Swagger/OpenAPI 사양을 수집하고 제공하는 서버입니다.

특징

• Swagger/OpenAPI 사양 로드
• 다중 인증 방법 지원:
• 기본 인증
• 소지자 토큰
• API 키(헤더 또는 쿼리)
• OAuth2
• API 엔드포인트에서 MCP 도구를 자동으로 생성합니다
• 실시간 통신을 위한 서버-전송 이벤트(SSE) 지원
• TypeScript 지원

보안

이건 개인 서버입니다!! 공개 인터넷에 노출하지 마세요. 기본 API가 인증을 요구한다면, MCP 서버를 공개 인터넷에 노출해서는 안 됩니다.

토할

• 비밀 - MCP 서버는 사용자의 비밀을 사용해 API에 대한 요청을 인증할 수 있어야 합니다
• 종합 테스트 스위트

선수 조건

• Node.js (v18 이상)
• 실 패키지 관리자
• TypeScript

설치

1. 저장소 복제:

2. 의존성 설치:

3. 예를 기반으로 .env 파일 생성:

4. Swagger/OpenAPI 명세를 구성하세요:

• 프로젝트에 Swagger 파일을 배치하세요 (예: swagger.json)
• 또는 Swagger 명세의 URL을 제공하세요

5. 서버 설정으로 config.json의 구성을 업데이트하세요:

Swagger MCP Server

A server that ingests and serves Swagger/OpenAPI specifications through the Model Context Protocol (MCP).

Features

• Loads Swagger/OpenAPI specifications
• Supports multiple authentication methods:
  • Basic Auth
  • Bearer Token
  • API Key (header or query)
  • OAuth2
• Automatically generates MCP tools from API endpoints
• Server-Sent Events (SSE) support for real-time communication
• TypeScript support

Security

This is a personal server!! Do not expose it to the public internet. If the underlying API requires authentication, you should not expose the MCP server to the public internet.

TODO

• secrets - the MCP server should be able to use secrets from the user to authenticate requests to the API
• Comprehensive test suite

Prerequisites

• Node.js (v18 or higher)
• Yarn package manager
• TypeScript

Installation

1. Clone the repository:

git clone https://github.com/dcolley/swagger-mcp.git
cd swagger-mcp

2. Install dependencies:

yarn install

3. Create a .env file based on the example:

cp .env.example .env

4. Configure your Swagger/OpenAPI specification:

   • Place your Swagger file in the project (e.g., swagger.json)
   • Or provide a URL to your Swagger specification

5. Update the configuration in config.json with your server settings:

{
  "server": {
    "host": "localhost",
    "port": 3000
  },
  "swagger": {
    "url": "url-or-path/to/your/swagger.json",
    "apiBaseUrl": "https://api.example.com",  // Fallback if not specified in Swagger
    "defaultAuth": {  // Fallback if not specified in Swagger
      "type": "apiKey",
      "apiKey": "your-api-key",
      "apiKeyName": "api_key",
      "apiKeyIn": "header"
    }
  }
}

Note: The server prioritizes settings from the Swagger specification over the config file:

• If the Swagger file contains a servers array, the first server URL will be used as the base URL
• If the Swagger file defines security schemes, they will be used for authentication
• The config file settings serve as fallbacks when not specified in the Swagger file

Usage

1. Start the development server:

yarn dev

2. Build for production:

yarn build

3. Start the production server:

yarn start

API Endpoints

• GET /health - Check server health status
• GET /sse - Establish Server-Sent Events connection
• POST /messages - Send messages to the MCP server

Testing

Run the test suite:

# Run tests once
yarn test

# Run tests in watch mode
yarn test:watch

# Run tests with coverage report
yarn test:coverage

Authentication

The server supports various authentication methods. Configure them in the config.json file as fallbacks when not specified in the Swagger file:

Basic Auth

{
  "defaultAuth": {
    "type": "basic",
    "username": "your-username",
    "password": "your-password"
  }
}

Bearer Token

{
  "defaultAuth": {