使用说明

项目简介

本项目 'mcp-time' 是一个实现了 Model Context Protocol (MCP) 的简单服务器,它向 LLM 客户端提供当前时间的工具。该服务器设计简洁,专注于提供单一但实用的功能:获取当前 UTC 时间。它使用标准的 MCP 协议与客户端通信,易于集成到支持 MCP 协议的 LLM 应用中,例如 Claude 桌面应用。

主要功能点

  • 获取当前时间 (UTC): 提供一个名为 'getCurrentTime' 的工具,LLM 客户端可以调用此工具来获取当前时间的 UTC 格式字符串。

安装步骤

  1. 安装 Node.js 和 npm: 确保你的系统已安装 Node.js 和 npm (Node Package Manager)。你可以从 nodejs.org 下载并安装。
  2. 安装 'mcp-time': 打开终端或命令提示符,运行以下命令全局安装 'mcp-time' 包:
    npm install -g mcp-time

服务器配置

为了让 MCP 客户端(例如 Claude)连接到 'mcp-time' 服务器,你需要配置客户端的服务器设置。以下是一个 JSON 格式的配置示例,你需要将其添加到你的 MCP 客户端配置中。

{
  "serverName": "time-server",  // 服务器名称,与 server.js 中定义的 name 一致
  "command": "mcp-time",      // 启动服务器的命令,这里假设 mcp-time 已全局安装
  "args": ["start"],          // 启动命令的参数,这里使用 "start" 子命令启动服务器
  "transport": "stdio"         // 使用 stdio 作为传输协议,与 server.js 中的 StdioServerTransport 一致
}

配置参数说明:

  • 'serverName': 服务器的名称,必须与 'dist/server.js' 或 'src/server.ts' 中 'Server' 构造函数的 'name' 字段保持一致 ('"time-server"').
  • 'command': 启动 MCP 服务器的可执行命令。全局安装 'mcp-time' 后,可以直接使用 'mcp-time' 命令。
  • 'args': 传递给启动命令的参数。根据 'README.md' 和 'package.json' 中的 'scripts' 字段,使用 'start' 参数来启动服务器。
  • 'transport': 指定 MCP 服务器使用的传输协议。'mcp-time' 使用 'stdio' (标准输入/输出) 协议。

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

基本使用方法

  1. 启动服务器: 在全局安装 'mcp-time' 后,MCP 服务器会在客户端尝试连接时自动启动 (根据客户端的具体实现,可能需要手动启动,但通常客户端会负责启动配置的 MCP 服务器)。
  2. 在 LLM 中调用工具: 当服务器运行后,在支持 MCP 工具调用的 LLM 应用中,你可以指示 LLM 调用 'getCurrentTime' 工具。例如,你可以向 LLM 提问 "现在是什么时间?",如果 LLM 配置正确并能够识别 'mcp-time' 服务器提供的工具,它应该能够调用 'getCurrentTime' 工具并返回当前 UTC 时间。

示例对话 (在支持 MCP 的 LLM 应用中):

用户: 现在是什么时间? LLM: (调用 'getCurrentTime' 工具) 当前时间是 '2024-10-27T10:30:00.000Z' (示例时间,实际返回当前 UTC 时间)。

开发说明 (可选)

如果你想修改或扩展 'mcp-time' 服务器,可以按照 'README.md' 中的开发步骤进行:

  1. 克隆仓库: 'git clone https://github.com/PhialsBasement/mcp-time.git'
  2. 安装依赖: 'cd mcp-time && npm install'
  3. 启动开发服务器: 'npm run dev'

修改 'src/server.ts' 文件后,你需要重新构建项目 ('npm run build') 以更新 'dist/server.js'。

信息

分类

网页与API