Skip to main content
Glama

Update a format

update_text_template
Idempotent

[writes flayr data · write scope] Changes a format; only the fields you pass change. archived: true hides it. (Wraps PATCH /api/v2/text-templates/{id}.)

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "id": "<id>"
    },
    "name": "update_text_template"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes
nameNo
formatNo
lengthNo
sourceNoWhere the shape came from, e.g. an import path.
useForNoOne line: when to pick this format.
exampleNo
archivedNo
ctaSlotsNo
platformNoe.g. "linkedin"; null = any platform.
sectionsNoIn order. "Start from a format" writes one `[you fill: Label — guidance]` placeholder per section.
guardrailsNo
maxHashtagsNo
hookPatternsNo"[slot]" placeholders are kept as written.
defaultLabelsNo"key:value" labels every draft started from this format gets (plus the format's own `label`).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds meaningful context beyond that: write scope, PATCH partial-update semantics (only passed fields change), and the soft-hide behavior of archived. It does not describe auth/permission specifics or side effects on referenced content.

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?

Three compact clauses, front-loaded with the scope tag and core action, followed by the partial-update rule and the archived nuance. No filler, and the parenthetical endpoint reference is cheap provenance. Every sentence earns its place.

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?

For a 15-param nested PATCH with no output schema, the description covers the crucial semantics (partial update, write scope, archived hiding) that an agent needs to invoke safely. It is not exhaustive about nested field usage, but the schema carries that detail and no return values need explaining.

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?

With 15 parameters and only 40% schema description coverage, the description must compensate but largely does not. It adds useful meaning for `archived` (hides rather than deletes) and for partial updates generally, but nested structures like length, sections, ctaSlots, and trigger fields are left entirely to the schema.

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?

States a specific verb+resource ("Changes a format") that clearly maps to text templates and distinguishes it from create_text_template, delete_text_template, get_text_template, and list_text_templates by implication. It stops short of naming those siblings or their selection conditions, so differentiation is inferable rather than explicit.

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 partial-update usage via "only the fields you pass change" and gives one concrete behavior ("`archived: true` hides it"), but never states when to use this over create/delete/get/list or any prerequisites. Usage must be inferred from the sibling set.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources