Skip to main content
Glama
Sign In

Agentic Mermaid

by io.github.adewale
OverviewDiscussionsAdmin

Describe Mermaid SDK operations

describe_sdk
Read-onlyIdempotent

Return version-matched mutation operations for one diagram family, or use capability=resolved-scene for painted geometry, runtime limits and typed errors. Use detail=signatures for the compact op menu or detail=fields (default) for exact field types, required flags, enum values, defaults, and constraints. Call this before build, mutate, or execute when the family schema is not already known.

Input Schema

NameRequiredDescriptionDefault
detailNosignatures for a compact menu; fields for the complete schema (default).
familyNoDiagram family whose mutation operations are needed.
capabilityNoRead-only rendering capability; use instead of family.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • addedInput schema / oneOf
      Added value: +[
+  {
+    "required": [
+      "family"
+    ]
+  },
+  {
+    "required": [
+      "capability"
+    ]
+  }
+]
    • addedInput schema / properties / capability
      Added value: +{
+  "description": "Read-only rendering capability; use instead of family.",
+  "enum": [
+    "resolved-scene"
+  ],
+  "type": "string"
+}
    • changedInput schema / properties / family / enum
      Previous value: -[
-  "flowchart",
-  "state",
-  "sequence",
-  "timeline",
-  "class",
-  "er",
-  "journey",
-  "architecture",
-  "xychart",
-  "pie",
-  "quadrant",
-  "gantt",
-  "mindmap",
-  "gitgraph",
-  "radar"
-]New value: +[
+  "flowchart",
+  "state",
+  "sequence",
+  "timeline",
+  "class",
+  "er",
+  "journey",
+  "architecture",
+  "xychart",
+  "pie",
+  "quadrant",
+  "gantt",
+  "mindmap",
+  "gitgraph",
+  "radar",
+  "sankey",
+  "c4",
+  "packet",
+  "kanban",
+  "requirement",
+  "treemap",
+  "ishikawa",
+  "block",
+  "eventmodeling",
+  "zenuml"
+]
    • removedInput schema / required
      Removed value: -[
-  "family"
-]
  2. Changed1 schema field changed
    • changedInput schema / properties / family / enum
      Previous value: -[
-  "flowchart",
-  "state",
-  "sequence",
-  "timeline",
-  "class",
-  "er",
-  "journey",
-  "architecture",
-  "xychart",
-  "pie",
-  "quadrant",
-  "gantt",
-  "mindmap",
-  "gitgraph"
-]New value: +[
+  "flowchart",
+  "state",
+  "sequence",
+  "timeline",
+  "class",
+  "er",
+  "journey",
+  "architecture",
+  "xychart",
+  "pie",
+  "quadrant",
+  "gantt",
+  "mindmap",
+  "gitgraph",
+  "radar"
+]
  3. Changed1 schema field changed
    • addedInput schema / additionalProperties
      Added value: +false
  4. Added

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false. The description adds useful context: output is version-matched, detail controls compact versus complete schema views, and capability mode returns painted geometry, runtime limits, and typed errors. It does not add auth or rate-limit behavior, but that is minor given the read-only annotations.

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?

Three tightly written sentences, front-loaded with purpose and followed by mode guidance and call timing. Every sentence carries distinct operational value with no repetition or filler.

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 must carry return-value context. It does this well by naming the returned operation data and explaining the two detail modes and the capability mode, though it does not describe the exact response shape.

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?

Schema description coverage is 100%, so the baseline is 3. The description still adds meaning beyond the schema by explaining what detail=signatures versus detail=fields yields and that capability=resolved-scene returns painted geometry, runtime limits, and typed errors.

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?

States a specific verb and resource: returning version-matched mutation operations for one diagram family. It also distinguishes the alternative capability=resolved-scene mode, so an agent can tell what this tool does without opening the schema.

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?

Explicitly says to call this before build, mutate, or execute when the family schema is not already known. It also gives the condition for using capability=resolved-scene and explains detail=signatures versus detail=fields.

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

All Agentic Mermaid toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources