MultiServerMCP

一个基于 SSE 的多连接 MCP 服务器框架，用于长连接通信。为 AI 助手提供上下文和功能扩展能力。 目前仅支持 SSE 模式。

🚀 MultiServerMCP — 通过多连接服务器框架，为 AI 助手赋能扩展能力！

MultiServerMCP 旨在提供一个强大的服务器框架，支持单个服务器上的多个客户端连接，从而实现对 AI 助手的高效工具和权限管理。

🌟 主要特性

• 支持 SSE 模式下单个服务器的多个客户端连接
• 通过 URL 分组进行工具和权限管理
• 内置心跳机制，确保连接稳定性
• 简化的工具注册流程
• 完全兼容 MCP 协议
• 使用 SessionManager 进行全局会话管理，可在任何地方访问客户端上下文
• 便捷的全局函数，可通过 sessionId 检索请求参数和客户端上下文

📦 安装

npm install multi-server-mcp
# or
yarn add multi-server-mcp
# or
pnpm add multi-server-mcp

🚀 快速开始

完整服务器示例

import { z } from "zod";
import { MultiServerMCP } from "multi-server-mcp";
import { ResourceTemplate } from "@modelcontextprotocol/sdk/server/mcp.js";
import { getSseReqQuery } from "multi-server-mcp";

// 创建启用 URL 分组的 MCP 服务器
const server = new MultiServerMCP(
  {
    name: "multi server",
    version: "1.0.0",
  },
  {
    enableUrlGroups: true,
  }
);

// 注册一个使用请求参数的计算器工具
server.tool("calc/add", { a: z.number(), b: z.number() }, async ({ a, b }, extra) => {
  console.log(extra);
  // 从 SSE 连接获取查询参数
  const reqQuery = getSseReqQuery(extra.sessionId as string);
  console.log(reqQuery);
  return {
    content: [{ type: "text", text: String(a + b) }],
  };
});

// 注册一个资源模板
server.resource(
  "greeting",
  new ResourceTemplate("greeting://{name}", { list: undefined }),
  async (uri, { name }) => ({
    contents: [
      {
        uri: uri.href,
        text: `Hello, ${name}!`,
      },
    ],
  })
);

// 启动服务器
server
  .start({
    transportType: "sse",
  })
  .then(() => {
    console.log(`Server started`);
  })
  .catch((error) => {
    console.error(`Server start failed: ${error}`);
    process.exit(1);
  });

基本用法

import { MultiServerMCP } from 'multi-server-mcp';

// 创建 MCP 服务器实例
const server = new MultiServerMCP({
  name: 'my-mcp-server',
  version: '1.0.0'
});

// 注册一个工具
server.tool('my-tool', async () => {
  return {
    content: [{ type: 'text', text: 'Tool executed successfully!' }]
  };
});

// 启动服务器
server.start({
  transportType: 'sse',
  sse: {
    port: 3000,
    endpoint: '/mcp',
    messagesEndpoint: '/mcp-messages'
  }
});

工具分组和权限管理

// 注册一个带有分组的工具
server.tool('group1/group2/my-tool', async () => {
  return {
    content: [{ type: 'text', text: 'Tool executed successfully!' }]
  };
});

// 启动具有权限管理的服务器
server.start({
  transportType: 'sse',
  enableUrlGroups: true
});

全局访问客户端上下文

import { getSseReqQuery, getClientContextBySessionId } from 'multi-server-mcp';
import { z } from "zod";

// 注册一个使用请求参数的工具
server.tool("calc/add", { a: z.number(), b: z.number() }, async ({ a, b }, extra) => {
  // 从 SSE 连接获取请求参数
  const reqQuery = getSseReqQuery(extra.sessionId as string);
  console.log('Query parameters:', reqQuery);
  
  return {
    content: [{ type: "text", text: String(a + b) }],
  };
});

// 在代码的任何部分，您也可以访问客户端的请求参数
function myFunction(sessionId: string) {
  // 从 SSE 连接请求获取查询参数
  const reqQuery = getSseReqQuery(sessionId);
  console.log('Client query parameters:', reqQuery);
  
  // 如果需要，获取完整的客户端上下文
  const clientContext = getClientContextBySessionId(sessionId);
  if (clientContext) {
    console.log('Client URL groups:', clientContext.urlGroups);
    // 访问任何其他客户端上下文属性
  }
}

🔧 开发指南

目前仅支持 SSE 模式。

支持的工具类型

• 常规工具: server.tool()
• 资源工具: server.resource()
• Prompt 工具: server.prompt()

会话管理

SessionManager 提供了一个单例实例来管理客户端会话：

• SessionManager.getInstance(): 获取单例实例
• SessionManager.getInstance().getClientContext(sessionId): 通过 sessionId 获取客户端上下文
• SessionManager.getInstance().getReqQuery(sessionId): 通过 sessionId 获取请求查询参数
• SessionManager.getInstance().getSessionCount(): 获取活动会话的数量

为了方便起见，提供了以下全局函数：

• getSseReqQuery(sessionId): 通过 sessionId 获取请求查询参数
• getClientContextBySessionId(sessionId): 通过 sessionId 获取客户端上下文

🤝 贡献

欢迎贡献、提交问题和提出功能请求！

📄 许可证

MIT