以下为简要使用指引,便于开发者快速理解与部署该 MCP 服务器实现。
项目简介
- 通过 @modelcontextprotocol/sdk 提供的 MCP 服务器能力,注册并暴露一个简单工具(hello),并通过标准输入/输出(stdio)传输与客户端通信。
- 服务器示例展示了如何初始化 MCP 服务器、声明能力(资源、工具)、注册工具,以及通过 StdioServerTransport 启动。
主要功能点
- MCP 服务器核心搭建:创建并配置 MCP 服务器实例,声明名称、版本及能力。
- 工具注册与执行:注册一个简单的 hello 工具,返回文本内容,演示工具的输入/输出结构。
- 标准传输支持:使用 StdioServerTransport,通过 STDIO 进行客户端连接与通信,便于本地测试与调试。
- 会话与能力声明:具备基本的资源与工具能力声明,方便后续扩展。
- 易扩展性:可在此基础上增加更多资源、工具和提示模板,构建更完整的 MCP 服务端。
安装步骤
- 确保系统已安装 Node.js(推荐使用 Node.js 的长期支持版本)。
- 安装依赖并编译(若项目是 TypeScript,需要安装依赖并编译为可执行 JS 文件):
- 安装依赖
- 编译/构建(若有构建步骤)并生成可执行入口,例如 dist/index.js
服务器配置(给 MCP 客户端的连接信息)
MCP 客户端通常需要提供服务器的启动命令及参数以建立连接。以下为针对该仓库实现的示例配置信息(以 JSON 形式展示,便于直观理解,实际使用时请按客户端需求解析):
{ "server_name": "mcp-server-starter", "command": "node", "args": ["dist/index.js"] }
注释:
- server_name 与实现中的 server 名称一致,确保客户端在连接时能够正确识别目标服务器。
- command 与 args 指向服务器入口的执行命令与参数。由于该实现使用 StdIO 传输,入口通常位于编译后产物的 dist/index.js(TypeScript 项目需要先编译)。
- 该配置仅用于 MCP 客户端的连接指引,实际客户端连接不需要将此配置作为代码运行,而是由客户端读取并执行相应的启动命令。
基本使用方法
- 将服务器代码准备就绪并编译(若使用 TypeScript),生成入口文件 dist/index.js。
- 通过命令行启动服务器(示例:node dist/index.js),服务器将监听 StdIO 传输并等待客户端连接。
- 连接成功后,客户端可以调用注册的工具(如 hello)等,服务器将按 MCP 协议返回响应。
- 如需扩展,可在代码中继续注册更多工具、资源,以及添加提示模板/上下文逻辑。
信息
分类
AI与计算