Skip to main content
Glama

encode_plantuml

Encode PlantUML diagram code into URL-safe format for embedding diagrams in web pages and documentation.

Instructions

Encode PlantUML code for URL usage

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
plantuml_codeYesPlantUML diagram code to encode

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.3

TDQS

B3.2/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden. It does not disclose what the encoded output looks like, whether it's a pure transformation, or any error behavior. The phrase 'for URL usage' implies a URL-safe result but lacks specifics.

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 a single sentence, front-loaded with the verb, and contains no filler. It is appropriately sized for a tool with one parameter.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool has no output schema, so the description should explain the return value, but it doesn't. It also lacks context about when to use encoding and what the output format is. For a simple tool this is still a significant gap.

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 100% (the parameter is described as 'PlantUML diagram code to encode'), so the baseline is 3. The description adds no additional meaning about the parameter, such as format constraints or examples.

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 ('encode') and resource ('PlantUML code') with a clear purpose ('for URL usage'). It distinguishes from sibling tools like decode_plantuml (the inverse operation) and generate_plantuml_diagram (which creates diagrams).

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention that decode_plantuml is the inverse or give any context about when encoding is needed, leaving the agent to infer from the name alone.

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