MCP Client Helper

🚀 MCP-Client-Helpy Toolkit

A tool library for managing MCP servers, enabling the management and control of multiple MCP server instances through configuration files.

🚀 Quick Start

The MCP-Client-Helpy Toolkit is a powerful utility designed to simplify the management of multiple MCP server instances via configuration files. It offers a range of features to streamline server operations and monitoring.

✨ Features

• Manage multiple MCP servers through configuration.
• Support starting, stopping, and restarting servers.
• Monitor the status of all servers in real-time.
• Implement event-driven logging and error handling.
• Support custom environment variable configurations.

📦 Installation

npm install mcp-client-helper

📚 Documentation

Configuration Format

Here is an example of the configuration object format:

{
  "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"
      }
    }
  }
}

💻 Usage Examples

Basic Usage

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

async function main() {
  // Load configuration from the configuration file
  const config = JSON.parse(readFileSync('path/to/your/config.json', 'utf-8'));
  
  // Create an instance of the server manager
  const manager = new MCPServerManager(config);

  try {
    // Get the names of all configured servers
    const serverNames = manager.getServerNames();
    console.log('Available servers:', serverNames);

    // Listen for events of a specific server
    manager.on('log', (serverName, log) => {
      console.log(`[${serverName}] Log:`, log);
    });

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

    manager.on('exit', (serverName, code) => {
      console.log(`[${serverName}] Server exited, Exit code:`, code);
    });

    // Start the specified server
    await manager.start('github');

    // Get the server status
    const status = manager.getStatus('github');
    console.log('Server status:', status);

    // Restart the server
    await manager.restart('github');

    // Stop the server
    await manager.stop('github');

    // Dynamically update the configuration
    manager.updateConfig(newConfig);
  } catch (error) {
    console.error('Error:', error);
  }
}

main().catch(console.error);

📄 API Documentation

MCPServerManager

Constructor

constructor(config: MCPConfig)

Configuration parameters:

• config: An MCP server configuration object containing all the server configurations to be managed.

Methods

• start(serverName: string): Promise<void>: Start the specified server.
• stop(serverName: string): Promise<void>: Stop the specified server.
• restart(serverName: string): Promise<void>: Restart the specified server.
• getStatus(serverName: string): ServerStatus | undefined: Get the status of the specified server.
• getServerNames(): Return the names of all configured servers.
• updateConfig(newConfig: MCPConfig): Dynamically update the configuration.

Events

• log: Triggered when the server outputs a log, with parameters (serverName: string, log: string).
• error: Triggered when an error occurs on the server, with parameters (serverName: string, error: Error).
• exit: Triggered when the server exits, with parameters (serverName: string, code: number).

🔧 Technical Details

Development Requirements

• Node.js Version: Refer to the package dependencies for supported versions.
• Additional Dependencies: None.

📄 License

ISC