@indaco/garmin-personal-mcp 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026 Alessandro Praticò
+Copyright (c) 2026 indaco
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,356 @@
-# Temporary Holding Version
+<h1 align="center">
+  <img src="assets/logo.svg" alt="" width="48" align="absmiddle" />
+  garmin-personal-mcp
+</h1>
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+<p align="center"><b>Your Garmin training in Claude, Codex or any MCP client, through the official Personal API. Read-only, nothing to install.</b></p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@indaco/garmin-personal-mcp"><img src="https://img.shields.io/npm/v/@indaco/garmin-personal-mcp.svg" alt="npm version" /></a>
+  <a href="https://codecov.io/gh/indaco/garmin-personal-mcp"><img src="https://codecov.io/gh/indaco/garmin-personal-mcp/branch/main/graph/badge.svg" alt="Code coverage" /></a>
+  <a href="https://nodejs.org"><img src="https://img.shields.io/badge/node-%3E%3D22-brightgreen.svg" alt="Node.js 22 or later" /></a>
+  <a href="tsconfig.json"><img src="https://img.shields.io/badge/TypeScript-strict-3178c6.svg" alt="TypeScript strict" /></a>
+  <a href="https://modelcontextprotocol.io"><img src="https://img.shields.io/badge/MCP-stdio%20server-8a2be2.svg" alt="MCP stdio server" /></a>
+  <a href="https://developer.garmin.com/gc-developer-program/personal/"><img src="https://img.shields.io/badge/Garmin-Personal%20API-007cc3.svg" alt="Garmin Connect Personal API" /></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License: MIT" /></a>
+  <a href="https://www.jetify.com/devbox/docs/contributor-quickstart/"><img src="https://www.jetify.com/img/devbox/shield_galaxy.svg" alt="Built with Devbox" /></a>
+</p>
+
+<p align="center">
+  <b><a href="#quick-start">Quick start</a></b> &middot;
+  <b><a href="#prompts">Prompts</a></b> &middot;
+  <b><a href="#dashboard-setup">Dashboard setup</a></b> &middot;
+  <b><a href="#tools">Tools</a></b> &middot;
+  <b><a href="#presets-or-freeform">Presets or freeform</a></b> &middot;
+  <b><a href="guide/dashboard.md">Dashboard guide</a></b> &middot;
+  <b><a href="guide/how-it-works.md">How it works</a></b> &middot;
+  <b><a href="guide/troubleshooting.md">Troubleshooting</a></b>
+</p>
+
+<p align="center">
+  <img src="assets/dashboard.gif" alt="The training dashboard: the All board, load against recovery, the Run board, strength trends, edit mode (drag a widget to a new place, hide a widget, add widgets from the catalogue to an empty board), and the light and high-contrast themes" width="800">
+</p>
+<p align="center">
+  <sub><i>The training dashboard with demo data.</i></sub>
+</p>
+
+MCP server for the official Garmin Connect Personal API.
+
+## Features
+
+- **Official and read-only**: uses the Garmin Connect Personal API. It writes nothing back.
+- **Nothing to install**: runs with `npx`.
+- **Laps and strength sets**: read from the original .FIT files.
+- **Recovery data**: HRV, sleep and heart rate.
+- **Dashboard in less than a minute**: [training-dashboard](#training-dashboard) shows your
+  training load next to recovery, in widgets that you can move, resize, hide and add. You can also
+  [let the assistant design the whole page](#presets-or-freeform).
+- **Your layout stays**: [training-dashboard-update](#training-dashboard-update) adds only the
+  new data.
+- **A page for you or for your coach**: [dashboard-setup](#dashboard-setup) makes a personal page,
+  or a page to share with your coach or personal trainer. You select the sports and the data. The
+  data that you do not select is not in the file.
+- **Extend it**: [dashboard-widget](#dashboard-widget) makes a new widget from your idea.
+  [dashboard-language](#dashboard-language) adds a language.
+- **All stdio clients**: Claude Desktop, Claude Code, Codex and all other MCP clients that use
+  stdio. Tested with Claude Desktop and Claude Code.
+
+With this server, you can ask your assistant:
+
+- "List my last 5 activities, with pace and heart rate."
+- "Show the laps of my last run."
+- "Compare my sets of this week with the week before."
+- "How did I sleep this week, and how was my HRV?"
+
+## Quick start
+
+You need Node.js 22 or later (`node --version` shows the version) and a Garmin Connect account
+with access to the [Personal API](https://developer.garmin.com/gc-developer-program/personal/).
+
+### 1. Create a personal API key
+
+1. Open Garmin Connect web at <https://connect.garmin.com/app/settings/personalApiToken>.
+2. Select _Create Key_, accept the terms, select the expiry (1 year at most) and select _Create_.
+3. Garmin shows the key **only one time**. Save it in a file that only you can read:
+
+```bash
+mkdir -p ~/.config/garmin-mcp
+nano ~/.config/garmin-mcp/api-key      # paste the key and save
+chmod 600 ~/.config/garmin-mcp/api-key
+```
+
+You can also give the key in the environment variable `GARMIN_PERSONAL_API_KEY`.
+
+### 2. Connect your client
+
+**Claude Desktop**: select Settings → Developer → _Edit Config_. Add a top-level `mcpServers` key
+next to the keys that the file has, not in `preferences`:
+
+```json
+{
+  "mcpServers": {
+    "garmin-personal": {
+      "command": "npx",
+      "args": ["-y", "@indaco/garmin-personal-mcp@latest"]
+    }
+  }
+}
+```
+
+Then quit Claude Desktop **fully**, including the tray icon, and start it again.
+
+**Claude Code**: this command adds the server to all your projects:
+
+```bash
+claude mcp add garmin-personal --scope user -- npx -y @indaco/garmin-personal-mcp@latest
+claude mcp list          # garmin-personal: ... ✔ Connected
+```
+
+Use `--scope project` to write a `.mcp.json` file that you can share in the current repository.
+
+**Codex**: this command adds the server:
+
+```bash
+codex mcp add garmin-personal -- npx -y @indaco/garmin-personal-mcp@latest
+```
+
+You can also add it to `~/.codex/config.toml`. The first `npx` download can take longer than the
+default start time, so set a longer one:
+
+```toml
+[mcp_servers.garmin-personal]
+command = "npx"
+args = ["-y", "@indaco/garmin-personal-mcp@latest"]
+startup_timeout_sec = 60
+```
+
+Codex does not send your shell environment to the server. Use the key file, or add
+`env = { GARMIN_PERSONAL_API_KEY = "..." }` to the table.
+
+**Other clients** (Gemini CLI, VS Code, Cursor and others): in the MCP configuration of the client,
+set the command `npx` and the arguments `-y @indaco/garmin-personal-mcp@latest`. Some clients do not
+show MCP prompts. In these clients, ask for the dashboard in your own words. The tools are the same.
+
+### 3. Ask your assistant
+
+Ask "list my last 5 activities". The first time that a garmin-personal tool asks for permission, answer
+**Allow always** in Claude Desktop. In Claude Code, use `/permissions` and add `mcp__garmin-personal`.
+
+## Prompts
+
+In Claude Desktop, the prompts are in the **+** menu of the message box, under _garmin-personal_. In
+Claude Code, they are slash commands such as `/garmin-personal:training-dashboard`.
+
+The prompts remove all spaces around an argument, also the no-break space from a phone keyboard.
+
+After an update of the server, the prompts and tools change only in a new Claude Code session. In
+Claude Desktop, they change after a full restart.
+
+### training-dashboard
+
+The server writes the dashboard page from its template, and the assistant writes the coach notes.
+The page is one HTML file, `garmin-dashboard.html` in the data folder. It works offline.
+
+| Argument | Values                            | Default  |
+| -------- | --------------------------------- | -------- |
+| `weeks`  | 1 to 52 (a larger value gives 52) | 12       |
+| `layout` | `preset`, `blank` or `freeform`   | `preset` |
+
+- `preset` gives the built-in widgets on each board.
+- `blank` gives empty boards: you add the widgets that you want.
+- `freeform` lets the assistant design the whole page. This takes much longer, and each page looks
+  different.
+
+| Client         | How to run it                                                               |
+| -------------- | --------------------------------------------------------------------------- |
+| Claude Desktop | **+** → _garmin-personal_ → `training-dashboard` → set the arguments → send |
+| Claude Code    | `/garmin-personal:training-dashboard 8`                                     |
+
+In Claude Code, the arguments are in order and separated by spaces: first `weeks`, then `layout`.
+You can also give only the layout: `/garmin-personal:training-dashboard freeform`.
+
+The assistant gives you the path of the page and the command to open it. The page has a board for
+all your training, a Recovery board and a board for each sport, with 11 themes and English and
+Italian texts. It uses the training load, HR zones and training effect from Garmin. It labels each
+value that it calculates as an estimate, and a missing value shows as "n/a".
+
+[The dashboard guide](guide/dashboard.md) tells what each board shows and how to change the layout.
+[The widget catalogue](guide/widgets.md) lists every widget.
+
+### training-dashboard-update
+
+This prompt replaces the data and the coach notes of the page. Your layout, your custom widgets and
+your languages stay. Reload the page to see the new data.
+
+| Argument | Values                                                                  | Default                 |
+| -------- | ----------------------------------------------------------------------- | ----------------------- |
+| `weeks`  | the weeks to cover                                                      | the weeks of the page   |
+| `path`   | the dashboard file, for example `garmin-dashboard-coach.html` (`.html`) | `garmin-dashboard.html` |
+
+In Claude Code: `/garmin-personal:training-dashboard-update coach.html` updates `coach.html`. A
+value that ends in `.html` is the file, also in the first place.
+
+| Client         | How to run it                                                  |
+| -------------- | -------------------------------------------------------------- |
+| Claude Desktop | **+** → _garmin-personal_ → `training-dashboard-update` → send |
+| Claude Code    | `/garmin-personal:training-dashboard-update`                   |
+
+The first call sends approximately 35 requests to Garmin. Later calls use the local cache and send
+approximately 8.
+
+### dashboard-setup
+
+The assistant asks you some questions, then writes a page with your answers. First, it asks who the
+page is for:
+
+- **Personal**: a page for you, with all your data.
+- **Shared**: a page for your coach or personal trainer. You select each type of data to include,
+  for example HR zones yes, fitness age and sleep no.
+
+Then the assistant asks for the file (any name or path), the title, the headline, the sports, the
+languages and the themes. The server writes only the data that you select into the file. Other data
+is not in the file, so you can send the file safely. A personal page and a shared page can be two
+files side by side. Each page keeps its settings on each update. The argument `weeks` is optional
+(default 12).
+
+| Client         | How to run it                                        |
+| -------------- | ---------------------------------------------------- |
+| Claude Desktop | **+** → _garmin-personal_ → `dashboard-setup` → send |
+| Claude Code    | `/garmin-personal:dashboard-setup`                   |
+
+[Page settings](guide/dashboard.md#page-settings) tells more.
+
+### dashboard-widget
+
+This prompt makes a new widget from your idea, for example "my longest ride of each month". The
+assistant writes a small widget, and `editDashboard` stores it in the page. The widget stays after
+each update. The argument `idea` is required. The argument `path` is optional: it is the file of the
+page, for example `coach.html`. In Claude Code:
+`/garmin-personal:dashboard-widget my longest ride each month coach.html`. Reload the page to see
+the widget.
+[Custom widgets](guide/custom-widgets.md) tells more.
+
+### dashboard-language
+
+This prompt adds a language to the dashboard. The assistant translates the texts of the page, and
+`editDashboard` stores them in the page. The argument `language` is optional: the default is the
+language of the conversation. The argument `path` is optional: it is the file of the page, for
+example `coach.html`. In Claude Code: `/garmin-personal:dashboard-language German coach.html`. A
+text without a translation shows in English. To remove an added language, ask your assistant to
+remove it: `editDashboard` with `removeLanguages`.
+[Languages](guide/languages.md) tells more.
+
+## Tools
+
+| Tool                  | What it gives                                                          |
+| --------------------- | ---------------------------------------------------------------------- |
+| `listActivities`      | a summary of each activity, with pace, HR, training load and effect    |
+| `getActivity`         | the details of one activity                                            |
+| `getActivityLaps`     | the laps of an activity, from its .FIT file                            |
+| `getActivitySets`     | the strength sets of an activity, with the muscles, from its .FIT file |
+| `downloadActivityFit` | saves the .FIT file of an activity in the data folder                  |
+| `getHrvRange`         | HRV during the night                                                   |
+| `getDailyHeartRate`   | the heart rate of a day, with the resting HR                           |
+| `getSleep`            | the sleep of a night, or of up to 14 nights                            |
+| `getHeartRateZones`   | your HR zones                                                          |
+| `getFitnessAge`       | fitness age against actual age                                         |
+| `getDailySummary`     | steps, stress and Body Battery, for a day or a range                   |
+| `getDashboardData`    | all the data of the dashboard in one call, with a local cache          |
+| `writeDashboard`      | writes the dashboard page                                              |
+| `editDashboard`       | changes the layout, the custom widgets and the languages of the page   |
+| `garminGet`           | all other GET endpoints of the Personal API                            |
+
+[Tools](guide/tools.md) gives the endpoints, the details of each tool and the data that the
+Personal API does not have.
+
+## Configuration
+
+All the settings are environment variables, and all of them are optional.
+
+| Variable                  | Default                                  | Meaning                                                  |
+| ------------------------- | ---------------------------------------- | -------------------------------------------------------- |
+| `GARMIN_PERSONAL_API_KEY` | not set                                  | the personal API key. It has priority over the key file. |
+| `GARMIN_API_KEY_FILE`     | `~/.config/garmin-mcp/api-key`           | the file with the API key                                |
+| `GARMIN_DATA_DIR`         | `~/workspace/garmin-data`                | the data folder                                          |
+| `GARMIN_BASE_URL`         | `https://personal.connectapi.garmin.com` | the Personal API host                                    |
+
+To set a variable in Claude Desktop, add an `env` object next to `args`:
+
+```json
+"env": { "GARMIN_DATA_DIR": "/absolute/path/to/garmin-data" }
+```
+
+In Claude Code, add `--env GARMIN_DATA_DIR=/path/to/garmin-data` to `claude mcp add`.
+
+[The data folder](guide/tools.md#the-data-folder) lists the files that the server keeps and its
+log.
+
+## Presets or freeform
+
+In many setup guides for Claude and Garmin, Claude reads the data and writes the whole dashboard
+page. With a preset, the server writes the page from a tested template, and Claude writes only the
+coach notes. My measurements for a first build, with Claude Code and Opus
+(other clients and models give other times and costs):
+
+| First build            | Time         | Cost         |
+| ---------------------- | ------------ | ------------ |
+| Preset                 | 34 s         | $0.16        |
+| Claude writes the page | 24 to 35 min | $6.6 to $9.2 |
+
+For a design of your own, use `layout` = `freeform`: Claude writes the page, as in those guides.
+
+[Presets or freeform](guide/presets.md) gives the measurements and the limits of the presets.
+
+## Security
+
+The server is read-only. It sends the API key only to the Garmin token endpoint, and it never logs
+or returns the key or the access token. It refuses a key that has spaces or line breaks in it, and
+it removes the key and the token from network error messages. If you saw your API key in a chat,
+revoke the key on the [API key page](https://connect.garmin.com/app/settings/personalApiToken) and
+create a new one. Your .FIT files can have your GPS track, so keep the data folder private.
+
+[SECURITY.md](SECURITY.md) tells how the server protects your data and how to report a
+vulnerability. Do not open a public issue for a vulnerability.
+
+The Personal API is for personal use that is not commercial, under the terms of Garmin. Garmin
+does not endorse this project, and the project has no affiliation with Garmin.
+
+## Problems and solutions
+
+| Problem                            | Solution                                                                                                                        |
+| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
+| The server does not start          | Make sure that Node.js is version 22 or later: `node --version`.                                                                |
+| Claude Desktop does not find `npx` | GUI apps do not read your shell profile. Use the absolute path of `npx` (`which npx`) as the `command`.                         |
+| Changes have no effect             | The client keeps the old server process. Restart the client: a new Claude Code session, or quit and start Claude Desktop again. |
+
+[Problems and solutions](guide/troubleshooting.md) has more problems, the log files, and commands
+that test the key and the server.
+
+## Contributing
+
+Read [CONTRIBUTING.md](CONTRIBUTING.md). It tells how to run the server from source, and it has
+the commands, the test rules and the code map.
+
+To build a demo site with a year of sample data, run `pnpm build`, then
+`node scripts/demo-data.mjs`. The script writes `demo-site/index.html` and `demo-site/demo-data.json`.
+
+## Credits
+
+The idea comes from [apratico/garmin-mcp](https://github.com/apratico/garmin-mcp) by Alessandro
+Praticò: a Java MCP server for the Garmin Personal API, where Claude writes the dashboard. I
+tested it in a fork, [indaco/garmin-mcp](https://github.com/indaco/garmin-mcp), and then made this
+server as a different solution:
+
+- **No Java**: the server runs with `npx`. You do not need Java 21 and a jar file.
+- **The server writes the page**: in garmin-mcp, Claude writes all of the dashboard HTML on each run. Here the server fills a tested template, and Claude writes only the coach notes. A first build takes seconds, not minutes ([measurements](#presets-or-freeform)).
+- **Updates keep your page**: [training-dashboard-update](#training-dashboard-update) adds only the new data, and your layout stays.
+- **Widgets that you control**: charts for training load, recovery, running and strength. In the page, you drag, resize, hide and add widgets, and select a theme.
+- **Setup by sport**: [dashboard-setup](#dashboard-setup) makes a page with only the sports and the data that you select, for you or for your coach.
+- **Languages and custom widgets**: [dashboard-language](#dashboard-language) and [dashboard-widget](#dashboard-widget) extend the page.
+
+This server uses the same key file as indaco/garmin-mcp and can share its data folder.
+
+## License
+
+This project uses the [MIT License](LICENSE). `dist/index.js` and the dashboard page include
+other libraries with their own licenses: [THIRD-PARTY-NOTICES.md](THIRD-PARTY-NOTICES.md) lists them.