Skip to main content
Glama

render_c4_mermaid

Renders C4 architecture diagrams as Mermaid source and compact PNGs, with optional Markdown, SVG, PNG, and interactive HTML exports for review and sharing.

Instructions

Renders a compact C4 PNG using server-side orthogonal layout, plus Mermaid source. With outputPath saves Markdown, SVG, PNG and interactive HTML with connection highlighting and full-diagram PNG/SVG exports.

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": {
      "title": "<title>",
      "c4Level": "<c4Level>",
      "nodes": "<nodes>",
      "relationships": "<relationships>"
    },
    "name": "render_c4_mermaid"
  }
}

Input Schema

NameRequiredDescriptionDefault
nodesYes
titleYes
c4LevelYes
outputPathNoMarkdown destination ending in .md
relationshipsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0-alpha.1

TDQS

B3.2/5.0
Behavior3/5

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

With no annotations, the description carries the behavioral burden, and it does disclose the return artifacts (PNG plus Mermaid source) and the outputPath side effects (Markdown, SVG, PNG, interactive HTML with highlighting and full-diagram exports). What it omits is whether files are overwritten, what happens on invalid paths, or that the tool writes to disk at all as a mutation — meaningful gaps for an unannotated write-capable tool.

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 tight sentences, front-loaded with the primary output and followed by the conditional outputPath behavior. Dense but no wasted clauses; the second sentence is a long run-on list but still serves a purpose.

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

Completeness3/5

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

For a 5-parameter tool with 4 required inputs and no output schema, the description covers outputs but leaves the graph model (nodes/relationships expectations, valid id referencing) and file-system side effects unexplained. Adequate minimum viability, not complete.

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 only 20%, so the description must compensate. It valuably expands outputPath beyond the schema's narrow 'Markdown destination ending in .md' note by revealing that four other artifact types are also written, but it says nothing about title, c4Level, nodes, or relationships semantics beyond the enum/field names in 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?

The description states a specific verb and resource: 'Renders a compact C4 PNG using server-side orthogonal layout, plus Mermaid source.' An agent knows exactly what artifact comes out, but it never distinguishes this from the sibling render_architecture_graph, so sibling disambiguation is left to name inference.

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?

There is no when-to-use guidance and no mention of alternatives, despite render_architecture_graph being an obvious overlapping sibling. The one implicit rule is that supplying outputPath unlocks file output, which is stated as behavior rather than as a usage decision.

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