使用说明(Markdown 格式)
-
项目简介
- 这是一个基于 MCP 的服务器示例集合,包含多个演示用服务器,展示如何注册工具、暴露资源、处理来自 MCP 客户端的请求,以及在不同传输通道上进行通信。
-
主要功能点
- 资源与工具管理:服务器可注册工具(Tools),并对外提供工具名称、描述及输入结构,支持工具调用与输出总结。
- MCP 风格通信:服务器按 MCP 约定处理请求与响应,支持 JSON-RPC 式交互模型,便于与 LLM 客户端或代理对接。
- 多传输协议支持:示例中包含通过标准输入输出、SSE、Streamable HTTP 等传输方式的服务器实现,方便在不同部署场景使用。
- 简易示例服务器:包含简单的工具(如 echo、env 读取、计算等)以便快速上手测试。
- 流式输出与总结:工具输出可被系统汇总并返回给调用端,便于控制大输出信息的传递。
-
安装步骤
- 克隆仓库并进入相关示例子模块目录(例如 testkit-mcp-server)。
- 安装依赖(如 TypeScript、MCP SDK 等)。
- 编译 TypeScript 代码(如果需要),生成可执行的 JS 文件。
- 运行示例服务器(例如使用标准输入输出传输的示例,或根据需要选择 SSE/Streamable HTTP 传输的实现)。
- 启动后,使用 MCPX 客户端连接到服务器,进行工具注册与调用测试。
-
服务器配置(MCP 服务端配置说明)
- MCP 服务器的启动配置通常包括以下字段:
- server name(服务器名称,用于标识该 MCP 服务端)
- command(执行服务器的命令,如 node)
- args(命令参数,例如用于启动服务的脚本文件,如 server.js)
- env(环境变量,可选)
- type(服务器类型,如 stdio、sse、streamable-http,决定传输方式)
- 说明示例(以文字描述形式给出,不直接展示代码)
- 名称:test::echo,描述:Echo Tool 测试服务器
- 启动命令:node
- 启动参数:["dist/echo.js"] 或 ["server.js"](具体路径按实际编译结果而定)
- 传输类型:stdio(标准输入/输出)用于本地快速测试;也可以选择 SSE 或 Streamable-HTTP 以适配远程调用
- 其他:可设置环境变量如 NODE_ENV、自定义图标等
- 重要注意:MCP 客户端在连接服务器时需要提供服务器的启动信息(如上描述中的 name、command、args 等)来建立交互。配置信息旨在帮助运维或开发者复现服务器端环境,实际的运行细节由 MCP 客户端决定。
- MCP 服务器的启动配置通常包括以下字段:
-
基本使用方法
- 启动服务器示例:按照示例中的配置将服务器以指定传输方式启动(如_stdio),然后使用 MCPX 客户端连接并调用工具。
- 使用工具:客户端向 MCP 服务器发起工具调用请求,服务器根据工具输入执行相应逻辑,返回文本或结构化输出。
- 调试与扩展:可在现有工具基础上添加更多功能,更新工具输入输出结构,并通过 MCP 协议进行交互。
-
额外信息
- 仓库中包含了若干演示用的 MCP 服务器示例(如 echo、env 读取、计算器、OAuth 模拟等),可用作快速上手与集成测试的起点。
- 如需在生产场景部署,请结合 Lunar 提供的网关/聚合能力以及性能、并发与安全策略进行扩展。
信息
分类
AI与计算