Skip to main content
Glama
SavageCore

dashy-mcp

dashy-mcp

MCP server exposing Dashy's REST API as tools, so an LLM can read and edit your dashboard config: sections, items (tiles), and top-level config keys.

Built with FastMCP.

Enabling the API on your Dashy server

Dashy's API is opt-in and disabled by default. Enabling and securing it (via ENABLE_API, API_TOKEN, and/or Dashy's existing user auth) is server-side configuration specific to how you run Dashy, and out of scope for this project - see Dashy's own docs: Enabling the API.

Related MCP server: openhab

Install

Download a wheel from the latest release and install it as a uv tool (no repo checkout needed):

uv tool install dashy_mcp-*.whl

This puts a dashy-mcp command on your PATH. Register it with Claude Code:

claude mcp add dashy \
  --env DASHY_URL=https://your-dashy-host \
  --env DASHY_TOKEN=<token> \
  -- dashy-mcp

From source

uv sync
cp .env.example .env   # fill in DASHY_URL and DASHY_TOKEN
claude mcp add dashy \
  --env DASHY_URL=https://your-dashy-host \
  --env DASHY_TOKEN=<token> \
  -- uv run --directory /path/to/dashy-mcp dashy-mcp

Config

Env var

Required

Default

DASHY_URL

yes

-

DASHY_TOKEN

no

none (no auth header sent)

DASHY_CONFIG_FILE

no

conf.yml

Tools

4 resource-scoped tools, each covering multiple Dashy API endpoints (14 total) via an operation parameter. Call a tool with operation set to one of its listed operations and an arguments dict matching that operation's parameters — the tool's own description (visible to your MCP client) lists every operation, its signature, and a one-line doc.

Tool

Operations

Covers

dashy_item

5

List/add/get/update/delete items (tiles)

dashy_section

4

Add/get/update/delete sections

dashy_config

3

List config files, get/replace a config file

dashy_key

2

Get/set a top-level config key

Example: dashy_section(operation="dashy_get_section", arguments={"sid": "Media"}). Endpoint-level naming is preserved as the operation value:

Operation

Endpoint

dashy_list_config_files

GET /api/config

dashy_get_config

GET /api/config/:file

dashy_replace_config

PUT /api/config/:file

dashy_get_key

GET /api/config/:file/:key

dashy_set_key

PUT /api/config/:file/:key

dashy_add_section

POST /api/config/:file/sections

dashy_get_section

GET /api/config/:file/sections/:sid

dashy_update_section

PATCH /api/config/:file/sections/:sid

dashy_delete_section

DELETE /api/config/:file/sections/:sid

dashy_list_items

GET /api/config/:file/sections/:sid/items

dashy_add_item

POST /api/config/:file/sections/:sid/items

dashy_get_item

GET /api/config/:file/sections/:sid/items/:iid

dashy_update_item

PATCH /api/config/:file/sections/:sid/items/:iid

dashy_delete_item

DELETE /api/config/:file/sections/:sid/items/:iid

sid/iid accept either a zero-based index or an exact section name / item title. filename defaults to conf.yml (or DASHY_CONFIG_FILE) on every operation. PATCH-based updates are a shallow merge: only given fields change, and a nested array included in the patch replaces the existing one wholesale.

Development

make help  # list all commands

Command

Does

make sync

uv sync

make test

Offline tests - one per endpoint, mocked HTTP

make test-integration

Tests against the live instance (needs DASHY_URL/DASHY_TOKEN)

make build

Build wheel + sdist into dist/

make bump-patch / bump-minor / bump-major

Bump the version in pyproject.toml + uv.lock

make clean

Remove build artifacts

The release workflow (.github/workflows/release.yml) builds and publishes to Releases whenever a v* tag is pushed - so the usual flow is make bump-patch, commit, then tag and push.

The integration suite reads real config and, for the write lifecycle test, creates and then deletes a scratch section named mcp-test-<uuid> - never touches your real sections. Dashy also auto-backs up every write to user-data/config-backups/ as a second safety net.

Available Tools

4 tools
dashy_configA

dashy config operations on Dashy. Pass operation and an arguments dict matching that operation's parameters.

  • dashy_get_config(filename='') — Get a full Dashy config file as JSON. Defaults to conf.yml.

  • dashy_list_config_files() — List the YAML config files available on the Dashy instance.

  • dashy_replace_config(config, filename='') — Replace an entire Dashy config file. config must be a full config object (pageInfo, appConfig, sections, pages) -- this is a complete overwrite, not a merge.

ParametersJSON Schema
NameRequiredDescriptionDefault
argumentsNo
operationYes

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations, the description carries full transparency burden. It discloses that dashy_replace_config performs a complete overwrite, not a merge, and that get defaults to conf.yml. It does not mention authentication or reversibility, but the core behavioral traits are clearly stated.

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

Conciseness5/5

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

The description is well-structured with a brief intro followed by bullet-like sub-operations. Each sentence provides actionable information without redundancy or filler, making it easy to parse and apply.

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

