使用说明
项目简介
这是一个使用Node.js编写的基础MCP服务器,旨在演示Model Context Protocol (MCP) 的核心功能。它提供了一个名为 'getSecretPassphrase' 的工具,该工具能生成一个随机的美国州名和与其相关的特色汤品组合,例如 "Louisiana Gumbo"。此服务器使用 JSON-RPC 2.0 协议通过标准输入/输出 (STDIO) 与 MCP 客户端通信。
主要功能点
- MCP协议实现: 实现了MCP协议的基本服务器端功能,能够接收和处理符合MCP协议的JSON-RPC请求。
- 工具注册与执行: 注册并提供了一个名为 'getSecretPassphrase' 的工具,客户端可以调用此工具获取随机的州和汤品组合。
- JSON-RPC over STDIO: 使用标准的 JSON-RPC 2.0 协议,通过 STDIO 进行客户端和服务器之间的通信。
- 日志记录: 具备基础的日志记录功能,方便调试和监控服务器运行状态。
安装步骤
- 克隆仓库: 打开终端,执行以下命令克隆仓库到本地:
git clone [email protected]/gbti-network/mcp-basic-test.git cd mcp-basic-test - 安装依赖: 在项目根目录下,运行 npm 命令安装项目依赖:
npm install
服务器配置
要将此 MCP 服务器与 MCP 客户端(例如 Cascade)配合使用,您需要在客户端配置中指定服务器的启动命令。以下是一个 JSON 格式的配置示例,您需要将其添加到 MCP 客户端的配置文件中。
{ "serverName": "super-secret", "command": "npx", "args": [ "--yes", "node", "<项目路径>/index.js" ] }
配置参数说明:
- 'serverName': 为您的 MCP 服务器配置指定一个唯一的名称,例如 "super-secret",客户端将使用此名称来引用该服务器。
- 'command': 启动服务器的命令,这里使用 'npx',它可以方便地运行本地安装的 npm 包。
- 'args': 一个字符串数组,包含了启动服务器所需的命令行参数:
- '--yes': 自动同意执行 npm 包 (inspector)
- 'node': 指定使用 Node.js 环境来运行服务器。
- '<项目路径>/index.js': 指向服务器主文件 'index.js' 的路径。请务必将 '<项目路径>' 替换为您克隆仓库后 'index.js' 文件在您本地文件系统中的实际路径。 例如,如果您的项目放在用户根目录下的 'mcp-basic-test' 文件夹中,则路径可能类似于 '/Users/yourusername/mcp-basic-test/index.js' (macOS/Linux) 或 'C:\Users\YourUsername\mcp-basic-test\index.js' (Windows)。
重要提示: 请根据您的实际项目存放路径修改 '<项目路径>/index.js',确保客户端能够正确找到并启动服务器。
基本使用方法
- 启动服务器: 在 MCP 客户端中配置好上述服务器信息后,启动您的 MCP 客户端。客户端会根据配置的命令启动 MCP 服务器。
- 连接与交互: 客户端通过 STDIO 与服务器建立连接。您可以使用 MCP 客户端的功能来:
- 列出工具: 查询服务器注册的工具列表,您应该能看到 'getSecretPassphrase' 工具。
- 调用工具: 调用 'getSecretPassphrase' 工具,服务器会返回一个包含随机州和汤品组合的结果。
例如,您可以使用 MCP Inspector 工具进行测试。在终端中运行 'npx @modelcontextprotocol/inspector -- node index.js' 即可启动 Inspector 并连接到此 MCP 服务器。然后,您可以在 Inspector 的界面中发送 MCP 请求并查看服务器的响应。
信息
分类
开发者工具