Api2mcptools

🚀 @terryliyongjie/api2mcptools

A Node.js package that converts APIs to MCP (Model Context Protocol) tools.

Chinese Documentation

• CherryStudio Example CherryStudio

🚀 Quick Start

📦 Installation

Option 1: Quick Start with npx (Recommended)

set CONFIG_JSON_PATH=example.json
npx @terryliyongjie/api2mcptools

Option 2: Traditional Installation

# Install locally in your project
npm install @terryliyongjie/mcp-tools

# Or install globally for use as a CLI tool
npm install -g @terryliyongjie/mcp-tools

⚙️ Configuration

Environment Variables

# Required: Path to the configuration JSON file
CONFIG_JSON_PATH=example.json

Example configuration file (example.json):

// Single tool configuration
{
    "name": "tool_name",
    "description": "Tool description",
    "inputSchema": {
        "type": "object",
        "properties": {
            "param1": {
                "type": "string",
                "description": "Parameter description"
            }
        },
        "required": ["param1"]
    },
    "axiosConfig": {
        "url": "https://api.example.com/endpoint",
        "method": "get",
        "params": {
            "key": "your_api_key"
        }
    }
}

// Or multiple tool configurations
[
    {
        "name": "baidu_place_search",
        "description": "Use the Baidu Map API for place search services",
        "inputSchema": {
            "type": "object",
            "properties": {
                "query": {
                    "type": "string",
                    "description": "Search keyword"
                },
                "region": {
                    "type": "string",
                    "description": "Search administrative region"
                }
            },
            "required": ["query", "region"]
        },
        "axiosConfig": {
            "url": "https://api.map.baidu.com/place/v2/search",
            "method": "get",
            "params": {
                "ak": "your_baidu_map_key"
            }
        }
    },
    // More tools...
]

✨ Features

• Convert JSON APIs to MCP tools.
• Easily integrate with the MCP ecosystem.
• Support multiple API types.
• Command-line interface (CLI) support.

💻 Usage Examples

As a CLI Tool

After global installation, you can use the command directly in the terminal:

mcp-tools [options]

As a Module

// Example code will be released soon.

🔧 Technical Details

# Install dependencies
npm install

# Build the project
npm run build

# Run in development mode
npm run dev

# Watch file changes during development
npm run watch

# Run the MCP inspector
npm run inspector

📄 License

MIT