Completeness4/5

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

The description covers all three operations, their parameters, and critical overwrite behavior. Since an output schema is present, return values are handled structurally. Minor gaps include lack of error handling or prerequisite information, but overall the tool is sufficiently described for an agent to invoke correctly.

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?

The input schema only defines a generic `arguments` object with no structure, and schema description coverage is 0%. The description compensates by specifying the expected arguments for each operation (e.g., filename default, config object required), adding substantial meaning beyond the schema. The `config` object is partially specified (pageInfo, appConfig, sections, pages).

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 clearly identifies the tool as handling Dashy config operations and lists three specific operations (get, list, replace) with precise verbs and the target resource (Dashy config files). This distinguishes it from sibling tools like dashy_item or dashy_section, though differentiation is implicit rather than explicit.

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

Usage Guidelines3/5

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

The description explains how to use the tool by passing an `operation` and an `arguments` dict, and each sub-operation includes parameter details (e.g., filename default). However, there is no explicit guidance on when to use this tool versus sibling tools, nor any exclusions or prerequisites beyond the overwrite warning.

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

dashy_itemA

dashy item operations on Dashy. Pass operation and an arguments dict matching that operation's parameters.

  • dashy_add_item(sid, item, filename='') — Add a new item (tile) to a section (by index or exact name). item requires a title; common keys: title, url, icon, description, target.

  • dashy_delete_item(sid, iid, filename='') — Delete an item (tile) by index or exact title, within a section by index or exact name.

  • dashy_get_item(sid, iid, filename='') — Get one item (tile) by index or exact title, within a section by index or exact name.

  • dashy_list_items(sid, filename='') — List the items (tiles) in a section, by section index or exact name.

  • dashy_update_item(sid, iid, patch, filename='') — Shallow-merge patch into an item (by index or exact title), within a section (by index or exact name). Only the given fields change.

ParametersJSON Schema
NameRequiredDescriptionDefault
argumentsNo
operationYes

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.6/5.0
Behavior4/5

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

With no annotations provided, the description carries the full burden and does disclose meaningful behaviors: update performs a shallow-merge and only changes given fields; items require a title; lookups can be by index or exact name/title. It omits details like error handling, permissions, or irreversible consequences of delete, but covers the central behavioral nuances.

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

Conciseness5/5

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

The description is well-structured: a brief intro explaining the dispatcher pattern followed by a bullet list of operations, each with a concise summary. Every line adds semantic value, and the formatting makes it easy to scan.

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?

Given the tool's complexity as a multi-operation dispatcher, the description covers all five operations, their parameters, key constraints, and behavioral details. The presence of an output schema reduces the need to describe return values, so the description is sufficiently complete for an agent to select and invoke the correct sub-operation.

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

Parameters5/5

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

The input schema only lists `operation` and an untyped `arguments` object, offering no parameter-level meaning. The description compensates fully by giving explicit function signatures for each operation, naming parameters (sid, item, iid, filename, patch), and explaining what `item` requires and what `patch` does.

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 clearly identifies the tool as a dispatcher for Dashy item operations, enumerating five specific sub-operations (add, delete, get, list, update) with clear verb-resource pairs. It distinguishes from sibling tools by focusing solely on items, not config, key, or section operations.

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?

The description explains how to invoke the tool (pass an operation and matching arguments) and details each operation's purpose, effectively guiding which sub-operation to choose. However, it does not explicitly state when not to use this tool or direct users to sibling tools for non-item operations, so alternative guidance is only implied by sibling names.

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

dashy_keyA

dashy key operations on Dashy. Pass operation and an arguments dict matching that operation's parameters.

  • dashy_get_key(key, filename='') — Get one top-level config key: pageInfo, appConfig, sections, or pages.

  • dashy_set_key(key, value, filename='') — Replace one top-level config key (pageInfo, appConfig, sections, or pages) with value. This is a complete replacement of that key, not a merge.

ParametersJSON Schema
NameRequiredDescriptionDefault
argumentsNo
operationYes

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A3.6/5.0
Behavior4/5

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

The description explicitly discloses that dashy_set_key performs a 'complete replacement of that key, not a merge,' which is crucial behavior beyond a simple 'set' operation. Since no annotations are provided, this transparency is essential. It also clarifies that get/set operate on 'top-level config keys,' setting expectations about scope.

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

Conciseness4/5

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

The description is compact, with two bullet-like lines per operation. The opening 'dashy key operations on Dashy' is slightly redundant with the tool name, but the overall structure is efficient and front-loaded.

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

Completeness4/5

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

Given the tool's simplicity and the presence of an output schema, the description covers the essential operations and their parameters. It could mention error handling or return values, but the non-merge behavior is a key completeness factor. Sibling tools are not addressed, but the scope is clear.

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?

With 0% schema description coverage, the description compensates by listing each operation's parameters: key, filename, value, and the allowed top-level keys (pageInfo, appConfig, sections, pages). This adds meaning beyond the bare schema which only shows operation and arguments.

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

