关键词

MCPSSE实时上下文资源服务LLM应用

使用说明

项目简介

express-mcp-sse-server 是一个基于 Node.js 和 Express 框架构建的示例 MCP (Model Context Protocol) 服务器。它使用 Server-Sent Events (SSE) 技术实现与 MCP 客户端的实时通信，旨在为 LLM (大型语言模型) 应用提供标准化的上下文服务。该服务器演示了如何使用 MCP 协议管理资源，并通过 SSE 向客户端推送数据。

主要功能点

  • MCP 协议实现: 遵循 Model Context Protocol 规范，提供标准的上下文服务接口。
  • SSE 实时通信: 使用 Server-Sent Events 实现服务器向客户端的实时数据推送，适用于需要低延迟更新的应用场景。
  • 资源管理: 示例中预定义了 'document' 资源，展示了如何注册和提供资源数据，为 LLM 提供上下文信息。
  • 简单易用: 基于 Express 框架，代码结构清晰，易于理解和扩展。
  • 开发和生产模式: 提供开发 ('yarn dev') 和生产 ('yarn start') 两种启动模式，方便开发调试和部署。

安装步骤

  1. 安装 Node.js 和 Yarn: 确保你的计算机上已安装 Node.js (推荐 v14 或更高版本) 和 Yarn 包管理器。你可以从 Node.js 官网 和 Yarn 官网 下载安装。

  2. 克隆仓库: 使用 Git 命令克隆 express-mcp-sse-server 仓库到本地：

    git clone https://github.com/yunusemredilber/express-mcp-sse-server.git
cd express-mcp-sse-server

  3. 安装依赖: 在仓库目录下运行 Yarn 命令安装项目依赖：

    yarn install

服务器配置

为了让 MCP 客户端能够连接到 express-mcp-sse-server 服务器，你需要配置客户端的连接信息。以下是一个典型的 MCP 客户端服务器配置示例，客户端需要配置启动 MCP 服务器的命令和参数：

{
  "serverName": "ExampleMCPServer",
  "command": "yarn",
  "args": ["dev"]
}

配置参数说明:

  • 'serverName': MCP 服务器的名称，定义在 'src/mcp-server.ts' 文件中，示例中为 "ExampleMCPServer"。
  • 'command': 启动 MCP 服务器的命令。由于项目使用了 Yarn 包管理器，这里设置为 "yarn"。
  • 'args': 传递给启动命令的参数。'["dev"]' 表示使用 'yarn dev' 命令启动服务器，即开发模式。你也可以使用 '["start"]' 来配置生产模式启动 ('yarn start')。

基本使用方法

  1. 启动服务器: 在仓库目录下，根据需要选择开发或生产模式启动服务器。

    • 开发模式: 运行 'yarn dev' 命令。服务器将启动并包含 MCP inspector，方便调试。
    • 生产模式: 运行 'yarn start' 命令。服务器将以生产模式启动。 服务器默认监听 3001 端口。你可以通过设置 'PORT' 环境变量来修改端口，例如 'PORT=5000 yarn start'。

  2. 配置 MCP 客户端: 在你的 MCP 客户端应用中，配置连接到 express-mcp-sse-server 服务器。客户端需要连接到服务器的 '/sse' 端点 (例如 'http://localhost:3001/sse') 以建立 SSE 连接，并通过 '/messages' 端点发送 MCP 请求。

  3. 资源访问: 该示例服务器预置了名为 'document' 的资源。客户端可以向服务器请求访问 'document://getting-started' 资源，服务器将返回 "Getting Started" 文本内容。

信息

分类

AI与计算

访问项目