Skip to content

docs: auto-sync architecture graph and MCP reference #744

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zaebee merged 1 commit into from
Oct 23, 2026
Merged

docs: auto-sync architecture graph and MCP reference #744

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/how-to/MCP_REFERENCE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,6 +407,31 @@ Whole-graph architectural metrics — coupling bottlenecks, God classes, PageRan

---

## `cgis_module_graph`

How one package is built inside: its modules and the dependencies between them.

Nodes are the package's direct children, each sub-package one node (``expand``
lists every module instead). Edges are imports ``-->``, inheritance ``==>``
and calls ``-.->``, each kind transitively reduced so the direct layering
shows; an edge that closes a cycle is never dropped. Dependencies on code
outside the package are summarised per module under the diagram, not drawn.
Test modules and type-only imports are left out. The json form is
``{prefix, nodes, subpackages, edges:[{source,target,kind}], dropped, outside}``.
Run ``cgis_ingest`` first.

| Argument | Type | Required | Description |
| :--- | :--- | :---: | :--- |
| `prefix` | `string` | ✓ | FQN prefix of the package as the graph names it, e.g. cgis.query (cgis_find_symbol shows it), matched on whole dot-segments. A directory above the ingest root, such as src., is dropped. |
| `db_path` | `string` | | SQLite graph built by cgis_ingest. A relative path resolves against the MCP server's working directory, not the agent's — prefer an absolute path. |
| `layers` | `array` | | Edge kinds to draw. Calls make the picture much denser. |
| `reduce` | `boolean` | | Drop each edge implied by a longer path, per kind; cycles stay. |
| `exclude_tests` | `boolean` | | Leave test modules out. |
| `expand` | `boolean` | | Every module below the package instead of one node per sub-package. |
| `output_format` | `string` | | mermaid: a diagram plus a table of outside dependencies; json: data. |

---

## `cgis_overview`

Where to start in a graph you know nothing about: sizes and a package map.
Expand Down