Skip to main content
Glama

trmnl_setup_device

Register a TRMNL ePaper device by sending its MAC address, model, and panel revision to the setup API, returning status so you can confirm pairing and identify missing devices.

Instructions

Set up device Please note that the returned status JSON value may NOT always equal the HTTP status code. Notably, if a device MAC address is not found, then the HTTP status code will be 200 but the status code in the response will be 404.

TRMNL GET /api/setup. Changes remote state or starts work. Run only within the user-authorized scope.

Input Schema

NameRequiredDescriptionDefault
headersYes
profileNoConfigured profile name; defaults to default.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.1

TDQS

C2.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, idempotentHint=false, openWorldHint=true. The description adds genuinely useful behavioral context not in annotations: the response `status` field may diverge from the HTTP code, specifically HTTP 200 with status 404 when a MAC isn't found. It also notes this changes remote state despite the GET endpoint, reconciling the read-method/write-behavior tension.

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?

Structure is scattered: the least informative sentence ("Set up device") is front-loaded, followed by a caveat paragraph, then the endpoint line, then a generic policy line. Content is largely useful but the ordering buries the behavioral warning and mixes concerns.

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

Completeness3/5

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

For a non-idempotent mutation tool with nested params and no output schema, the description covers the response-status gotcha well but omits what setup does to existing device state, repeat-invocation behavior, and routing vs siblings. Adequate but with clear gaps.

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

Parameters2/5

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

Schema coverage is 50% and the description adds no parameter-level meaning at all — nothing about the required ID (MAC), Model, optional Panel-Rev, or the profile default. The nested headers object's leaf fields are described in the schema, but the description does nothing to compensate for the uncovered level or clarify how setup uses these values.

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

Purpose3/5

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

"Set up device" states a verb and resource but "set up" is vague about what actually happens (registering/provisioning a device from MAC + model). No differentiation from closely related siblings like trmnl_claim_device, trmnl_identify_device, or trmnl_update_device, so the agent can't tell which one to pick from the description alone.

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?

There is no when-to-use guidance and no exclusions or alternatives named, despite a crowded sibling space with several device-registration-ish tools. The only guidance is a generic safety line ("Run only within the user-authorized scope").

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