Webapi MCP Server

🚀 WebAPI to MCP Conversion Tool

This is a tool that enables the conversion of Web APIs to MCP, simplifying the registration and management of various Web APIs through straightforward configurations and facilitating unified calls.

🚀 Quick Start

📦 Installation

To use this tool, first install the npm package:

npm install webapi-mcp-server

✨ Features

This is a module for converting Web APIs to MCP. It allows you to register and manage various Web APIs through simple configurations and make calls in a unified manner.

💻 Usage Examples

Basic Usage

Create a Server

Use the webapi.createServer function to create a custom server:

const webapi = require('webapi-mcp-server');

// Create a basic server
const server = webapi.createServer({
  debug: true, // Enable debug mode
  configFile: './config.json', // Configuration file path
  apisDir: './apis' // API definition directory
});

// Start listening
server.listen(3000);

Register an API

You can use the registerApi method to register a single API:

webapi.registerApi({
  name: 'weather', // Unique name
  description: 'Get weather information', // Description
  url: 'https://api.example.com/weather', // Request URL
  method: 'GET' // HTTP method
});

Use Parameters

In the API definition, you can include request parameters:

webapi.registerApi({
  name: 'weather',
  parameters: {
    city: {
      type: 'string',
      required: true,
      description: 'City name'
    },
    units: {
      type: 'string',
      required: false,
      description: 'Temperature unit (celsius, fahrenheit)'
    }
  }
});

Handle Responses

Specify how to extract the result through the resultPath field:

webapi.registerApi({
  name: 'weather',
  resultPath: 'data.current' // Result path, e.g., "data.items"
});

Configure Request Headers

Add request header information to the API definition:

webapi.registerApi({
  name: 'news',
  headers: {
    'X-API-Key': 'your-key'
  }
});

Advanced Usage

JSON Format Definition Example

A complete API definition example is as follows:

{
  "name": "weather",
  "description": "Get weather information",
  "url": "https://api.example.com/weather",
  "method": "GET",
  "parameters": {
    "city": {
      "type": "string",
      "required": true,
      "description": "City name"
    }
  },
  "headers": {
    "X-API-Key": "your-key"
  },
  "resultPath": "data.current"
}

Markdown Format Definition Example

A complete API definition can also use the Markdown format:

# Weather API

Get weather information

## URL
https://api.example.com/weather

## Method
GET

## Parameters
- city (string, required): City name

## Request Headers
- X-API-Key: your-key

## Result Path
data.current

Example Code

An example of calling an API:

const result = await webapi.call('weather', {
  city: 'London'
});
console.log(result);

Export a Module

You can extend functionality by exporting functions:

module.exports = {
  customFunction: function() {}
};

📚 Documentation

• Detailed Documentation
• Example Project

📄 License

This project is licensed under the MIT License.