MCP Client Helper

🚀 MCP-Client-Helpy工具庫

MCP-Client-Helpy是一款強大的MCP服務器管理工具庫，可通過配置文件輕鬆管理和控制多個MCP服務器實例，極大提升服務器管理效率。

🚀 快速開始

MCP-Client-Helpy工具庫能幫助你通過配置文件高效管理和控制多個MCP服務器實例。下面將為你介紹它的安裝、配置和使用方法。

✨ 主要特性

• 📋 通過配置管理多個MCP服務器，實現集中化管理。
• ⏯️ 支持啟動、停止和重啟服務器，操作便捷。
• 🔍 即時監控所有服務器狀態，隨時掌握服務器運行情況。
• 📝 事件驅動的日誌和錯誤處理，及時響應服務器異常。
• ⚙️ 支持自定義環境變量配置，滿足多樣化需求。

📦 安裝指南

使用以下命令進行安裝：

npm install mcp-client-helper

📚 詳細文檔

配置格式

配置對象格式示例如下：

{
  "mcpServers": {
    "github": {
      "command": "npx",
      "args": ["-y", "@modelcontextprotocol/server-github"],
      "env": {
        "GITHUB_PERSONAL_ACCESS_TOKEN": "your-token-here"
      }
    },
    "other-server": {
      "command": "your-command",
      "args": ["arg1", "arg2"],
      "env": {
        "KEY": "value"
      }
    }
  }
}

💻 使用示例

基礎用法

import { MCPServerManager } from 'mcp-client-helper';
import { readFileSync } from 'fs';

async function main() {
  // 從配置文件加載配置
  const config = JSON.parse(readFileSync('path/to/your/config.json', 'utf-8'));
  
  // 創建服務器管理器實例
  const manager = new MCPServerManager(config);

  try {
    // 獲取所有配置的服務器名稱
    const serverNames = manager.getServerNames();
    console.log('可用的服務器:', serverNames);

    // 監聽特定服務器的事件
    manager.on('log', (serverName, log) => {
      console.log(`[${serverName}] 日誌:`, log);
    });

    manager.on('error', (serverName, error) => {
      console.error(`[{serverName}] 錯誤:`, error);
    });

    manager.on('exit', (serverName, code) => {
      console.log(`[{serverName}] 服務器退出，退出碼:`, code);
    });

    // 啟動指定的服務器
    await manager.start('github');

    // 獲取服務器狀態
    const status = manager.getStatus('github');
    console.log('服務器狀態:', status);

    // 重啟服務器
    await manager.restart('github');

    // 停止服務器
    await manager.stop('github');

    // 動態更新配置
    manager.updateConfig(newConfig);
  } catch (error) {
    console.error('錯誤:', error);
  }
}

main().catch(console.error);

📄 API文檔

MCPServerManager

構造函數

constructor(config: MCPConfig)

配置參數：

• config: MCP服務器配置對象，包含所有要管理的服務器配置

方法

• start(serverName: string): Promise<void>：啟動指定的服務器
• stop(serverName: string): Promise<void>：停止指定的服務器
• restart(serverName: string): Promise<void>：重啟指定的服務器
• getStatus(serverName: string): ServerStatus | undefined：獲取指定服務器的狀態
• getServerNames()：返回所有配置的服務器名稱
• updateConfig(newConfig: MCPConfig)：動態更新配置

事件

• log：當服務器輸出日誌時觸發，參數為 (serverName: string, log: string)
• error：當服務器發生錯誤時觸發，參數為 (serverName: string, error: Error)
• exit：當服務器退出時觸發，參數為 (serverName: string, code: number)

🔧 技術細節

開發要求

• Node.js 版本：支持版本請參考包依賴
• 額外依賴：無

📄 許可證

本項目採用 ISC 許可證。