Skip to main content
Glama

trmnl_pipeline_save

Save a reusable JSON API-to-TRMNL middleware pipeline so you can define allowed sources, field mappings, target plugin, and refresh interval for repeatable display data updates.

Instructions

Save a reusable JSON API-to-TRMNL middleware pipeline. Disabled by default. Sources require an explicit host allowlist; secrets use TRMNL_SOURCE_* environment references. No JavaScript execution.

Input Schema

NameRequiredDescriptionDefault
idYes
definitionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.1

TDQS

A3.7/5.0
Behavior4/5

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

Beyond the annotations, the description adds substantive behavior: pipelines start disabled, sources need an explicit host allowlist, secrets must go through TRMNL_SOURCE_* env references, and no JavaScript runs. The significant gap is that it doesn't say what happens on an `id` collision, which matters because idempotentHint is false.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Four short sentences, front-loaded with the purpose and followed by the most consequential constraints. Nothing is redundant or padded.

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 and the nested definition schema has zero description coverage, so the description should explain more structure than it does. It covers the security-relevant parts (allowlist, env secrets, no JS) but leaves the target binding, interval cadence and id reuse behavior unaddressed.

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 0% for a two-parameter tool whose `definition` is a deeply nested object, so the description must carry the parameter semantics. It adds real meaning for the `sources` URL/headerEnv fields, but it says nothing about `id` semantics, `target.pluginSettingId`, `intervalMinutes` bounds, or `maxPayloadBytes`.

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 and resource: save a reusable JSON API-to-TRMNL middleware pipeline. That clearly distinguishes it from the related trmnl_pipeline_list, trmnl_pipeline_read, trmnl_pipeline_enable and trmnl_pipeline_run sibling tools, although the distinction is implied by the verb rather than called out explicitly.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies that this is a creation/update operation, but it never states when to choose saving over running or enabling a pipeline, nor does it say whether saving under an existing `id` overwrites, errors, or upserts. No exclusions or prerequisites are given beyond the source constraints.

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