Skip to main content
Glama

describe_diagram

Read-only

Turn a plain-English description into Mermaid diagram source. Describe the flow, system, schema or timeline you want ("a login flow with an OAuth branch and a failure path") and get back complete, valid Mermaid - no need to know the syntax. The mermaid field of the response is directly usable as the mermaid_source input of convert_diagram, so describe -> render is a two-call pipeline. Generation runs on our infrastructure via AWS Bedrock; your description is not sent to any third-party service beyond that.

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": {
      "description": "<description>"
    },
    "name": "describe_diagram"
  }
}

Input Schema

NameRequiredDescriptionDefault
descriptionYesWhat the diagram should show, in plain language. Include the nodes/steps/entities you care about; the generator fills in sensible structure.
diagram_typeNoForce a specific Mermaid diagram type. Default "auto" - the generator picks the type that fits the description.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnlyHint=true, destructiveHint=false, openWorldHint=true, idempotentHint=false). The description adds genuinely new behavioral context: it names the response field ('the mermaid field'), discloses that generation runs on AWS Bedrock, and makes a privacy claim that the description is not sent to third parties. It does not mention latency or that output is non-deterministic beyond what idempotentHint already implies.

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?

Three sentences, front-loaded with the core transformation and example before the pipeline and hosting details. Slight promotional padding ('no need to know the syntax') that is arguably reassurance rather than instruction, but nothing is redundant.

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?

There is no output schema, so the description carries the burden of explaining the return value and does so by naming the mermaid field and its usability as convert_diagram's mermaid_source. For a two-parameter generator this is nearly complete; only the diagram_type trade-off and any limits or failure modes are 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%, so both parameters are already documented, and this is the baseline 3 case. The description adds a concrete illustrative example of a good 'description' value ('a login flow with an OAuth branch and a failure path'), but it never explains the diagram_type enum or when to force a type instead of leaving it 'auto'.

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 opens with a specific verb+resource+transformation: plain-English description in, Mermaid diagram source out. It also implicitly separates itself from the sibling convert_diagram by positioning this tool as the generation half of the pipeline, so an agent can tell the two apart without opening either schema.

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?

It gives clear when-to-use guidance ('Describe the flow, system, schema or timeline you want') and names the follow-on sibling explicitly: 'describe -> render is a two-call pipeline' with convert_diagram. It stops short of stating the inverse exclusion (e.g. 'if you already have Mermaid source, call convert_diagram directly'), which keeps it from a 5.

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.