MCP Swagger Server

🚀 MCP Swagger Server

An MCP server that provides access to Swagger/OpenAPI documentation and makes API requests based on the specification.

✨ Features

• Load Swagger documentation from a URL.
• Make API requests based on the Swagger specification.
• Support authentication via an API key.
• Cache the Swagger specification for improved performance.
• Validate requests against the Swagger specification.

📦 Installation

1. Install the dependencies:

npm install

2. Build the TypeScript code:

npm run build

🚀 Quick Start

Development Mode

npm run dev

Production Mode

npm run start

📚 Documentation

Configuration

The server requires the following environment variables:

• SWAGGER_URL: The URL of the Swagger specification (required).
• AUTH_KEY: The authentication key for API requests (optional).

Available Resources and Tools

Resource: swagger-doc

• URI: swagger://documentation
• Description: Retrieve the full Swagger documentation.

Tool: makeRequest

Make an API request based on the Swagger specification.

Parameters:

• path: The API endpoint path.
• method: The HTTP method (GET, POST, etc.).
• parameters: Optional path/query parameters.
• body: Optional request body.

Example:

const result = await mcp.tools.makeRequest({
  path: "/api/users",
  method: "GET",
  parameters: { userId: "123" }
});

Deployment on Smithery.ai

This server is configured to be deployed on Smithery.ai. Deployment requires:

1. A Dockerfile to build and run the server.
2. A smithery.yaml configuration file.
3. Correct TypeScript build settings.

Configuration Scheme

When configuring the server on Smithery.ai, use the following:

{
  "swaggerUrl": "https://api.example.com/swagger.json",
  "authKey": "your-api-key"  // Optional
}

Local Testing with Smithery

1. Build the Docker image:

docker build -t mcp-swagger .

2. Run the container:

docker run -e SWAGGER_URL=your-swagger-url -e AUTH_KEY=your-auth-key mcp-swagger

Development Scripts

• npm run build: Build the TypeScript code.
• npm run start: Run the server in production mode.
• npm run dev: Run the server in development mode with hot reloading.