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 文件。