Skip to main content
Glama

TRMNL

by com.trmnl
OverviewDiscussionsAdmin

Change plugin settings

AccountPluginSettingsWriteTool
Destructive

Create, rename, configure, copy or delete plugin instances (plugin settings): push data or an image, replace a private plugin's files, reset health or state, and manage the featured image and transform. deletePluginSetting and resetPluginSettingCredentials are destructive.

  • createPluginSetting: Create a new plugin setting — params: name (body), plugin_id (body)

  • updatePluginSetting: Rename a plugin setting or change how it refreshes — params: id (path), name (body), description (body), refresh_interval (body: one of 1440, 720, 480, 360, 240, 120, 60, 30, 15, 10, 5), health_notification_enabled (body: Email the owner when the instance stops rendering)

  • deletePluginSetting: Delete a plugin setting — params: id (path)

  • updatePluginSettingFields: Update plugin settings fields — params: plugin_setting_id (path), fields (body)

  • updatePluginSettingData: Update data for a webhook plugin setting — params: id (path), merge_variables (body)

  • importPluginSettingFiles: Replace the files of a private plugin — params: plugin_setting_id (path), files (body)

  • uploadPluginSettingImage: Upload an image for a webhook_image plugin — params: id (path), image_base64 (body: The image bytes, base64 encoded)

  • copyPluginSetting: Copy a plugin setting — params: id (path)

  • clearPluginSettingState: Clear the state a plugin setting has accumulated — params: id (path)

  • enablePluginSettingDebugLogs: Turn on debug logs for a day — params: id (path)

  • resetPluginSettingHealth: Reset the health of a plugin setting that stopped rendering — params: id (path), include_forks (query)

  • setPluginSettingFeaturedImage: Generate the marketplace preview image of a plugin setting — params: id (path)

  • removePluginSettingFeaturedImage: Remove the marketplace preview image of a plugin setting — params: id (path)

  • removePluginSettingTransform: Remove the transform script of a private plugin — params: id (path)

  • verifyCustomFields: Check the custom fields YAML of a recipe — params: custom_fields (body: The custom fields as a YAML list)

  • resetPluginSettingCredentials: Forget the linked account and remove the plugin setting — params: id (path)

Input Schema

NameRequiredDescriptionDefault
actionYesThe API operation to run
paramsNoThe operation's path, query and body parameters by name

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations carry readOnlyHint=false, destructiveHint=true and idempotentHint=false, but the description adds real value by narrowing destructiveness to deletePluginSetting and resetPluginSettingCredentials rather than the blanket hint, and by explaining side effects such as 'Forget the linked account and remove the plugin setting' and 'Turn on debug logs for a day'. It does not cover return behavior, but the safety picture is materially enriched beyond the annotations.

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?

Sized appropriately for a 16-action dispatcher with no wasted prose; the general purpose leads and the per-action bullets are terse and scannable. The list is necessarily long, but each line earns its place by disambiguating an enum value and its params.

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 no output schema, a destructive multi-action dispatcher, and nested params, the description supplies enough to select and call any action correctly. It omits mention of permissions/auth requirements and response shapes, which is a minor gap rather than a blocking one.

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?

Top-level schema description coverage is 100% but the schema only models generic action/params, so the description does the heavy lifting by specifying each action's path/query/body parameters, including the refresh_interval enum values and the base64 image format. This adds meaning well beyond the structured schema and genuinely helps correct invocation.

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 opening sentence names a specific verb set (create, rename, configure, copy, delete) and resource (plugin instances / plugin settings), and the name/sibling set makes clear this is the write counterpart to AccountPluginSettingsReadTool. Each of the 16 sub-actions is enumerated with its verb and resource, so an agent can identify the exact operation without opening the 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?

The per-action descriptions act as strong selection guidance among the 16 enum values (e.g., copyPluginSetting vs importPluginSettingFiles vs uploadPluginSettingImage), and it flags the two destructive operations. It stops short of stating when to prefer this tool over the Read sibling or the broader AccountPluginsTool, so context is clear but no explicit exclusions.

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

All TRMNL toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources