hubdocs

Local MCP for arc42 × C4 docs hubs: index architecture/product IDs, deps, orphans, broken links, and chapter routing — so agents query the hub without dumping whole trees.

Indexes and validates Markdown only — does not replace Structurizr or diagram renderers.

• GitHub: raintr91/hubdocs

• Init (agents): docs/INIT.md

• Package bootstrap: docs/INSTALL.md

What it does

Related MCP server: Documentation MCP Server

Quick start

Linux / WSL

curl -fsSL https://raw.githubusercontent.com/raintr91/hubdocs/main/install.sh | bash
hubdocs version
cd /path/to/your/docs-hub    # thư mục có architecture/
hubdocs init --yes           # ↑↓ · Space nếu bỏ --yes

Windows

irm https://raw.githubusercontent.com/raintr91/hubdocs/main/install.ps1 | iex

Requires Node ≥ 22.

init tự lấy cwd làm HUBDOCS_ROOT. Chỉ cần --docs-root=… khi chạy từ chỗ khác.

Sau init: restart agent → thử tool hubdocs_list_ids.

Update

Cùng lệnh cài — ghi đè ~/.hubdocs + symlink CLI:

curl -fsSL https://raw.githubusercontent.com/raintr91/hubdocs/main/install.sh | bash
hubdocs version

Pin bản cụ thể:

HUBDOCS_REF=v0.1.0 curl -fsSL https://raw.githubusercontent.com/raintr91/hubdocs/v0.1.0/install.sh | bash

Windows: chạy lại irm …/install.ps1 | iex.

Sau update: nếu đổi wire MCP thì cd docs hub → hubdocs init --yes rồi restart agent.

Uninstall: curl -fsSL …/install.sh | bash -s -- --uninstall

Commands

install = deprecated alias của init.

Agents hỗ trợ: Claude · Cursor · Codex · opencode · Hermes · Gemini · Antigravity · Kiro · Kilo.

MCP tools

Manual Cursor snippet: mcp.cursor.example.json. Ưu tiên hubdocs init sau install.sh.

Docs root: HUBDOCS_ROOT hoặc --docs-root (hub phải có architecture/).

Redirect stubs (old flat C4) bị bỏ qua khi index. DYN-* không còn được index — dùng FLOW-*.

License

MIT