Skip to main content
Glama

trmnl_enable_plugin_setting_debug_logs

Enable 24-hour debug logging for a plugin setting so a private plugin records each fetch request and response for troubleshooting; read the captured logs with getPluginSettingLogs.

Instructions

Turn on debug logs for a day A private plugin then records the request and response of each fetch for 24 hours; read them with getPluginSettingLogs. TRMNL POST /api/plugin_settings/{id}/debug_logs. Changes remote state or starts work. Run only within the user-authorized scope.

Input Schema

NameRequiredDescriptionDefault
pathYes
profileNoConfigured profile name; defaults to default.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.1

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, openWorldHint=true and idempotentHint=false, so the safety profile is covered. The description adds genuine context beyond them: the effect auto-expires after 24 hours, exactly what is captured (each fetch's request and response), and a scoping caution about user-authorized use. It does not mention permissions required or whether the 24h window can be shortened.

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 key fact (debug logs, 24 hours) and the consumption path are front-loaded in the first two sentences; the API route follows as supporting detail. The trailing generic lines ('Changes remote state or starts work. Run only within the user-authorized scope.') are boilerplate that could be dropped without losing information.

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?

There is no output schema, and none is needed since the tool's result is just an enablement and the description points to `getPluginSettingLogs` for the actual data. Combined with annotations covering safety and the description covering effect duration and what is captured, an agent has everything needed to call this correctly.

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 50% and the description never mentions either parameter; only the URL template hints at the required plugin setting id. The schema itself documents both leaf properties (`id` as plugin setting id or uuid, `profile` defaulting to default), so the schema carries the load. Baseline 3 applies since the description neither compensates for nor worsens the gap.

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 (turn on) and resource (debug logs for a plugin setting), plus the exact scope: 24 hours of recorded fetch request/response. It also explicitly routes the agent to the sibling tool `getPluginSettingLogs` for reading the output, so it is distinguishable from `trmnl_get_plugin_setting_logs` and other plugin_setting siblings at a glance.

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 makes the use case concrete (record request/response of each fetch for 24 hours) and names the follow-up call needed to consume the data, which is exactly the context an agent needs before invoking it. It stops short of explicit exclusions, e.g. whether there is a way to disable early or whether repeated calls extend the window, but the context is clear.

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