Garmin Documentation

v1.0.0โ€ขDeveloper Toolsโ€ขstable

๐Ÿ“‡ ๐Ÿ  โ€“ย Offline Garmin Connect IQ SDK documentation with comprehensive search and API examples

garmin-documentationmcpai-integration
Share:
9
Stars
0
Downloads
0
Weekly
0/5

What is Garmin Documentation?

Garmin Documentation is a Model Context Protocol (MCP) server that allows AI assistants like Claude, Cursor, and VS Code to ๐Ÿ“‡ ๐Ÿ  โ€“ย offline garmin connect iq sdk documentation with comprehensive search and api examples

๐Ÿ“‡ ๐Ÿ  โ€“ย Offline Garmin Connect IQ SDK documentation with comprehensive search and API examples

This server falls under the Developer Tools category on MCPgee, the world's largest MCP server directory with 33,000+ servers.

Features

  • ๐Ÿ“‡ ๐Ÿ  โ€“ย Offline Garmin Connect IQ SDK documentation with compr

Use Cases

Search offline Garmin Connect IQ SDK documentation.
Access API examples and comprehensive development resources.
ztuskes

Maintainer

LicenseMIT
Languagetypescript
Versionv1.0.0
UpdatedMay 16, 2026
Statushealthy
Maintenanceactive

Works with

ClaudeOpenAIwindowsmacoslinux

Installation

Manual Installation

npx garmin-documentation

Configuration

Configuration Details

Config File

claude_desktop_config.json

Performance

Response Metrics

Response Time< 200ms
ThroughputMedium

Resource Usage

Memory UsageLow
CPU UsageLow

How to Set Up and Use Garmin Documentation

Garmin Documentation MCP Server provides fully offline access to the Garmin Connect IQ SDK documentation through a set of structured MCP tools. It indexes over 1,407 documentation files covering 33 modules, 282 classes, and 27+ module functions, and ships with corrected API Level to SDK version mappings that the official documentation historically got wrong. Developers building Connect IQ apps for Garmin wearables can search modules, inspect class hierarchies, find device-specific hardware limits, and retrieve versioned code examples directly inside their AI coding assistant without leaving their workflow.

Prerequisites

  • Node.js 18 or later with npm
  • Git to clone the repository (no npm package published)
  • Claude Desktop or Claude Code as your MCP client
  • Optional: Garmin Connect IQ SDK installed locally for development context
1

Clone the repository

Clone the Garmin Documentation MCP Server. The documentation index is bundled in the repository so no external downloads are needed at runtime.

git clone https://github.com/ztuskes/garmin-documentation-mcp-server.git
cd garmin-documentation-mcp-server
2

Install dependencies

Install the npm dependencies required by the TypeScript server and the MCP SDK.

npm install
3

Build the TypeScript source

Compile the TypeScript files to JavaScript. The output lands in the dist/ directory and is required before running the server.

npm run build
4

Add the server to Claude Code

Register the server with Claude Code using the claude mcp add command, pointing to the compiled entry point.

claude mcp add garmin-documentation /path/to/garmin-documentation-mcp-server/dist/index.js
claude mcp list
5

Or add to Claude Desktop configuration

For Claude Desktop, add a server entry in claude_desktop_config.json using the node command to run the compiled JavaScript.

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

Verify with a test query

Restart Claude Desktop or your Claude Code session and ask a Garmin-specific question to confirm the documentation tools are available.

Garmin Documentation Examples

Client configuration

Claude Desktop configuration to serve the locally built Garmin documentation index with no environment variables required.

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

Prompts to try

These prompts demonstrate the depth of the offline documentation index available through the server.

- "Search the Garmin Connect IQ docs for Bluetooth Low Energy functionality."
- "What are the memory limits for the Garmin Fenix 7 and Venu 2 devices?"
- "Show me a code example for using createPublicKey in the Connect IQ SDK."
- "List all modules available in Connect IQ SDK 4.2 and their primary classes."

Troubleshooting Garmin Documentation

Server fails to start with 'Cannot find module dist/index.js'

You must run 'npm run build' before starting the server. The TypeScript source must be compiled to JavaScript first. Re-run the build and confirm dist/index.js exists.

search_garmin_docs returns no results for a known class

The search is case-sensitive for some queries. Try varying the capitalization or use the list_modules tool first to confirm the module name, then call get_module_details for the exact class name.

Claude Code reports 'mcp server not found' after mcp add

Verify the absolute path to dist/index.js is correct and that Node.js can execute the file directly: 'node /path/to/dist/index.js'. Check 'claude mcp list' to see the registered server path.

Frequently Asked Questions about Garmin Documentation

What is Garmin Documentation?

Garmin Documentation is a Model Context Protocol (MCP) server that ๐Ÿ“‡ ๐Ÿ  โ€“ย offline garmin connect iq sdk documentation with comprehensive search and api examples It connects AI assistants to external tools and data sources through a standardized interface.

How do I install Garmin Documentation?

Follow the installation instructions on the Garmin Documentation GitHub repository. Clone the repo, install dependencies, and add the server config to your AI client.

Which AI clients work with Garmin Documentation?

Garmin Documentation works with all major MCP-compatible AI clients including Claude Desktop, Claude Code, Cursor, VS Code (GitHub Copilot), Windsurf, and Cline.

Is Garmin Documentation free to use?

Yes, Garmin Documentation is open source and available under the MIT license. You can use it freely in both personal and commercial projects.

Browse More Developer Tools MCP Servers

Explore all developer tools servers available in the MCPgee directory. Each server includes setup guides for Claude, Cursor, and VS Code.

Quick Config Preview

{ "mcpServers": { "garmin-documentation": { "command": "npx", "args": ["-y", "garmin-documentation"] } } }

Add this to your claude_desktop_config.json or .cursor/mcp.json

Read the full setup guide โ†’

Ready to use Garmin Documentation?

Browse our complete directory of 33,000+ MCP servers, read setup guides for your editor, and start building with the Model Context Protocol.

33,000+ ServersFree & Open SourceStep-by-Step Guides