mirror of https://github.com/diegosouzapw/OmniRoute.git synced 2026-08-01 12:52:11 +03:00

Files

Diego Rodrigues de Sa e Souza bed3984ac1 docs(mcp): correct MCP tool-inventory diagram source + text to 87 tools (#3909 )

* docs(mcp): correct the MCP tool-inventory diagram source + text to 87 tools

The mcp-tools diagram source was frozen at v3.8.8 (43 tools = 30 core + 3 memory +
4 skills + 6 notion) — missing the agent-skills, gamification, plugins and obsidian
modules, and Core had grown 30 → 33. Corrected to the real breakdown verified against
open-sse/mcp-server (TOTAL_MCP_TOOL_COUNT):

  33 core + 3 memory + 4 skills + 3 agent-skills + 8 gamification + 8 plugins
  + 6 notion + 22 obsidian = 87

- renamed mcp-tools-43.{mmd,svg} → mcp-tools-87.{mmd,svg}
- rewrote the .mmd source with the 8 real categories
- fixed MCP-SERVER.md: source-of-truth line, image alt, and the inventory caption
- fixed docs/diagrams/README.md index entry

check:doc-links PASS (links resolve).

⚠️ The committed mcp-tools-87.svg is the OLD render (still draws 43 tools): the SVG
must be regenerated with `npm run docs:render-diagrams` in an environment with a
working headless Chromium. It could NOT be rendered in this sandbox — Chromium is
missing system libraries (libnss3 / libatk / libcups / libxcb, no apt access). The
.mmd source and all surrounding text are correct, so a single render call finalizes
the image.

* docs(mcp): render mcp-tools-87.svg (87-tool inventory diagram)

2026-06-15 14:14:43 -03:00

exported

docs(mcp): correct MCP tool-inventory diagram source + text to 87 tools (#3909 )

2026-06-15 14:14:43 -03:00

authz-pipeline.mmd

docs(diagrams): create 8 canonical Mermaid sources + folder structure

2026-05-13 13:53:56 -03:00

auto-combo-9factor.mmd

docs(diagrams): create 8 canonical Mermaid sources + folder structure

2026-05-13 13:53:56 -03:00

cloud-agent-flow.mmd

docs(diagrams): create 8 canonical Mermaid sources + folder structure

2026-05-13 13:53:56 -03:00

db-schema-overview.mmd

docs(diagrams): create 8 canonical Mermaid sources + folder structure

2026-05-13 13:53:56 -03:00

i18n-flow.mmd

docs(diagrams): create 8 canonical Mermaid sources + folder structure

2026-05-13 13:53:56 -03:00

mcp-tools-87.mmd

docs(mcp): correct MCP tool-inventory diagram source + text to 87 tools (#3909 )

2026-06-15 14:14:43 -03:00

README.md

docs(mcp): correct MCP tool-inventory diagram source + text to 87 tools (#3909 )

2026-06-15 14:14:43 -03:00

request-pipeline.mmd

docs(diagrams): create 8 canonical Mermaid sources + folder structure

2026-05-13 13:53:56 -03:00

resilience-3layers.mmd

docs(diagrams): create 8 canonical Mermaid sources + folder structure

2026-05-13 13:53:56 -03:00

README.md

title, version, lastUpdated

title	version	lastUpdated
Diagrams	3.8.2	2026-05-13

Diagrams

Mermaid sources (.mmd) and exported SVGs for OmniRoute v3.8.0 architecture flows.

Canonical diagrams

Source	Exported	Used in
request-pipeline.mmd	SVG	docs/architecture/ARCHITECTURE.md, docs/architecture/CODEBASE_DOCUMENTATION.md
auto-combo-9factor.mmd	SVG	docs/routing/AUTO-COMBO.md
resilience-3layers.mmd	SVG	docs/architecture/RESILIENCE_GUIDE.md, CLAUDE.md
i18n-flow.mmd	SVG	docs/guides/I18N.md
mcp-tools-87.mmd	SVG	docs/frameworks/MCP-SERVER.md
cloud-agent-flow.mmd	SVG	docs/frameworks/CLOUD_AGENT.md
authz-pipeline.mmd	SVG	docs/architecture/AUTHZ_GUIDE.md
db-schema-overview.mmd	SVG	docs/architecture/CODEBASE_DOCUMENTATION.md

How to update

Edit *.mmd.
Re-render: npm run docs:render-diagrams (uses @mermaid-js/mermaid-cli).
Commit both .mmd and .svg.

If @mermaid-js/mermaid-cli is not available locally, install it once:

npm install -g @mermaid-js/mermaid-cli

The script renders every .mmd in docs/diagrams/ into docs/diagrams/exported/*.svg with a white background, suitable for both dark and light themes.

Linking from a doc

From a doc in docs/<subfolder>/, the relative path becomes ../diagrams/...:

![Request pipeline](../diagrams/exported/request-pipeline.svg)

> Source: [../diagrams/request-pipeline.mmd](../diagrams/request-pipeline.mmd)

From the repo root (e.g. CLAUDE.md):

![Resilience layers](./docs/diagrams/exported/resilience-3layers.svg)

Conventions

One concept per diagram. Don't try to fit the whole platform in one chart.
Keep node labels short (3-6 words). Use <br/> for line breaks inside nodes.
Prefer flowchart LR for pipelines and flowchart TB for layered models.
Use sequenceDiagram for interactive (request/response) flows.
Use erDiagram for database schema overviews.
Update both .mmd and .svg in the same commit. Keep them in lock-step.