README
🚀 WHOOP MCP 服务器
本项目是一个实现 WHOOP API 的 MCP(机器对话协议)服务器,可与 WHOOP API 对接,让您轻松访问 WHOOP 健身数据。同时,它遵循 MCP 架构模式,支持人工智能助手进行互操作。
🚀 快速开始
该项目提供了一个与 WHOOP API 对接的服务器,允许您访问 WHOOP 健身数据。它遵循 MCP 架构模式,使人工智能助手能够互操作。
✨ 主要特性
- 访问 WHOOP 用户个人资料数据
- 获取睡眠数据和分析
- 检索锻炼信息
- 查看恢复指标
- 浏览周期数据
📦 安装指南
先决条件
- Node.js(v16+)
- 带有 API 访问权限的 WHOOP 账户
- 从 WHOOP 开发者门户获得的 WHOOP API 密钥
安装步骤
-
克隆此仓库:
git clone https://github.com/RyanLisse/whoop-mcp-server.git cd whoop-mcp-server -
安装依赖项:
npm install -
基于
.env.example模板创建一个.env文件:cp .env.example .env -
编辑
.env文件并添加您的 WHOOP API 密钥和其他配置选项。
💻 使用示例
启动服务器
npm start
用于开发环境的自动重启:
npm run dev
服务器将在您 .env 文件中指定的端口上运行(默认:3000)。
API 端点
所有 API 端点都需要使用 WHOOP API 密钥进行身份验证。
基础用法
- 用户个人资料:
GET /whoop/profile- 获取用户个人资料信息 - 睡眠数据:
GET /whoop/sleep?start_date=YYYY-MM-DD&end_date=YYYY-MM-DD- 获取指定日期范围内的睡眠数据 - 锻炼数据:
GET /whoop/workouts?start_date=YYYY-MM-DD&end_date=YYYY-MM-DD- 获取指定日期范围内的锻炼数据 - 恢复数据:
GET /whoop/recovery?start_date=YYYY-MM-DD&end_date=YYYY-MM-DD- 获取指定日期范围内的恢复数据 - 周期数据:
GET /whoop/cycles?start_date=YYYY-MM-DD&end_date=YYYY-MM-DD- 获取指定日期范围内的周期数据
🔧 认证
在您的请求中添加 WHOOP API 令牌到 Authorization 标头:
Authorization: Bearer YOUR_WHOOP_API_TOKEN
📄 许可证
本项目采用 MIT 许可证。
👥 贡献
欢迎大家积极贡献!请随意提交 Pull Request。
Scan to join WeChat group