Skip to main content
Glama

Encode text to the PlantUML classic URL encoding

plantuml_encode

Encodes PlantUML or any text into the classic URL-safe PlantUML payload for building renderable GET /svg/{enc} URLs. Returns only the encoding; prepend your server base.

Instructions

Encode PlantUML (or any) text to the PlantUML classic URL encoding (custom-base64 0-9A-Za-z-_ over the raw-deflate stream of the text's UTF-8 bytes, no prefix -- the SoWkI... form, rulebook §5.1). Returns the encoding itself, i.e. the {enc} payload of GET {base}/svg/{enc} -- the tool takes no base URL, so prepend the configured server base (SPECMGR_PLANTUML_URL for the url source) to build the renderable URL. Fully offline: no source, subprocess, or network is involved. Decode it back with the library's decode_puml (round-trip lossless).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
textYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.36.0

TDQS

A4.4/5.0
Behavior5/5

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

With no annotations, the description carries the full burden and does so thoroughly: it specifies the exact encoding algorithm, that it returns the {enc} payload itself with no base URL, that no source/subprocess/network is involved ('fully offline'), and that round-trips with decode_puml are lossless. This is rich behavioral context beyond a simple 'encode text' claim.

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?

The description is front-loaded with the core action and structured into useful clauses, but it is dense and includes parenthetical algorithm details and rulebook references that could be trimmed for a simple encode tool. It earns most of its length through actionable information, yet the density slightly harms readability.

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?

Given the tool's simplicity, the presence of an output schema (so return values need not be explained), and the absence of annotations, the description is complete: it covers what the tool does, how to use the output, offline behavior, and round-trip decoding. No critical information for correct invocation is missing.

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?

The schema has 0% description coverage for the single 'text' parameter. The description says 'Encode PlantUML (or any) text' and references 'the text's UTF-8 bytes', which confirms the input is text interpreted as UTF-8, but it does not explicitly define the parameter's expected content beyond that. The description adds marginal meaning but does not fully compensate for the schema's silence.

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 states a specific verb and resource ('Encode PlantUML (or any) text to the PlantUML classic URL encoding'), and the parenthetical algorithm detail distinguishes it from any sibling that might also manipulate PlantUML. An agent can immediately tell this is a pure encoding utility, not a validator or example fetcher.

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 description explains the context for using the output: 'prepend the configured server base ... to build the renderable URL', and mentions decoding via decode_puml for round-trips. However, it does not explicitly compare against alternatives like validate_plantuml or say when not to use it, leaving usage slightly inferred.

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