MCP Server Boilerplate (typescript)

🚀 MCP 服务器说明

MCP（Machine Communicator Protocol）是一种用于机器间通信的协议。本项目提供了一个简单的 HTTP 服务器实现，非常适合开发和测试使用。

🚀 快速开始

1. 创建一个 mcp.json 文件：

{
  "name": "示例 MCP 服务器",
  "version": "0.1.0",
  "description": "这是一个简单的 MCP 服务器。",
  "tools": [
    {
      "id": "tool1",
      "name": "工具1",
      "description": "执行任务的工具。"
    }
  ]
}

2. 创建 server.ts 文件：

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. 启动服务器：

npm run start

✨ 主要特性

• 工具注册：支持通过 mcp.json 定义工具。
• 通信协议：遵循 MCP 协议标准。
• 插件扩展：提供插件系统，便于功能扩展。

📦 安装指南

使用 npm 安装项目：

npm install mcp-server

或者按照以下步骤进行安装：

1. 克隆仓库：

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

2. 安装依赖：

npm install

💻 使用示例

基础用法

创建工具

在 mcp.json 中定义工具：

{
  "tools": [
    {
      "id": "tool1",
      "name": "计算器工具",
      "description": "执行数学运算。",
      "parameters": [
        { "type": "number", "name": "a" },
        { "type": "number", "name": "b" }
      ],
      "responseType": "number"
    }
  ]
}

调用工具

通过 HTTP 请求调用工具：

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

响应示例：

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

📚 详细文档

扩展与配置

配置文件

mcp.json 示例：

{
  "name": "自定义 MCP 服务器",
  "version": "1.0.0",
  "description": "高度定制化的 MCP 服务器。",
  "tools": [
    {
      "id": "tool2",
      "name": "文件处理工具",
      "description": "处理上传的文件。",
      "parameters": [
        { "type": "file", "name": "inputFile" }
      ],
      "responseType": "string"
    }
  ]
}

插件系统

通过编写插件扩展功能：

import { Plugin } from 'mcp-server';

export default class MyPlugin implements Plugin {
  apply(app: any) {
    // 扩展逻辑
  }
}

文档结构

目录

• 简介
• 安装
• 快速开始
• 功能特性
• 使用示例
• 扩展与配置

详细说明

• 安装指南：介绍了使用 npm 安装和克隆仓库安装的方法。
• 快速开始步骤：创建 mcp.json 文件、编写服务器代码、启动服务。
• 功能模块：
  • 工具管理：处理工具的注册与调用。
  • 通信协议：实现数据交互的标准流程。
  • 插件支持：允许通过插件扩展功能。

项目示例

示例项目结构

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

运行示例

npm install
npm run start

错误处理

• 参数错误：返回 400 状态码。
• 服务内部错误：返回 500 状态码。

贡献指南

欢迎贡献代码！请遵循以下步骤：

1. 创建分支。
2. 提交更改。
3. 提交拉取请求。

📄 许可证

项目采用 MIT 协议，具体条款见 LICENSE 文件。