关键词

时间显示工具调用Stdio传输JSON-RPCDemo示例

使用说明

项目简介

本项目 'ModelContextProtocol_DemoServer' 是一个演示性质的 MCP (Model Context Protocol) 服务器实现。它提供了一个简单的工具 'get-current-time'，允许 MCP 客户端请求服务器获取当前时间。这个项目旨在帮助开发者理解 MCP 服务器的基本结构和工作原理，并展示如何使用 '@modelcontextprotocol/sdk' 库构建 MCP 服务器。

主要功能点

  • 提供时间获取工具: 注册了一个名为 'get-current-time' 的工具，客户端可以调用此工具获取服务器当前时间。
  • 支持时间格式化: 'get-current-time' 工具支持可选的 'format' 参数，允许客户端指定返回时间的格式（完整时间、日期或时间）。
  • 使用 Stdio 传输协议: 服务器使用标准的 Stdio (标准输入输出) 作为 MCP 通信的传输协议，方便本地测试和集成。
  • 基于 JSON-RPC 协议: 虽然代码中没有显式展示 JSON-RPC 的细节，但 MCP 协议本身基于 JSON-RPC，服务器底层按照 MCP 协议规范处理请求和响应。

安装步骤

  1. 安装 Bun: 确保你的系统已安装 Bun JavaScript 运行时环境。你可以访问 https://bun.sh 了解安装方法。
  2. 安装依赖: 在项目根目录下，打开终端并执行以下命令安装项目依赖： 
    bun install

服务器配置

MCP 客户端需要配置以下信息才能连接到此服务器。以下是 JSON 格式的配置信息，请提供给你的 MCP 客户端（例如 Cursor 编辑器）：

{
  "serverName": "时间显示服务器",  // 服务器名称，与 server.js 中定义的名称一致
  "command": "bun",             // 启动服务器的命令，这里使用 bun 运行时
  "args": [                     // 启动命令的参数
    "run",                      // bun run 命令用于运行脚本
    "src/server.js"             // 服务器脚本的路径
  ]
}

配置说明:

  • 'serverName': MCP 服务器的名称，用于在客户端标识服务器。
  • 'command': 启动服务器进程的可执行命令，这里是 'bun'。
  • 'args': 传递给 'command' 的参数列表。'run src/server.js' 指示 Bun 运行时执行 'src/server.js' 文件。

请注意: 你需要将上述 JSON 配置信息填入你的 MCP 客户端的服务器配置中。具体的配置位置和方法请参考你使用的 MCP 客户端的文档。

基本使用方法

  1. 启动服务器: 在项目根目录下，打开终端并执行以下命令启动 MCP 服务器： 
    bun run src/server.js
    启动成功后，你会在终端看到 "時間表示MCPサーバーが起動しました。" 的提示信息。
  2. 配置 MCP 客户端: 将上面提供的服务器配置 JSON 信息添加到你的 MCP 客户端中，并确保客户端已连接到该服务器。
  3. 调用工具: 在 MCP 客户端中，你可以通过特定的方式（取决于客户端的具体实现，例如在聊天对话中输入特定指令）调用 'get-current-time' 工具。
  4. 获取时间: 服务器会返回当前时间，客户端会根据返回的信息进行展示或使用。

例如，如果你的 MCP 客户端支持在聊天中使用工具，你可能会被告知可以使用类似 '@工具名(参数)' 的语法来调用工具。对于本服务器，你可能可以使用 '@get-current-time' 或 '@get-current-time(format="date")' 等指令来获取不同格式的时间。 具体的使用方式请参考你使用的 MCP 客户端的文档。

信息

分类

开发者工具

访问项目