atoms_export_mermaid

Generate a Mermaid-syntax diagram showing the hierarchical relationships between requirements and test cases. In capable MCP hosts, this tool renders an interactive MCP App with pan and zoom controls for exploring the diagram visually.

Parameters

Parameter	Type	Required	Description
`project_id`	`string (UUID)`	Yes	The project to generate the diagram for
`root_item_id`	`string`	No	Start the diagram from a specific item (e.g., `REQ-001`). Omit to diagram the entire project
`depth`	`number`	No	Maximum depth of the hierarchy to traverse (1-10). Default: `3`
`include_tests`	`boolean`	No	Whether to include test cases in the diagram. Default: `true`

Example Response

{
  "status": "success",
  "data": {
    "mermaid": "graph TD\n  REQ-001[\"System shall maintain audit trail\"]\n  REQ-002[\"Audit log entries are immutable\"]\n  TC-012[\"Verify audit log on login\"]\n  REQ-001 --> REQ-002\n  TC-012 -.->|verifies| REQ-001",
    "node_count": 3,
    "edge_count": 2
  }
}

Notes

This tool is read-only and does not modify any data (readOnlyHint: true).
The mermaid string in the response can be pasted directly into any Mermaid renderer (e.g., GitHub Markdown, Mermaid Live Editor, or documentation tools).
Set include_tests to false to generate a requirements-only hierarchy diagram, useful for structural reviews.
Use root_item_id to scope the diagram to a specific subtree rather than the full project. This is helpful for large projects where a full diagram would be too dense.
Higher depth values produce more complete diagrams but may be slower for deeply nested hierarchies.

atoms_export_mermaid

Parameters

Example Response

Notes

On this page