axiom_graph_read_doc

axiom_graph.mcp.server.axiom_graph_read_doc(project_root, doc_id='', section=None, doc_ids=None)

Read a DocJSON document as Markdown.

Each section heading is annotated with its full section ID in an HTML comment (e.g. <!-- id: myproject::docs.architecture::overview -->), so you can pass that ID directly to axiom_graph_update_section or axiom_graph_add_link without a separate lookup step.

Parameters:

project_root str

Absolute path to the indexed project.

doc_id str

Full doc node ID, e.g. myproject::docs.architecture. Pass "list" to see all available doc IDs.

section str | None

Optional short slug to read a single section, e.g. "problem" or "architecture". The slug is matched against the tail of each section ID (the part after the last ::). If multiple sections match, all are returned with a disambiguation header listing the full section IDs so you can re-call with the exact slug or switch to the full section ID in axiom_graph_update_section. Omit to read the full document.

doc_ids list[str] | None

Optional list of doc IDs for batch operation. When provided, doc_id is ignored and results are returned for all listed IDs with per-ID delimiters.

Return type:

str