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許可證。