使用说明

项目简介

本项目是一个使用 '@modelcontextprotocol/sdk' 官方库构建的最小化 MCP 服务器示例,旨在帮助开发者快速理解和上手 MCP 服务器的开发。它提供了一个简单的 "hello_world" 工具作为演示,展示了 MCP 服务器的基本功能。

主要功能点

  • 基于官方SDK: 使用 '@modelcontextprotocol/sdk' 库,保证了与 MCP 协议的兼容性和规范性。
  • 工具注册与执行: 实现了工具 (Tools) 的注册和执行功能,允许客户端调用服务器端提供的功能。示例中提供了一个简单的 'hello_world' 工具。
  • 最小化实现: 代码简洁易懂,只有一个 'server.js' 文件,方便学习和二次开发。
  • Stdio传输: 使用 Stdio (标准输入输出) 作为传输协议,简化了部署和运行。

安装步骤

  1. 克隆仓库: 将仓库 'minimal-mcp-server' 克隆到本地。
    git clone https://github.com/LeZuse/minimal-mcp-server.git
    cd minimal-mcp-server
  2. 安装依赖: 使用 npm 安装项目依赖。
    npm install

服务器配置

MCP 客户端(例如 Cursor IDE)需要配置以下信息来连接到此 MCP 服务器。以下是配置示例(JSON 格式):

{
  "serverName": "minimal-mcp-server",  // MCP 服务器的名称,与 server.js 中定义的 server.name 一致
  "command": "node",                  // 启动服务器的命令,这里使用 Node.js 运行 server.js
  "args": ["server.js"]               // 启动命令的参数,指定要运行的服务器文件为 server.js
}

配置说明:

  • 'serverName': 服务器名称,应与 'server.js' 中 'McpServer' 构造函数中 'name' 字段的值保持一致。
  • 'command': 启动服务器进程的命令。由于服务器是 Node.js 应用,因此使用 'node' 命令。
  • 'args': 传递给启动命令的参数,这里指定了服务器入口文件 'server.js'。

在 Cursor IDE 中配置:

  1. 打开 Cursor IDE 的设置 (Settings)。
  2. 搜索 "Project Managed" 或 "MCP Server"。
  3. 找到 "minimal-mcp-server" (或您自定义的 'serverName'),点击 "Enable"。
  4. 复制上面的 JSON 配置信息到相应的配置框中。

基本使用方法

  1. 启动服务器: 无需手动启动服务器,当在 Cursor IDE 中启用 "minimal-mcp-server" 后,Cursor 会根据配置自动启动服务器。
  2. 调用工具: 在 Cursor IDE 中,您可以通过编辑器命令或快捷键触发 MCP 功能。例如,您可以尝试调用 'hello_world' 工具。具体调用方式取决于 Cursor IDE 如何集成 MCP 工具。通常,您可以在编辑器中输入 '/' 或其他特定字符来触发工具列表,并选择 'hello_world' 工具。
  3. 查看结果: 工具执行结果(例如 "Hello, World!" 或 "Hello, [Your Name]!") 将会以文本形式返回到 Cursor IDE 中,具体显示方式取决于 Cursor IDE 的实现。

注意:

  • 本示例仅包含一个简单的 'hello_world' 工具,您可以根据需要扩展 'server.js' 文件,添加更多工具、资源和 Prompt 模板。
  • 详细的 MCP 客户端使用方法请参考 Cursor IDE 或其他 MCP 客户端的文档。

信息

分类

开发者工具