Skip to main content
Glama

uml.singsk.com PlantUML

get_syntax_reference

Get the syntax reference entry for one diagram type: description, a render-verified example, and the help page URL plus its Markdown twin (markdown_url - fetch it for the full reference in compact form). Use it to ground diagram generation.

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": {
      "type": "<type>"
    },
    "name": "get_syntax_reference"
  }
}

Input Schema

NameRequiredDescriptionDefault
typeYesType id or label, e.g. "sequence", "class", "mindmap", "gantt", "json"

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

No annotations exist, so the description carries the burden; it does disclose the exact return payload (description, render-verified example, URLs) and that it is a per-diagram-type lookup. It omits error behavior for unknown type ids and says nothing about the size/cost of the returned reference, which matters since the markdown twin is meant for fetching.

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?

Two sentences, the payload description first and the usage hint second, with the parenthetical explaining how to use markdown_url rather than leaving it opaque. Slightly dense but every clause carries information.

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 one-parameter read lookup with no output schema, the description correctly stands in for the return shape and explains the purpose of the two URLs. Only the failure mode for an invalid or unknown type id is left unaddressed.

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% and the schema itself supplies example type ids ("sequence", "class", "mindmap"), so the parameter is already well documented. The description only restates that type selects a single diagram type's reference, adding no new format or lookup semantics beyond 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?

Specific verb (get) plus resource (syntax reference entry for one diagram type), and it enumerates the payload: description, render-verified example, help page URL, and Markdown twin. It does not explicitly contrast with siblings like render_diagram or list_diagram_types, but the name and scope make the distinction inferable.

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?

'Use it to ground diagram generation' gives an implied workflow position (before rendering/validating), and the mention of the markdown_url offers a self-directed follow-up for the full reference. There is no explicit when-not guidance or named alternative tool, so guidance stays implied rather than stated.

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