使用说明

项目简介

Clock MCP Server 是一个实现了 Model Context Protocol (MCP) 的后端服务器,专注于提供时间相关的功能。它通过 MCP 协议与客户端通信,允许客户端调用预定义好的工具来获取时间信息。

主要功能点

  • 获取当前时间:返回服务器所在时区的本地时间和UTC时间,方便客户端进行时间同步或显示。
  • 获取指定时区的时间:允许客户端查询特定时区的时间,并支持多种时间格式(ISO, Locale, Unix时间戳)和12/24小时制选择。
  • 获取支持的时区列表:提供服务器支持的时区列表,方便客户端了解可查询的时区范围。
  • 完善的日志系统:内置详细的日志记录,方便服务器运维和问题排查。
  • 灵活的日志级别配置:可以通过环境变量调整日志输出级别,满足不同环境的需求。

安装步骤

  1. 克隆仓库

    git clone https://github.com/4ier/clock-mcp.git
    cd clock-mcp
  2. 安装依赖 确保已安装 Node.js 和 npm,然后运行:

    npm install
  3. 构建项目

    npm run build

服务器配置

对于 MCP 客户端,需要配置连接到 Clock MCP Server 的信息。以下是一个 JSON 格式的配置示例,你需要将其添加到你的 MCP 客户端配置中。

{
  "serverName": "clock-mcp",
  "command": "node",
  "args": ["build/index.js"],
  "env": {
    "LOG_LEVEL": "INFO"
  },
  "transport": "stdio"
}

配置参数说明:

  • 'serverName': 服务器的名称,可以自定义,用于在客户端标识该服务器。
  • 'command': 启动服务器的命令,这里使用 'node' 来运行 JavaScript 代码。
  • 'args': 命令的参数,'build/index.js' 是构建后服务器的入口文件路径。
  • 'env': 环境变量配置,'LOG_LEVEL' 用于设置日志级别,可选值包括 'DEBUG', 'INFO', 'WARN', 'ERROR'。默认为 'DEBUG'。可以根据需要调整日志级别,例如在生产环境设置为 'INFO' 或 'WARN'。
  • 'transport': 传输协议,这里使用 'stdio',表示通过标准输入输出流进行通信。

注意: 请确保你的 MCP 客户端支持 'stdio' 传输协议。

基本使用方法

启动 Clock MCP Server 后,在你的 MCP 客户端中,你可以调用以下工具来获取时间信息:

  1. getCurrentTime: 获取当前时间(本地时区和UTC时间)。

    const result = await client.callTool({ name: "getCurrentTime" });
    console.log(result);
  2. getTimeInTimezone: 获取指定时区的时间。

    const result = await client.callTool({
      name: "getTimeInTimezone",
      arguments: {
        timezone: "America/New_York",
        format: "locale",
        hour12: true
      }
    });
    console.log(result);
  3. getSupportedTimezones: 获取支持的时区列表。

    const result = await client.callTool({ name: "getSupportedTimezones" });
    console.log(result);

请参考仓库的 README.md 文件和代码示例获取更详细的使用信息。

信息

分类

网页与API