Skip to main content
Glama
Sign In
streamdeck-mcp

streamdeck-mcp

by hugoacfs
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

streamdeck_read_page

Reads a Stream Deck profile page by profile name or ID and page index or directory ID, returning each button/dial's raw native action object for reuse in page updates.

Instructions

Read a profile page by profile name or ID and page index or directory ID. Each button/dial includes a 'raw' native action object — copy it into streamdeck_write_page's button 'action' field to reuse configured plugin settings without guessing. For searching across many pages, prefer streamdeck_find_actions.

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": "streamdeck_read_page"
  }
}

Input Schema

NameRequiredDescriptionDefault
page_indexNoZero-based page index from streamdeck_read_profiles. Accepts int or a string form.
profile_idNoDirectory-based profile ID, usually the .sdProfile folder name without the suffix.
directory_idNoPage directory ID from streamdeck_read_profiles. This is the safest target for updates.
profile_nameNoExact profile name as shown in the Elgato app.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

A4.2/5.0
Behavior4/5

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

No annotations are supplied, so the description carries the full burden, and it does disclose the important behavioral fact with no output schema: each button/dial entry contains a 'raw' native action object that can be reused verbatim. The read-only, non-mutating nature is clear from "Read." It does not cover error behavior (e.g. what happens when no target parameter is given) or performance over large profiles.

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?

Three short sentences, front-loaded with the core action, then the practical reuse tip, then the routing alternative. No filler and no repetition of the schema prose.

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?

For a read-only tool with four fully described parameters and no output schema, the description covers the essentials, including the shape of the returned action data that the schema cannot express. The only shortfall is the absence of guidance on how to combine the four optional targeting parameters when none are required.

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

Parameters3/5

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

Schema coverage is 100%, so all four parameters are already documented in the input schema; the description mostly restates that a page can be addressed by name/ID and index/directory ID. It does not clarify precedence or required combinations among the four optional parameters, which is the one semantic gap the schema leaves open.

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 ("Read a profile page") plus the two accepted targeting modes (profile name/ID and page index/directory ID). It also names the sibling it is not for search ("prefer streamdeck_find_actions"), so an agent can distinguish it from the other read tools without opening a schema.

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 explicit routing for the nearest alternative: searching across many pages should go to streamdeck_find_actions. It also supplies a concrete downstream usage pattern (copy the 'raw' action object into streamdeck_write_page). It stops short of saying when to pick profile_name vs profile_id vs directory_id, which is the remaining ambiguity for this tool.

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

Deploy Server

Other Tools