Garmin Documentation MCP Server
以下摘录自该仓库的 README(片段) · 在 GitHub 读完整 README →
An MCP (Model Context Protocol) server that provides **comprehensive offline access** to the complete Garmin Connect IQ SDK 8.2.3 documentation ecosystem for AI assistants like Claude.
Features
🚀 **Fully Offline**: Works with local documentation - no internet required!
📚 **Complete Documentation**: Access to API docs, programming guides, device reference, FAQ, and visual resources (1,407+ files)
🔍 **Enhanced Search**: Deep semantic search with fuzzy matching and cross-reference support
⚡ **Fast**: Local parsing and indexing for instant responses
🎯 **Accurate Versioning**: Proper API Level to SDK version mapping (fixes common confusion)
📱 **Device-Specific Info**: Hardware capabilities, memory limits, round device support
📖 **Programming Guides**: Getting started tutorials, debugging, testing, and best practices
❓ **FAQ & Troubleshooting**: Common issues with fonts, memory, graphics, and more
v1.0.1 New Features
✨ **Fixed API Level Confusion**: Now correctly shows API Level 4.2.0 (≈ SDK 6.x+) instead of misleading version info
✨ **Fixed Module Functions**: Critical bug fix - now properly finds all module-level functions (Math.stdev, Cryptography.createPublicKey, etc.)
✨ **3 New Tools**: Device reference search, programming guides, and FAQ search
✨ **Enhanced Coverage**: Now indexes programming guides, device docs, FAQ resources, and personality library
✨ **Better Search Results**: Includes guide content in main search with comprehensive cross-references
The server provides the following tools:
Core API Tools
- **search_garmin_docs**: Enhanced search across modules, classes, methods, properties, constants, and guides
- **get_module_details**: Complete module information with corrected version mapping
- **get_class_details**: Detailed class information with proper SDK version context
- **list_modules**: Comprehensive listing of all SDK 8.2.3 modules with statistics
- **get_api_examples**: Code examples with SDK version-specific syntax
New Documentation Tools
- **search_device_reference**: Search device-specific capabilities, memory limits, and hardware features
- **get_programming_guide**: Access getting started guides, tutorials, and development best practices
- **search_faq**: Find troubleshooting info for common issues (fonts, memory, graphics, etc.)
Installation
1. Clone or download this repository
2. Copy the Garmin Connect IQ SDK 8.2.3 documentation to a docs/ folder in the project root
3. Install dependencies:
4. Build the project:
**Note**: On first run, the server will automatically parse and index all documentation files. This may take a few seconds initially but subsequent runs will be instant.
Usage
Running the Server
For development:
For production:
Configuration for Claude Code (Recommended)
Add the MCP server using the Claude Code CLI:
**Verify installation**:
Configuration for Claude Desktop
Add this server to your Claude Desktop configuration file:
**On macOS**: ~/Library/Application Support/Claude/claude_desktop_config.json
**On Windows**: %APPDATA%\\Claude\\claude_desktop_config.json
Replace /path/to/garmin-documentation-mcp-server with the actual path to your installation.
Available Tools
Core API Tools
search_garmin_docs
Enhanced search across the entire Garmin Connect IQ documentation ecosystem.
**Parameters:**
- query (required): Search term
- category (optional): Filter by type ("module", "class", "function", or "all")
**New in v1.0.1**: Now includes programming guides, device docs, and FAQ in search results with proper API Level to SDK version mapping.