Skip to main content
Glama

ZPL command help

zpl_command_help
Read-onlyIdempotent

Explain a single ZPL command: syntax, parameters with types/ranges/options, a fragment example and whether the Labelixa renderer draws it. Data comes from the same catalog that powers the public command reference pages.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
localeNoLanguage for the human-readable fields (name and descriptions). Command codes, syntax strings, examples and parameter names never change.en
commandYesZPL command code, e.g. FO, ^BC, ~DG

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / locale
      Added value: +{
      +  "default": "en",
      +  "description": "Language for the human-readable fields (name and descriptions). Command codes, syntax strings, examples and parameter names never change.",
      +  "enum": [
      +    "en",
      +    "tr",
      +    "de"
      +  ],
      +  "type": "string"
      +}
  2. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint, so the safety profile is covered. The description adds useful behavioral context by specifying what the response will contain and by noting the data source for the command reference, going beyond the structured fields.

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?

Two sentences with no filler; the first sentence front-loads the tool's core behavior and output contents, and the second adds provenance concisely. Every clause earns its place.

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?

For a simple read-only lookup tool, the description enumerates all meaningful output categories and the schema fully documents both parameters. No output schema exists, but the description compensates by stating what the agent will receive.

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 description coverage is 100%, so both 'command' and 'locale' are already documented with examples and enum values. The description's mention of 'parameters with types/ranges/options' describes the tool's output rather than adding per-parameter meaning, so the baseline of 3 is appropriate.

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 description uses a specific verb ('Explain') and object ('a single ZPL command') and enumerates the concrete output: syntax, parameter types/ranges/options, a fragment example, and renderer support. This makes the tool's scope clear and distinguishes it from preview, validation, and broader explanation siblings.

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 single-command scoping implies when the tool should be used, but the description does not explicitly mention alternatives or state when not to use it. Given the existence of 'explain_zpl' among siblings, an explicit routing cue would have strengthened the guidance.

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.