Skip to main content
Glama

trmnl_get_plugin_setting_removal_preview

Read-onlyIdempotent

Preview what happens when removing a plugin setting installation, including affected resources, before confirming deletion.

Instructions

Preview installation removal TRMNL GET /api/plugin_settings/{plugin_setting_id}/removal_preview.

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.9/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds only the raw HTTP endpoint and says nothing about what the preview computes, whether it has side effects, or whether its result can go stale before a real delete.

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?

Two short lines with no waste, and the purpose is front-loaded. However, the second line is largely a restatement of the endpoint rather than information that helps the agent decide or invoke correctly.

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?

There is no output schema, so the description ideally would explain what a removal preview contains (e.g., what would be deleted). It gives enough to call the tool but not enough to interpret the response or place it in the removal workflow.

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%: the nested path object and plugin_setting_id have no schema descriptions, but the description's endpoint template does reveal that plugin_setting_id is a path segment. It adds no guidance on the 'profile' override beyond what the schema already says.

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

Purpose4/5

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

The description states a specific verb+resource: 'Preview installation removal' for a plugin setting, plus the underlying endpoint. It is distinguishable from siblings like trmnl_delete_plugin_setting, though the use of 'installation' rather than 'plugin setting' introduces mild ambiguity about which object is being removed.

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 use this versus trmnl_delete_plugin_setting, trmnl_cancel_installation, or trmnl_get_plugin_setting_details, and no hint that a preview is typically a precondition to deletion. The agent must infer the workflow entirely.

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