Garmin Documentation MCP Server

🚀 Garmin文档MCP服务器

Garmin文档MCP服务器（Model Context Protocol）专为Claude等AI助手打造，提供对Garmin Connect IQ SDK 8.2.3完整文档生态系统的全面离线访问。

✨ 主要特性

• 🚀 完全离线：使用本地文档，无需联网！
• 📚 完整文档：可访问API文档、编程指南、设备参考、常见问题解答和视觉资源（1407 +个文件）。
• 🔍 增强搜索：支持模糊匹配和交叉引用的深度语义搜索。
• ⚡ 快速响应：本地解析和索引，即时给出结果。
• 🎯 准确版本管理：正确映射API级别与SDK版本（解决常见的版本混淆问题）。
• 📱 设备特定信息：提供硬件功能、内存限制和圆形设备支持等信息。
• 📖 编程指南：包含入门教程、调试、测试和最佳实践。
• ❓ 常见问题解答和故障排除：涵盖字体、内存、图形等常见问题。

v1.0.1 新特性

• ✨ 修复API级别混淆：现在正确显示API Level 4.2.0 (≈ SDK 6.x+)，避免了误导性的版本信息。
• ✨ 修复模块函数问题：修复了关键漏洞，现在可以正确找到所有模块级函数（如Math.stdev、Cryptography.createPublicKey等）。
• ✨ 新增3个工具：设备参考搜索、编程指南和常见问题解答搜索。
• ✨ 增强覆盖范围：现在对编程指南、设备文档、常见问题解答资源和个性库进行索引。
• ✨ 优化搜索结果：在主搜索中包含指南内容，并提供全面的交叉引用。

📦 安装指南

1. 克隆或下载此仓库。
2. 将Garmin Connect IQ SDK 8.2.3文档复制到项目根目录的docs/文件夹中。
3. 安装依赖：

npm install

4. 构建项目：

npm run build

⚠️ 重要提示

首次运行时，服务器将自动解析和索引所有文档文件。初始过程可能需要几秒钟，但后续运行将立即响应。

💻 使用示例

启动服务器

开发环境：

npm run dev

生产环境：

npm start

为Claude Code配置（推荐）

使用Claude Code CLI添加MCP服务器：

# 添加服务器（可从任何目录运行）
claude mcp add garmin-documentation /path/to/garmin-documentation-mcp-server/dist/index.js

# 或者在项目范围内添加以进行团队协作
claude mcp add --scope project garmin-documentation /path/to/garmin-documentation-mcp-server/dist/index.js

验证安装：

claude mcp list

为Claude Desktop配置

将此服务器添加到Claude Desktop配置文件中：

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

{
  "mcpServers": {
    "garmin-documentation": {
      "command": "node",
      "args": ["/path/to/garmin-documentation-mcp-server/dist/index.js"]
    }
  }
}

请将/path/to/garmin-documentation-mcp-server替换为实际的安装路径。

可用工具

核心API工具

• search_garmin_docs：对模块、类、方法、属性、常量和指南进行增强搜索。
• get_module_details：获取完整的模块信息，并修正版本映射。
• get_class_details：获取详细的类信息，并提供正确的SDK版本上下文。
• list_modules：全面列出SDK 8.2.3的所有模块，并提供统计信息。
• get_api_examples：提供具有特定SDK版本语法的代码示例。

新文档工具

• search_device_reference：搜索特定设备的功能、内存限制和硬件特性。
• get_programming_guide：访问入门指南、教程和开发最佳实践。
• search_faq：查找常见问题的故障排除信息（如字体、内存、图形等）。

与Claude的使用示例

配置完成后，您可以向Claude提出以下问题：

核心API问题

• "在Garmin Connect IQ中搜索蓝牙功能"
• "显示System模块的详细信息"
• "获取创建表盘的示例"
• "Activity模块中有哪些类可用？"
• "列出所有可用模块"
• "查找与心率监测相关的方法"

v1.0.1新功能

• "SDK 7中是否提供并发症？" ✅ 现在能通过正确的版本映射给出正确答案
• "如何使用stdev函数？" ✅ 现在能找到Math.stdev并提供完整示例
• "展示createPublicKey的用法" ✅ 现在能找到Cryptography.createPublicKey并提供示例
• "如何开始进行Connect IQ开发？"
• "不同Garmin设备的内存限制是多少？"
• "如何在应用中支持圆形设备？"
• "API级别和SDK版本有什么区别？"
• "如何解决字体渲染问题？"
• "查找手表内存功能的设备参考"

管理命令（Claude Code）

# 列出所有配置的MCP服务器
claude mcp list

# 获取服务器详细信息
claude mcp get garmin-documentation

# 移除服务器
claude mcp remove garmin-documentation

📚 详细文档

文档覆盖范围

API模块（33个模块、282个类、27 +个模块函数）

服务器提供对所有主要Garmin Connect IQ模块的访问，包括：

• Activity：活动记录和监测
• ActivityMonitor：每日活动指标
• ANT：ANT无线通信
• Application：应用框架和生命周期
• BluetoothLowEnergy：低功耗蓝牙通信
• Complications：表盘并发症（✅ 在SDK 6.x+中可用，而非之前混淆的4.2+）
• Cryptography：加密、密钥生成、createPublicKey()、randomBytes()
• Graphics：绘图和渲染、createBufferedBitmap()、createColor()
• Math：统计函数（如stdev()、mean()、variance()）以及三角函数
• Position：GPS和定位服务
• Sensor：设备传感器访问
• System：核心系统功能（包括圆形设备检测）
• WatchUi：用户界面组件
• 还有20多个模块...

其他资源（共1407 +个文件）

• 编程指南：入门教程、应用类型、调试、编译器文档
• 设备参考：所有支持设备的硬件规格、内存限制和功能
• 常见问题解答资源：字体、图形、内存、音乐、地图等常见问题的故障排除指南
• 个性库：用于一致应用设计的UI模式、图标、颜色和确认信息
• 用户体验指南：用户体验最佳实践和设计模式

版本准确性

✅ 修复重大问题：解决了API级别混淆问题 ✅ 正确映射：API级别4.2.0正确映射到≈ SDK 6.x+ ✅ 确认SDK 7支持：并发症、活动信息、圆形设备均得到正确支持

📄 许可证

本项目采用MIT许可证。