使用说明

项目简介

mcp-time 是一个基于 Model Context Protocol (MCP) 的简单服务器,专门为 LLM 应用提供当前时间的获取功能。作为一个 MCP 服务器,它遵循 JSON-RPC 协议与客户端通信,并提供单一工具 'getCurrentTime' 以获取日本标准时间 (JST)。

主要功能点

  • 获取当前时间 (JST): 提供 'getCurrentTime' 工具,允许 LLM 客户端请求并获取 YYYY-MM-DD HH:MM:SS 格式的日本标准时间。
  • JSON-RPC 接口: 使用标准的 JSON-RPC 2.0 协议进行通信,易于集成到支持 MCP 协议的 LLM 客户端。
  • 轻量级实现: 代码简洁,依赖少,易于安装和部署。

安装步骤

  1. 安装 Node.js 和 npm: 确保你的系统已安装 Node.js 和 npm (Node.js 包管理器)。
  2. 安装 mcp-time: 打开终端,运行以下命令全局安装 'mcp-time':
    npm install -g mcp-time
    或者,你也可以选择克隆仓库后在本地安装:
    git clone https://github.com/ZeparHyfar/mcp-time.git
    cd mcp-time
    npm install

服务器配置

MCP 客户端需要配置以下 JSON 信息以连接到 'mcp-time' 服务器。这个配置告诉 MCP 客户端如何启动和连接到时间服务器。

{
  "serverName": "mcp-time-server",  // 服务器名称,可以自定义,用于在客户端中标识
  "command": "npm",                 // 启动服务器的命令,这里使用 npm
  "args": ["start"],                // 启动命令的参数,npm start 会执行 package.json 中定义的 start 脚本
  "protocol": "stdio",              // 通信协议,这里使用标准输入输出 (stdio)
  "description": "提供当前时间的 MCP 服务器" // 服务器描述,可选
}

参数注释:

  • 'serverName': 为你的 MCP 服务器指定一个易于识别的名字。
  • 'command': 指定用于启动服务器进程的可执行命令。通常是 Node.js 项目的 'npm' 或 'node'。
  • 'args': 一个字符串数组,包含传递给 'command' 的参数。'npm start' 命令会执行 'package.json' 中 scripts 字段下定义的 'start' 脚本。对于 'mcp-time','npm start' 会启动服务器。
  • 'protocol': 指定 MCP 客户端与服务器通信的方式。'stdio' 表示使用标准输入和输出流进行通信,这是 'mcp-time' 服务器使用的协议。
  • 'description': 对服务器的简短描述,方便用户理解其用途。

基本使用方法

  1. 启动服务器: 在安装 'mcp-time' 后,如果全局安装,可以直接在终端运行 'mcp-time' 命令启动服务器 (实际上 'package.json' 中的 'start' 脚本就是 'node src/index.ts')。 如果是本地安装,则需要在项目目录下运行 'npm start'。 服务器默认监听标准输入,并将响应输出到标准输出。

  2. 客户端发送 JSON-RPC 请求: MCP 客户端需要构造符合 JSON-RPC 格式的请求,并通过标准输入发送给 'mcp-time' 服务器。例如,请求获取当前时间的 JSON-RPC 请求如下:

    {"jsonrpc": "2.0", "method": "getCurrentTime", "params": null, "id": 1}
  3. 接收 JSON-RPC 响应: 'mcp-time' 服务器会将 JSON-RPC 响应通过标准输出返回给客户端。例如,成功获取时间的响应可能如下:

    {"jsonrpc":"2.0","result":{"time":"2024-10-27 10:30:45","success":true},"id":1}

注意: 'mcp-time' 服务器设计为通过标准输入/输出来进行 JSON-RPC 通信,通常与支持 MCP 协议的 LLM 客户端集成使用。你需要将上面提供的服务器配置信息填入到你的 MCP 客户端中,客户端会自动启动 'mcp-time' 服务器并与之通信。

信息

分类

开发者工具