Skip to main content
Glama

writeDashboard

Build a Garmin training dashboard HTML page from the last weeks of data, adding coach notes and page settings; returns the file path and a data digest for coaching.

Instructions

Writes the training dashboard page (default /garmin-dashboard.html) with the data of the last weeks weeks (or, with settings.since, from the week of that day: one week more at each update, up to 52), 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; not with `settings.since`
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. Changed2 schema fields changedv0.14.0
    • addedInput schema / properties / settings / properties / since
      Added value: +{
      +  "description": "yyyy-MM-dd: the page starts in the week of this day and grows each week, up to 52 weeks; replaces `weeks`, which the call then leaves out",
      +  "type": "string"
      +}
    • changedInput schema / properties / weeks / description
      Previous value: -"Weeks to cover, default 12, max 52"New value: +"Weeks to cover, default 12, max 52; not with `settings.since`"
  2. Changed1 schema field changedv0.13.0
    • addedInput schema / properties / settings / properties / shared
      Added value: +{
      +  "description": "A page for another person, e.g. a coach: a new page file is readable by other users of the computer; off when not set",
      +  "type": "boolean"
      +}
  3. Changed1 schema field changedv0.11.0
    • addedInput schema / properties / settings / properties / recoveryHistory
      Added value: +{
      +  "description": "Keep the sleep and resting HR rows of the whole period in the page, not only the last 14 days; off when not set",
      +  "type": "boolean"
      +}
  4. First observed

TDQS

A4.5/5.0
Behavior5/5

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

With no annotations supplied, the description carries the full behavioral burden and does so thoroughly: it discloses file writes, default path, existing page preservation, upgrade behavior with page/previousServer/server result fields, .bak creation and 15-minute retention, note escaping, settings replacement rules, and preview's no-write behavior. These are exactly the mutation and side-effect details an agent needs.

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 purpose is front-loaded, but the body is a dense wall of long sentences with many nested clauses. Most details are relevant and earn their place, yet the lack of structure and the sheer density make it harder to scan than it should be for a tool with this much behavior.

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 complex mutation tool with 7 parameters, a nested settings object, and no output schema, the description is complete enough: it explains return fields, upgrade results, missing language/widget text signals, backup behavior, and preview mode. An agent can call it correctly without needing additional context.

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 description coverage is 100%, so the baseline is 3, but the description adds meaningful semantics beyond the schema: weeks defaults to 12 and maxes at 52, weeks is incompatible with settings.since, settings.since replaces weeks, layout selects preset or blank, page code must contain the garmin-data markers, and notes are escaped plain text with a max of 5.

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?

The description opens with a specific verb and resource: "Writes the training dashboard page" with a default file path, and it states the return value (path plus digest). It distinguishes related actions by pointing to editDashboard for adding languages and widget texts, and to getDashboardData behavior for preview cache updates.

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?

It gives clear conditional guidance: preview writes no page file and updates the cache as getDashboardData does, layout chooses preset vs blank, page supplies custom page code, and settings replace the page's settings. It references editDashboard for specific follow-up edits, but it does not give a complete map of when to use writeDashboard versus all other dashboard tools.

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