Garmin Documentation MCP Server

🚀 Garmin Documentation MCP Server

This MCP (Model Context Protocol) server offers comprehensive offline access to the entire Garmin Connect IQ SDK 8.2.3 documentation ecosystem for AI assistants such as Claude. It enables these assistants to retrieve detailed information without an internet connection.

✨ Features

• 🚀 Fully Offline: Operates with local documentation, eliminating the need for an internet connection.
• 📚 Complete Documentation: Grants access to API docs, programming guides, device references, FAQs, and visual resources (over 1,407 files).
• 🔍 Enhanced Search: Performs deep semantic search with fuzzy matching and cross - reference support.
• ⚡ Fast: Utilizes local parsing and indexing for instant responses.
• 🎯 Accurate Versioning: Provides proper mapping between API levels and SDK versions, resolving common confusion.
• 📱 Device - Specific Info: Offers details on hardware capabilities, memory limits, and support for round devices.
• 📖 Programming Guides: Includes getting - started tutorials, debugging, testing, and best practices.
• ❓ FAQ & Troubleshooting: Covers common issues related to fonts, memory, graphics, etc.

✨ v1.0.1 New Features

• ✨ Fixed API Level Confusion: Now accurately displays API Level 4.2.0 (≈ SDK 6.x+) instead of misleading version information.
• ✨ Fixed Module Functions: Resolved a critical bug, ensuring that all module - level functions (e.g., Math.stdev, Cryptography.createPublicKey) are properly found.
• ✨ 3 New Tools: Introduced device reference search, programming guides, and FAQ search.
• ✨ Enhanced Coverage: Now indexes programming guides, device docs, FAQ resources, and the personality library.
• ✨ Better Search Results: Incorporates guide content in the main search with comprehensive cross - references.

The server provides the following tools:

🔧 Core API Tools

• search_garmin_docs: Conducts an enhanced search across modules, classes, methods, properties, constants, and guides.
• get_module_details: Retrieves complete module information with corrected version mapping.
• get_class_details: Obtains detailed class information with the appropriate SDK version context.
• list_modules: Presents a comprehensive listing of all SDK 8.2.3 modules with statistics.
• get_api_examples: Provides code examples with SDK version - specific syntax.

🔧 New Documentation Tools

• search_device_reference: Searches for device - specific capabilities, memory limits, and hardware features.
• get_programming_guide: Grants access to getting - started guides, tutorials, and development best practices.
• search_faq: Finds troubleshooting information for common issues (e.g., fonts, memory, graphics).

📦 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:

npm install

4. Build the project:

npm run build

⚠️ Important Note

On the 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:

npm run dev

For production:

npm start

Configuration for Claude Code (Recommended)

Add the MCP server using the Claude Code CLI:

# Add the server (run from any directory)
claude mcp add garmin-documentation /path/to/garmin-documentation-mcp-server/dist/index.js

# Or add at project scope for team collaboration
claude mcp add --scope project garmin-documentation /path/to/garmin-documentation-mcp-server/dist/index.js

Verify installation:

claude mcp list

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

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

Replace /path/to/garmin-documentation-mcp-server with the actual path to your installation.

💻 Available Tools

Core API Tools

search_garmin_docs

Performs an 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 FAQs in search results with proper API Level to SDK version mapping.

get_module_details

Retrieves detailed information about a specific module with corrected version information. Parameters:

• module_name (required): Name of the module (e.g., "System", "Activity", "WatchUi"). Improvement: Displays API Level 4.2.0 (≈ SDK 6.x+) instead of confusing raw API levels.

get_class_details

Obtains detailed information about a specific class with the appropriate SDK version context. Parameters:

• class_name (required): Name of the class.
• module_name (optional): Module containing the class.

list_modules

Lists all available Garmin Connect IQ modules with descriptions and statistics.

get_api_examples

Provides code examples for specific functionality with SDK version - specific syntax. Parameters:

• topic (required): Topic for examples (e.g., "activity monitoring", "bluetooth", "watchface").

New Documentation Tools (v1.0.1)

search_device_reference

Searches device - specific reference documentation and hardware capabilities. Parameters:

• query (required): Search term for device capabilities, memory limits, or hardware features.
• device_type (optional): Device type filter (e.g., "watch", "bike", "golf"). Use Cases: Finds memory limits, round device support, and hardware - specific features.

get_programming_guide

Accesses programming guides and tutorials for Connect IQ development. Parameters:

• topic (required): Programming topic (e.g., "getting started", "app types", "debugging", "testing"). Coverage: Getting - started guides, app development tutorials, compiler documentation, debugging tips.

search_faq

Searches frequently asked questions and troubleshooting information. Parameters:

• query (required): Search term for FAQ or troubleshooting topics. Topics Include: Font rendering, memory management, graphics optimization, music control, map integration, etc.

💻 Example Usage with Claude

Once configured, you can ask Claude questions such as:

Core API Questions

• "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"

New v1.0.1 Capabilities

• "Are complications available in SDK 7?" ✅ Now answers correctly with proper version mapping
• "How do I use stdev function?" ✅ Now finds Math.stdev with complete examples
• "Show me createPublicKey usage" ✅ Now finds Cryptography.createPublicKey with examples
• "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"

⚙️ Management Commands (Claude Code)

# List all configured MCP servers
claude mcp list

# Get details about the server
claude mcp get garmin-documentation

# Remove the server
claude mcp remove garmin-documentation

📚 Documentation Coverage

API Modules (33 modules, 282 classes, 27+ module functions)

The server provides access to all major Garmin Connect IQ modules, including:

• Activity: Activity recording and monitoring
• ActivityMonitor: Daily activity metrics
• ANT: ANT wireless communication
• Application: App framework and lifecycle
• BluetoothLowEnergy: BLE communication
• Complications: Watch face complications (✅ Available in SDK 6.x+, not 4.2+ as previously confusing)
• Cryptography: Encryption, key generation, createPublicKey(), randomBytes()
• Graphics: Drawing and rendering, createBufferedBitmap(), createColor()
• Math: Statistical functions like stdev(), mean(), variance(), plus trigonometric functions
• Position: GPS and location services
• Sensor: Device sensor access
• System: Core system functions (including round device detection)
• WatchUi: User interface components
• And 20 more modules...

Additional Resources (1,407+ files total)

• Programming Guides: Getting - started tutorials, app types, debugging, compiler documentation
• Device Reference: Hardware specifications, memory limits, capabilities for all supported devices
• FAQ Resources: Troubleshooting guides for fonts, graphics, memory, music, maps, and common issues
• Personality Library: UI patterns, iconography, colors, confirmations for consistent app design
• UX Guidelines: User experience best practices and design patterns

Version Accuracy

• ✅ Fixed Major Issue: API Level confusion resolved
• ✅ Proper Mapping: API Level 4.2.0 correctly mapped to ≈ SDK 6.x+
• ✅ SDK 7 Support Confirmed: Complications, Activity info, round devices all properly supported

📄 License

MIT