Skip to main content
Glama

sequence_diagram

Read-onlyIdempotent

Build Mermaid sequence diagrams from participants and ordered messages, including notes, activation, and alt/loop blocks while rejecting unknown participants.

Instructions

Build a Mermaid sequence diagram from participants and ordered messages, with optional activation, notes and alt/loop blocks. Rejects unknown participants.

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>",
      "participants": "<participants>",
      "messages": "<messages>"
    },
    "name": "sequence_diagram"
  }
}

Input Schema

NameRequiredDescriptionDefault
titleYes
messagesYes
participantsYes

Output Schema

NameRequiredDescriptionDefault
kindNo
mermaidNo
sourcesNo
messagesNo
validatedNo
limitationNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv0.5.0
    • removedInput schema / properties / messages / items / additionalProperties
      Removed value: -false
    • removedInput schema / properties / messages / items / properties / block / additionalProperties
      Removed value: -false
    • changedInput schema / properties / messages / items / properties / block / required
      Previous value: -[
      -  "kind",
      -  "label"
      -]New value: +[
      +  "kind"
      +]
    • changedInput schema / properties / messages / items / required
      Previous value: -[
      -  "from",
      -  "to",
      -  "text",
      -  "style",
      -  "activate"
      -]New value: +[
      +  "from",
      +  "to",
      +  "text"
      +]
    • removedInput schema / properties / participants / items / additionalProperties
      Removed value: -false
    • changedInput schema / properties / participants / items / required
      Previous value: -[
      -  "id",
      -  "label",
      -  "kind"
      -]New value: +[
      +  "id",
      +  "label"
      +]
  2. First observedv0.4.1

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive, and closed-world behavior, so the safety profile is fully covered. The description genuinely adds one behavioral trait beyond that — 'Rejects unknown participants' — but says nothing about what the rejection looks like or how message ordering/blocks are validated.

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?

Two tight sentences with no filler, and the core capability plus optional features are front-loaded. Every clause carries information.

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 moderately complex tool with nested participant/message arrays and an output schema, the description covers the main concepts and would let an agent attempt a call. It leaves real gaps around the enumerated style/kind options and the structural limits that the schema lists without explaining.

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 description coverage is 0%, so the description must carry the parameter burden, and it only partly does. It explains participants, ordered messages, activation, notes, and alt/loop blocks, but never mentions title, message 'style' (sync/async/reply), participant 'kind' (actor/participant), or the numeric caps (60 messages, 15 participants) that shape valid calls.

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 names a specific verb and artifact: 'Build a Mermaid sequence diagram,' and identifies its inputs (participants, ordered messages) plus the optional capabilities it supports. It does not distinguish itself from diagram-oriented siblings such as architecture_diagram or c4_model, so it falls short of a 5.

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 named alternative. An agent choosing between sequence_diagram, architecture_diagram, and c4_model gets no routing signal from the description beyond the word 'sequence,' which is only implicit.

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