Garmin Documentation MCP Server

🚀 Garmin Documentation MCP Server

このMCP（Model Context Protocol）サーバーは、ClaudeのようなAIアシスタントに対して、Garmin Connect IQ SDK 8.2.3のドキュメントエコシステム全体に対する完全なオフラインアクセスを提供します。

✨ 主な機能

🚀 完全オフライン：インターネット接続不要で、ローカルのドキュメントを利用できます。
📚 完全なドキュメント：APIドキュメント、プログラミングガイド、デバイスリファレンス、FAQ、および視覚的リソース（1,407ファイル以上）にアクセスできます。
🔍 高度な検索：曖昧一致と相互参照をサポートした深い意味検索が可能です。
⚡ 高速：ローカルでの解析とインデックス作成により、即座に応答します。
🎯 正確なバージョン管理：APIレベルとSDKバージョンの正しいマッピングが行われ、一般的な混乱を解消します。
📱 デバイス固有の情報：ハードウェア機能、メモリ制限、丸型デバイスのサポートに関する情報を提供します。
📖 プログラミングガイド：入門チュートリアル、デバッグ、テスト、およびベストプラクティスが含まれています。
❓ FAQとトラブルシューティング：フォント、メモリ、グラフィックスなどの一般的な問題に対する情報が提供されます。

v1.0.1の新機能

✨ APIレベルの混乱を解消：誤解を招くバージョン情報の代わりに、API Level 4.2.0 (≈ SDK 6.x+) を正しく表示するようになりました。
✨ モジュール関数の修正：重大なバグを修正し、すべてのモジュールレベルの関数（Math.stdev、Cryptography.createPublicKeyなど）を正しく検索できるようになりました。
✨ 3つの新ツール：デバイスリファレンス検索、プログラミングガイド、およびFAQ検索が追加されました。
✨ カバレッジの拡充：プログラミングガイド、デバイスドキュメント、FAQリソース、およびパーソナリティライブラリをインデックス化するようになりました。
✨ 検索結果の改善：主要な検索にガイド内容を含め、包括的な相互参照を行うようになりました。

このサーバーは以下のツールを提供します。

コア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：一般的な問題（フォント、メモリ、グラフィックスなど）のトラブルシューティング情報を検索できます。

📦 インストール

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 Garmin Connect IQのドキュメント全体を対象とした高度な検索機能です。 パラメーター：
  • query（必須）：検索語句
  • category（オプション）：タイプでフィルタリング（"module", "class", "function", または "all"）

v1.0.1の新機能：プログラミングガイド、デバイスドキュメント、およびFAQを検索結果に含め、適切なAPIレベルからSDKバージョンのマッピングを行うようになりました。

• get_module_details 特定のモジュールに関する詳細情報を正しいバージョン情報とともに取得します。 パラメーター：
  • module_name（必須）：モジュール名（例："System", "Activity", "WatchUi"）

改善点：混乱を招く生のAPIレベルの代わりに、API Level 4.2.0 (≈ SDK 6.x+) を表示するようになりました。

• get_class_details 特定のクラスに関する詳細情報を適切なSDKバージョンのコンテキストを持って取得します。 パラメーター：

  • class_name（必須）：クラス名
  • module_name（オプション）：クラスを含むモジュール名

• list_modules すべての利用可能なGarmin Connect IQモジュールを説明と統計情報とともに一覧表示します。

• get_api_examples 特定の機能に関するコード例をSDKバージョン固有の構文で取得します。 パラメーター：

  • topic（必須）：例のトピック（例："activity monitoring", "bluetooth", "watchface"）

新しいドキュメントツール（v1.0.1）

• search_device_reference デバイス固有のリファレンスドキュメントとハードウェア機能を検索します。 パラメーター：
  • query（必須）：デバイス機能、メモリ制限、またはハードウェア機能に関する検索語句
  • device_type（オプション）：デバイスタイプでフィルタリング（例："watch", "bike", "golf"）

使用例：メモリ制限、丸型デバイスのサポート、ハードウェア固有の機能を見つけることができます。

• get_programming_guide Connect IQ開発のためのプログラミングガイドとチュートリアルにアクセスします。 パラメーター：
  • topic（必須）：プログラミングトピック（例："getting started", "app types", "debugging", "testing"）

カバレッジ：入門ガイド、アプリ開発チュートリアル、コンパイラドキュメント、デバッグヒントが含まれています。

• search_faq 頻繁に質問される質問とトラブルシューティング情報を検索します。 パラメーター：
  • query（必須）：FAQまたはトラブルシューティングトピックに関する検索語句

トピックには：フォントレンダリング、メモリ管理、グラフィックス最適化、音楽制御、マップ統合などが含まれます。

Claudeでの使用例

設定が完了すると、Claudeに次のような質問をすることができます。

コアAPIに関する質問

• "Garmin Connect IQでのBluetooth機能を検索して"
• "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：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レベルの混乱を解消しました。
✅ 正しいマッピング：API Level 4.2.0を ≈ SDK 6.x+に正しくマッピングしました。
✅ SDK 7のサポートを確認：コンプリケーション、アクティビティ情報、丸型デバイスがすべて適切にサポートされます。

📄 ライセンス

MIT