Skip to main content
Glama

uml.singsk.com PlantUML

encode_source

Encode PlantUML source into a URL token and ready-to-use share/render URLs (svg + png). The result carries url_ok: GET URLs only work while the token is at most 16000 characters; when url_ok is false do not share the URLs - render with render_diagram instead (it uses the POST API, no size limit up to 5 MB). Tokens use PlantUML's own 64-character alphabet ("0-9 A-Z a-z - _") over raw DEFLATE. This is NOT base64 - never encode or decode tokens with a base64 codec; use encode_source / decode_token.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
textYes

TDQS

A4.9/5.0
Behavior5/5

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

With no annotations provided, the description carries the full behavioral disclosure burden and does so thoroughly. It reveals the URL length limit of 16000 characters, the url_ok flag, the DEFLATE-based algorithm, the custom 64-character alphabet, and the POST-vs-GET API distinction with size limits. This is rich, non-obvious behavioral context that an agent needs to avoid misuse.

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?

The description is concise and front-loaded: the first sentence states the core purpose, followed by critical usage constraints, the alternative tool, and a caveat against base64 confusion. Every sentence carries necessary operational information, with no filler or redundant restatement of the tool name.

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?

The description is complete for the tool's complexity: it covers the operation, output type, size limits, fallback behavior, and encoding specifics, all without an output schema. An agent can determine whether and how to invoke encode_source correctly, and knows exactly when to route to render_diagram instead.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 0% description coverage and only declares 'text' as a string, so the description must compensate by explaining what text means. The description clarifies that text is PlantUML source, which is essential semantic context not present in the schema. It does not fully elaborate edge-case format requirements, but for a single-parameter tool this is adequate.

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 clearly states a specific verb and resource: encoding PlantUML source into a URL token and ready-to-use SVG/PNG share/render URLs. It also distinguishes itself from related siblings like render_diagram and decode_token by explaining what it is not and which sibling handles the alternative operation.

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

Usage Guidelines5/5

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

The description gives explicit when-to-use and when-not-to-use guidance: when url_ok is false, do not share the URLs and instead use render_diagram, which uses the POST API with no size limit up to 5 MB. It also explicitly warns against using base64 codecs and directs users to encode_source/decode_token instead, naming alternatives and conditions clearly.

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.

TDQS

A4.5/5.0
Disambiguation5/5

Each tool has a clearly distinct responsibility: encoding/decoding tokens, rendering/validating diagrams, and retrieving syntax/reference information. The descriptions explicitly call out potential confusion points (e.g., token alphabet vs base64) and separate render from validate.

Naming Consistency5/5

All tool names follow a consistent lowercase snake_case verb_noun pattern: decode_token, encode_source, get_syntax_reference, list_diagram_types, render_diagram, validate_diagram. This makes the tool set predictable and easy to navigate.

Tool Count5/5

Six tools is well-scoped for a PlantUML-focused server: two token operations, two diagram lifecycle operations, and two reference/type lookup operations. There is no redundancy and no missing core capability that would require more tools.

Completeness5/5

The tool set covers the full diagram workflow: picking a type, getting syntax guidance, validating source, rendering output, and encoding/decoding shareable tokens. Agents can complete both common and advanced PlantUML tasks without dead ends.

Resources