Purpose4/5

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

The description opens with 'dashy key operations on Dashy,' which is vague, but then specifies two operations: 'dashy_get_key' to get a top-level key (pageInfo, appConfig, sections, or pages) and 'dashy_set_key' to replace it. This clearly identifies the verb and resource, and the 'top-level' scope helps distinguish it from sibling tools, although it doesn't explicitly reference them.

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

Usage Guidelines2/5

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

No guidance is given on when to use this tool versus siblings like dashy_config or dashy_section. The description only says 'Pass operation and an arguments dict matching that operation's parameters,' which is an invocation instruction, not a usage guideline.

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

dashy_sectionA

dashy section operations on Dashy. Pass operation and an arguments dict matching that operation's parameters.

  • dashy_add_section(section, filename='') — Add a new section (a group of tiles) to the dashboard. section requires a name; common keys: name, icon, items, displayData.

  • dashy_delete_section(sid, filename='') — Delete a section (by index or exact name), including all its items.

  • dashy_get_section(sid, filename='') — Get one section by zero-based index or exact section name.

  • dashy_update_section(sid, patch, filename='') — Shallow-merge patch into a section (by index or exact name). Only the given fields change; a nested array in patch replaces the existing one wholesale.

ParametersJSON Schema
NameRequiredDescriptionDefault
argumentsNo
operationYes

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.8/5.0
Behavior5/5

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

The description discloses key behaviors beyond the schema: deletion removes all items, update uses shallow-merge with wholesale replacement of nested arrays, and sections are identified by index or exact name. With no annotations, this level of detail carries the safety and side-effect profile well.

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

Conciseness5/5

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

The description is front-loaded with the dispatch pattern and uses a clean bullet list for the four operations. Each line earns its place by adding unique information, with no fluff or repetition. It is appropriately sized for the complexity.

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?

The description covers all operations, parameter nuances, and behavioral edge cases, making it self-contained for selection and invocation. The existence of an output schema means return values need not be described, and none are omitted. It leaves no major gaps for a dispatcher tool of this type.

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

Parameters5/5

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

Schema coverage is 0%, so the description is the sole source of parameter meaning. It lists each operation's parameters (e.g., 'section requires a name; common keys: name, icon, items, displayData') and explains the `arguments` dict. This compensates fully for the schema's lack of descriptions.

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 clearly states it handles 'dashy section operations' and enumerates four specific sub-operations (add, delete, get, update) with distinct actions. This verb+resource structure distinguishes it from sibling tools like dashy_item and dashy_key.

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 explains the dispatch pattern (pass operation and arguments dict) and provides context for each operation, such as 'by index or exact name' and 'shallow-merge patch'. While it doesn't explicitly mention alternatives or when-not-to-use, the scoping to sections is clear.

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

TDQS

A4/5.0
Disambiguation4/5

The four tools target distinct levels of the Dashy config hierarchy (config file, top-level keys, sections, items). While there is some overlap—e.g., dashy_key can get/set the 'sections' key—the intended granularity is clear. A minor ambiguity exists because key operations could be used to access sections/items, but the descriptions guide toward the resource-specific tools.

Naming Consistency4/5

All tool names follow a consistent dashy_<noun> pattern (config, key, section, item), which is predictable. The operation names embedded within each tool also use consistent verb_noun snake_case (e.g., get_config, add_section, delete_item). The only deviation is that the tool names are nouns rather than verbs, but this is uniform across the set.

Tool Count4/5

Four tools is slightly few for a config management server, but each tool is a dispatcher covering multiple related operations, so the effective scope is broader. This keeps the tool count within a reasonable range and avoids overwhelming the agent with 18 separate tools.

Completeness4/5

The server covers the primary lifecycle for config management: reading/replacing full configs, getting/setting top-level keys, and CRUD for sections and items. Notable missing operations include a list_sections function, but sections can be retrieved via get_config or get_key, and the rest of the surface is functional.

Maintenance

ActivityMaintained
ResponsivenessSyncing

Related MCP Connectors

Related MCP Servers

  • A
    license
    A
    quality
    C
    maintenance
    MCP server for full Home Assistant control, enabling AI agents to manage dashboards, automations, files, apps, entities, and more via REST API, WebSocket, and SSH.
    66
    92
    MIT
  • A
    license
    C
    quality
    A
    maintenance
    MCP server for OpenHAB v5+ that exposes the entire REST API as tools for AI models, enabling complete control over items, things, rules, persistence, and semantic model.
    25
    7
    MIT
  • A
    license
    A
    quality
    A
    maintenance
    MCP server exposing Dashbrr's REST API as tools, so an LLM can read and manage a dashbrr instance: configured services, per-service health, and summary panels for many apps. Write tools cover settings management, download-queue deletes, Overseerr approvals, UI preferences, and the Plex auth PIN flow.
    34
    MIT

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/SavageCore/dashy-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server