使用说明(Markdown 格式)

  • 项目简介

    • poly-queue-mcp 是一个基于 Model Context Protocol (MCP) 的后端服务器,旨在将多种消息队列系统通过统一的工具接口暴露给 LLM 客户端,提供资源管理、工具调用以及 Prompt 模板渲染等上下文服务,供对话型应用使用。
  • 主要功能点

    • 通过 MCP JSON-RPC 接口向客户端暴露“资源”和“工具”集合,以及用于渲染 Prompt 的能力。
    • 集成多种消息队列适配器(如 Redis Streams、RabbitMQ、NATS 等),将它们作为工具供 MCP 客户端调用。
    • 服务器端负责会话管理、能力声明,并支持通过标准传输(如 STDIO)实现与客户端的通信。
    • 提供多种实现入口:Node.js 版本的 index.js(标准 MCP 服务器实现)以及 ReScript 编译版本 main.js(MCP 服务器入口,基于 McpServer)。
    • 适配器实现包含连接、状态管理、工具定义和处理逻辑,能够对外暴露具体的队列操作工具。
  • 安装步骤

    • 需要在运行环境中安装 Node.js 环境及必要依赖(仓库中包含对应的依赖配置)。
    • 克隆或下载仓库后,执行安装依赖:
      • npm install
    • 启动服务器(样例入口之一):
      • node main.js
      • 或 node index.js
    • 启动后服务器会输出启动信息,表示 MCP 服务器已经就绪并监听 STDIO 传输。
  • 服务器配置(MCP 客户端配置示例)

    • MCP 客户端需要了解服务器的启动命令以及参数,用于建立连接。下面给出符合仓库信息的配置示例(JSON格式): { "server_name": "poly-queue-mcp", "command": "node", "args": ["main.js"] } 注释:
    • server_name 对应服务器的名称,需与运行时输出中的名称保持一致。
    • command 为启动服务器的可执行程序(此处为 node)。
    • args 为启动命令的参数,指向入口脚本(此处为 main.js,若使用 index.js 启动,请将引导脚本改为 index.js)。 MCP 客户端不需要了解内部实现细节,只需知道上述启动信息即可在需要时调用工具、查询资源、执行工具。
  • 基本使用方法

    • 启动 MCP 服务器后,MCP 客户端通过 JSON-RPC 方式向服务器请求工具列表、调用工具、获取和渲染 Prompts 等。
    • 使用工具时,客户端首先获取工具列表(ListTools),再根据名称调用具体工具(CallTool),传入所需参数。
    • 适配器提供的工具会在服务器端被注册,客户端调用时会得到工具执行结果或错误信息。
    • 如需扩展新的消息队列支持,只需实现对应适配器并导出工具,服务器启动后即可自动暴露新工具。

信息

分类

AI与计算