Skip to main content
Glama

trmnl_get_plugin_configuration

Read-onlyIdempotent

Retrieve typed configuration for a TRMNL plugin setting by ID to inspect safe settings before authoring or updating a display.

Instructions

Read safe typed configuration TRMNL GET /api/plugin_settings/{plugin_setting_id}/configuration.

Input Schema

NameRequiredDescriptionDefault
pathYes
profileNoConfigured profile name; defaults to default.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.1

TDQS

C2.4/5.0
Behavior2/5

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

Annotations already declare readOnly, idempotent, non-destructive, open-world behavior, so the description's marginal contribution is what matters. "Safe typed" vaguely hints that sensitive/credential values are excluded or typed, but it never states that explicitly or says anything about scoping by profile or whether unset values appear.

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?

It is short and front-loads the verb, but the second line is a bare HTTP path that mostly duplicates the tool name rather than adding information. "Safe typed" is unexplained filler.

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 simple read-only GET with a two-parameter schema, the minimum is present, especially since annotations carry the safety profile. It is still thin on what the configuration contains and how it relates to the similarly named configuration tools.

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 description coverage is 50%: profile is documented in the schema, but the nested plugin_setting_id has no description. The tool description adds nothing about either parameter, so it does not compensate for the gap.

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?

"Read safe typed configuration" paired with the endpoint path does convey a read of plugin-setting configuration, but "safe typed configuration" is jargon that does not precisely state what is returned. It also fails to differentiate itself from nearby siblings such as trmnl_get_plugin_configuration_choices or trmnl_get_plugin_setting_data.

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 statement of when to call this versus the many sibling read tools for plugin settings and configuration. The agent must infer usage from the name alone.

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