使用说明

项目简介

Garmin MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在将您的 Garmin Connect 账户中的健身和健康数据连接到支持 MCP 协议的 LLM 客户端,例如 Claude。通过此服务器,您可以让 LLM 访问您的活动记录、健康指标、睡眠数据等,从而实现更智能的健康和健身助手应用。

主要功能点

  • 活动数据访问: 获取最近的活动列表、详细的活动信息(如跑步、骑行等)。
  • 健康指标: 访问步数、心率、睡眠数据等健康指标。
  • 身体成分数据: 查看体重、体脂率等身体成分信息。
  • 设备和用户数据: 获取Garmin设备信息、用户个人资料等。
  • 模块化设计: 功能模块化,易于扩展和维护,包含活动管理、健康与福祉、用户资料、设备、装备管理、体重管理、挑战、训练、锻炼、数据管理和女性健康等多个模块。

安装步骤

  1. 创建虚拟环境 (推荐): 为了隔离项目依赖,建议创建一个新的虚拟环境。
    virtualenv .venv
    source .venv/bin/activate  # 或根据你的系统使用 .venv\Scripts\activate
  2. 安装依赖: 使用 'pip' 安装项目所需的 Python 包。
    python -m pip install -r requirements.txt
  3. 配置 Garmin 凭据: 在项目根目录下创建 '.env' 文件,并填入您的 Garmin Connect 账户邮箱和密码。请务必妥善保管此文件,不要将其泄露或提交到代码仓库。
    [email protected]
    GARMIN_PASSWORD=your-password

服务器配置

要让 MCP 客户端(如 Claude Desktop)连接到 garmin_mcp 服务器,您需要在客户端中配置服务器信息。以下是 Claude Desktop 的配置示例,您需要编辑 Claude Desktop 的配置文件 'claude_desktop_config.json',并添加 'mcpServers' 配置项。

Claude Desktop 配置文件路径:

  • macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
  • Windows: '%APPDATA%\Claude\claude_desktop_config.json'

服务器配置 JSON 代码:

{
  "mcpServers": {
    "garmin": {
      "command": "python",
      "args": ["<your_path_to>/garmin_mcp/garmin_mcp_server.py"]
    }
  }
}

配置参数说明:

  • 'server name': '"garmin"' (服务器名称,可以自定义,例如 "garmin")
  • 'command': '"python"' (启动服务器的命令,通常是 'python')
  • 'args': '["<your_path_to>/garmin_mcp/garmin_mcp_server.py"]' (启动命令的参数,指向 'garmin_mcp_server.py' 脚本的绝对路径,请将 '<your_path_to>' 替换为 garmin_mcp 项目在您电脑上的实际路径)

配置完成后,重启 Claude Desktop 以应用新的服务器配置。

基本使用方法

成功配置并启动 garmin_mcp 服务器后,您可以在 MCP 客户端(如 Claude)中,通过自然语言指令访问您的 Garmin 数据。

使用示例 (在 Claude 中提问):

  • "Show me my recent activities" (显示我最近的活动)
  • "What was my sleep like last night?" (我昨晚睡得怎么样?)
  • "How many steps did I take yesterday?" (我昨天走了多少步?)
  • "Show me the details of my latest run" (显示我最近一次跑步的详细信息)
  • "What is my training readiness today?" (我今天的训练准备度如何?)
  • "Get my body composition data for last week." (获取我上周的身体成分数据)

通过这些指令,您可以与 LLM 交互,查询和分析您的 Garmin Connect 数据,从而更好地了解您的健康和运动状况。

注意: 首次使用可能需要 Garmin Connect 进行额外的身份验证。如果遇到登录问题,请检查您的凭据是否正确,并确保您的 Garmin Connect 账户没有异常。

信息

分类

桌面与硬件