Skip to main content
Glama

writeDashboard

Writes a Garmin training dashboard HTML page from your last weeks of data and returns its path plus a digest of totals, load, readiness and race predictions for coach notes.

Instructions

Writes the training dashboard page (default /garmin-dashboard.html) with the data of the last weeks weeks, and returns its path and a short digest of the data (totals, weekly sums, load, best efforts, races, long runs, race predictions, strength top sets, readiness, fitness and form, HRV, recovery, fitness age, sync) for the coach notes. Without HRV and sleep data the digest has no readiness: give the verdict as n/a. An existing page keeps all its code, layout and widgets: its data is replaced. A page with different page code gets the page code of the server and keeps its layout and widgets; the result then has page: "upgraded", previousServer (the server version that wrote the page, n/a when unknown) and server. Every page from the template also gets the custom widgets of the widget library (/widgets.json), not placed on a board. On a page from the template, an edited board also gets the widgets that a release adds to its preset, one time; the result lists the ones that the page shows in addedWidgets (board -> widget ids). layout writes a new page from the template: preset (the default widgets) or blank (empty boards). It keeps the languages added with editDashboard languages. page writes your own page code instead; it must contain /* garmin-data:start /null/ garmin-data:end */. A replaced page is kept as .bak. The .bak keeps the page from before the build: a write that follows within 15 minutes (the notes, a new title) does not replace it. notes: at most 5 plain-text coach notes; the server escapes them. settings replace the page's settings (title, headline, sports, data to leave out, languages, themes); without them the page keeps its own. The page holds only the data, languages and themes they keep. pageLanguages in the result lists the languages of the page's Language menu, and settings the settings that the page keeps. missingProfileLanguage is the language of the Garmin profile when the page has no texts in it (it shows English); editDashboard languages adds it. missingWidgetTexts lists the custom widgets that miss texts in a language of the page, with those languages; editDashboard widgetTexts adds them. preview: true writes no page file (it updates the data cache, as getDashboardData does): it returns the digest, the activities of each board and the settings of the page.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "writeDashboard"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNoYour own page code, with an empty garmin-data block, instead of the template
pathNoThe .html file; relative paths are inside the data dir
notesNoCoach notes, plain text; without notes the page has none
weeksNoWeeks to cover, default 12, max 52
layoutNoWrite a new page from the template with this layout
previewNoWrite nothing: return the digest, the activities of each board and the page settings
settingsNoThe page settings; replaces the page's own

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.13.0

TDQS

A4.5/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden and does so thoroughly: it discloses the backup file (.bak), the 15-minute rule that preserves a preceding write, that notes are escaped server-side, that a replaced page keeps layout/widgets and may report `page: "upgraded"`, and the required garmin-data markers. It also reveals mutating side effects such as widgets being added to a released preset one time.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The lead sentence is front-loaded and strong, but the remainder is a dense wall of backtick-marked clauses covering upgrade behavior, added widgets, missing languages, backup rules and preview in one undifferentiated block. Structure and grouping would help an agent parse which sentences apply to which mode (`layout`, `page`, `preview`, incremental write).

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 7-parameter mutation tool with a nested settings object and no output schema, the description covers return shape in depth (path, digest, `page`, `previousServer`, `server`, `addedWidgets`, `pageLanguages`, `missingProfileLanguage`, `missingWidgetTexts`, `settings`). An agent has what it needs to invoke and interpret results.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds real meaning beyond the schema: the `preset` vs `blank` layout semantics, the garmin-data block requirement for `page`, that notes are escaped and capped at 5, and that `settings` replace the page's own while the page keeps only kept data/languages/themes. It does not fully document every nested settings key, which the schema already covers.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: 'Writes the training dashboard page (default <data-dir>/garmin-dashboard.html)' with a defined data window (`weeks`) and a defined return (path + digest). It distinguishes itself from getDashboardData (preview 'updates the data cache, as getDashboardData does') and from editDashboard (languages, widgetTexts), so an agent can pick it apart from siblings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives clear conditional usage: `layout` writes a new page from a preset or blank, `page` writes your own code, `preview: true` writes no file but returns digest/activities/settings. It points to editDashboard for languages and widgetTexts. It lacks an explicit 'do not use this when X, use Y' exclusion, but the context is strong.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.