MCP Server Boilerplate (typescript)

🚀 MCP Server Documentation

MCP (Machine Communicator Protocol) is a protocol designed for communication between machines. This project offers a straightforward HTTP server implementation, suitable for development and testing purposes.

🚀 Quick Start

1. Create a mcp.json file:

{
  "name": "Example MCP Server",
  "version": "0.1.0",
  "description": "This is a simple MCP server.",
  "tools": [
    {
      "id": "tool1",
      "name": "Tool 1",
      "description": "A tool for performing tasks."
    }
  ]
}

2. Create a server.ts file:

import { MCP } from 'mcp-server';

async function bootstrap() {
  const server = new MCP.Server({
    port: 3000,
    jsonPath: './mcp.json'
  });

  await server.start();
}

bootstrap().catch(console.error);

3. Start the server:

npm run start

✨ Features

• Tool Registration: Supports defining tools via mcp.json.
• Communication Protocol: Adheres to the MCP protocol standard.
• Plugin Extension: Provides a plugin system for easy functionality expansion.

📦 Installation

Install the project using npm:

npm install mcp-server

💻 Usage Examples

Basic Usage

Define a tool in mcp.json:

{
  "tools": [
    {
      "id": "tool1",
      "name": "Calculator Tool",
      "description": "Performs mathematical operations.",
      "parameters": [
        { "type": "number", "name": "a" },
        { "type": "number", "name": "b" }
      ],
      "responseType": "number"
    }
  ]
}

Advanced Usage

Invoke a tool via an HTTP request:

curl -X POST http://localhost:3000/api/tool/tool1 \
     -H "Content-Type: application/json" \
     -d '{"a": 10, "b": 20}'

Example response:

{
  "status": "success",
  "result": 30
}

📚 Documentation

Directory

• Introduction
• Installation
• Quick Start
• Features
• Usage Examples
• Expansion and Configuration

Detailed Explanation

Installation Guide

1. Clone the repository:

   git clone https://github.com/username/mcp-server.git
   

2. Install dependencies:

   npm install
   

Quick Start Steps

1. Create a mcp.json file.
2. Write the server code.
3. Start the service.

Functional Modules

• Tool Management: Handles tool registration and invocation.
• Communication Protocol: Implements the standard process for data interaction.
• Plugin Support: Allows functionality expansion through plugins.

📚 Project Example

Example Project Structure

mcp-server-example/
├── package.json
├── mcp.json
└── src/
    └── server.ts

Run the Example

npm install
npm run start

🔧 Error Handling

• Parameter Error: Returns a 400 status code.
• Internal Server Error: Returns a 500 status code.

🤝 Contribution Guidelines

Contributions are welcome! Please follow these steps:

1. Create a branch.
2. Commit your changes.
3. Submit a pull request.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.