SuperAPI AI 工具集
合作ENAI 行业资讯收藏
全部工具AI编程工具garmin-documentation-mcp-server

garmin-documentation-mcp-server

这是一个针对 Garmin Connect IQ SDK 8.2.3 文档的 MCP（模型上下文协议）服务器，为 Claude 等 AI 助手提供完全离线的 SDK 文档访问能力。它包含 API 模块、编程指南、设备参考、FAQ 和视觉资源等 1,407 多个文件。主要功能包括增强搜索（深度语义搜索、模糊匹配和交叉引用）、模块与类详情查询、API 示例获取、设备特定信息（硬件能力、内存限制、圆形设备支持）、编程指南与 FAQ 搜索。v1.0.1 版本修复了 API Level 与 SDK 版本的映射混淆，修复了模块级函数查找问题，并新增了设备参考搜索、编程指南和 FAQ 搜索三个工具。它通过本地解析和索引实现快速响应，首次运行需要几秒索引，之后即时可用。适用于需要离线查阅 Garmin Connect IQ 开发文档的 AI 辅助编程场景。

访问官网

工具介绍

用途

Garmin Documentation MCP Server 是一个基于 MCP（模型上下文协议）的服务器，旨在为 Claude 等 AI 助手提供对 Garmin Connect IQ SDK 8.2.3 完整文档生态系统的离线访问。它解决了开发者在没有网络连接时无法查阅 SDK 文档的问题，同时通过 AI 助手提供更智能的文档检索和问答体验。

主要能力

  • 完全离线：使用本地文档，无需互联网连接。
  • 完整文档覆盖：包含 API 文档、编程指南、设备参考、FAQ 和视觉资源，共 1,407+ 个文件。
  • 增强搜索：深度语义搜索，支持模糊匹配和交叉引用。
  • 快速响应：本地解析和索引，即时返回结果。
  • 准确的版本映射：正确映射 API Level 到 SDK 版本，解决常见混淆。
  • 设备特定信息：硬件能力、内存限制、圆形设备支持等。
  • 编程指南：入门教程、调试、测试和最佳实践。
  • FAQ 与故障排除：字体、内存、图形等常见问题。

v1.0.1 新功能

  • 修复 API Level 混淆：现在正确显示 API Level 4.2.0（约等于 SDK 6.x+），而非误导性版本信息。
  • 修复模块函数：关键错误修复，现在能正确找到所有模块级函数（如 Math.stdev、Cryptography.createPublicKey）。
  • 新增 3 个工具：设备参考搜索、编程指南、FAQ 搜索。
  • 增强覆盖：现在索引编程指南、设备文档、FAQ 资源和个性库。
  • 更好的搜索结果：主搜索中包含指南内容，并带有全面的交叉引用。

使用方式

安装

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

注意：首次运行时会自动解析并索引所有文档文件，可能需要几秒钟，后续运行将即时完成。

运行服务器

开发模式：

npm run dev

生产模式：

npm start

配置 Claude Code（推荐）

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

claude mcp add garmin-docs <path-to-server>

验证安装：

claude mcp list

配置 Claude Desktop

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

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

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

可用工具

  • search_garmin_docs：在模块、类、方法、属性、常量和指南中进行增强搜索。参数：query（必填），category（可选，筛选类型 "module", "class", "function", 或 "all"）。v1.0.1 新增包含编程指南、设备文档和 FAQ，并正确映射 API Level 到 SDK 版本。
  • get_module_details：获取特定模块的详细信息及修正后的版本信息。参数：module_name（必填，如 "System", "Activity", "WatchUi"）。改进：显示 API Level 4.2.0（≈ SDK 6.x+）而非令人困惑的原始 API 级别。
  • get_class_details：获取特定类的详细信息及正确的 SDK 版本上下文。参数：class_name（必填），module_name（可选）。
  • list_modules：列出所有可用的 Garmin Connect IQ 模块及其描述和统计信息。
  • get_api_examples：获取特定功能的代码示例，包含 SDK 版本特定语法。参数：topic（必填，如 "activity monitoring", "bluetooth", "watchface"）。
  • search_device_reference（v1.0.1 新增）：搜索设备特定参考文档和硬件能力。参数：query（必填），device_type（可选，如 "watch", "bike", "golf"）。用途：查找内存限制、圆形设备支持、硬件特定功能。
  • get_programming_guide（v1.0.1 新增）：访问 Connect IQ 开发的编程指南和教程。参数：topic（必填，如 "getting started", "app types", "debugging", "testing"）。覆盖：入门指南、应用开发教程、编译器文档、调试技巧。
  • search_faq（v1.0.1 新增）：搜索常见问题和故障排除信息。参数：query（必填）。主题包括：字体渲染、内存管理、图形优化、音乐控制、地图集成等。

与 Claude 的示例用法

配置后，您可以向 Claude 提问，例如：

核心 API 问题：

  • "Search for bluetooth functionality in Garmin Connect IQ"
  • "Show me details about the System module"
  • "Get examples for creating a watch face"
  • "What classes are available in the Activity module?"
  • "List all available modules"
  • "Find methods related to heart rate monitoring"

v1.0.1 新能力：

  • "Are complications available in SDK 7?" ✅ 现在能通过正确的版本映射正确回答
  • "How do I use stdev function?" ✅ 现在能找到 Math.stdev 及完整示例
  • "Show me createPublicKey usage" ✅ 现在能找到 Cryptography.createPublicKey 及示例
  • "How do I get started with Connect IQ development?"
  • "What are the memory limits for different Garmin devices?"
  • "How do I support round devices in my app?"
  • "What's the difference between API Level and SDK version?"
  • "How do I troubleshoot font rendering issues?"
  • "Find device reference for watch memory capabilities"

管理命令（Claude Code）暂未提供具体命令列表。

文档覆盖

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

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

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

额外资源（共 1,407+ 文件）

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

版本准确性

  • ✅ 修复重大问题：API Level 混淆已解决
  • ✅ 正确映射：API Level 4.2.0 正确映射到 ≈ SDK 6.x+
  • ✅ 确认 SDK 7 支持：复杂功能、活动信息、圆形设备均得到正确支持

适用场景

  • 开发 Garmin Connect IQ 应用时，需要快速查阅 SDK 文档。
  • 在无网络环境下进行开发。
  • 通过 AI 助手获取代码示例、模块详情、API 用法。
  • 排查设备特定问题，如内存限制、圆形屏幕支持。
  • 学习 Connect IQ 开发，查阅入门指南和最佳实践。

限制

  • 暂未提供关于价格、收费、平台兼容性、效果保证等方面的明确信息。
  • 需要本地已具备 Garmin Connect IQ SDK 8.2.3 文档，并正确放置到 docs/ 文件夹。
  • 首次运行需要索引时间。
  • 依赖 MCP 协议及兼容的 AI 助手（如 Claude）。

同类工具

查看分类