SwarmVault
Use when the agent has a SwarmVault MCP server enabled (transport stdio, command npx -y @swarmvaultai/cli mcp) pointed at a vault directory.
A SwarmVault workspace is a three-layer knowledge system:
raw/ — immutable source inputs (PDFs, transcripts, code, emails, URLs, sheets). Never edit.
wiki/ — generated markdown owned by the agent and the SwarmVault compiler. Pages carry frontmatter (page_id, source_ids, node_ids, freshness, source_hashes).
state/ — generated indexes, graphs, and approvals. Treat as opaque output of compile.
The vault contract lives in swarmvault.schema.md at the workspace root. The vault config lives in swarmvault.config.json.
Rules
- Read
swarmvault.schema.md first before any compile or query work. It defines categories, naming, freshness rules, and grounding conventions for this specific vault.
- Read
wiki/graph/report.md before broad file searching when it exists; otherwise start with wiki/index.md. Both summarize the vault structure so you don't re-scan everything.
- Treat
raw/ as immutable. Never edit, rename, or delete files there. New sources go through ingest.
- Treat
wiki/ as compiler-owned. Edits should preserve frontmatter fields exactly: page_id, source_ids, node_ids, freshness, source_hashes. If those drift, the next compile will overwrite or flag the page.
- Prefer graph queries over grep/glob for "how does X relate to Y" or "what depends on Z" questions. The vault's typed graph is more reliable than text search.
- Save high-value answers to
wiki/outputs/ (use the query or explore tools) instead of leaving them only in chat. That way they become first-class vault content for next time.
Tool Palette
The SwarmVault MCP server exposes the following tools (names are prefixed by SwarmClaw with mcp_<sanitized server name>_, e.g. mcp_SwarmVault_query_vault). Match the user's intent to the closest tool:
Vault inspection:
workspace_info — return current vault paths and high-level counts. Use this first when you've never seen this vault.
list_sources — list source manifests under raw/.
search_pages — full-text search across compiled wiki pages.
read_page — read a specific wiki page by its wiki/-relative path.
Graph (prefer over grep for relational questions):
graph_report — machine-readable graph report and trust artifact. Read this before broad searching.
query_graph — traverse the graph from search seeds without calling an LLM provider.
get_node — explain a graph node, its page, community, neighbors, and group patterns.
get_neighbors — neighbors of a node or page target.
get_hyperedges — list graph hyperedges, optionally filtered.
shortest_path — shortest path between two graph targets.
god_nodes — highest-connectivity nodes (the vault's hubs).
blast_radius — impact analysis: what depends on this file or module?
Question answering:
query_vault — natural-language question against the vault. Returns grounded citations. Pass save: true to persist the answer to wiki/outputs/.
Ingest and maintenance:
ingest_input — add a file path or URL to raw/ and register it as a managed source.
compile_vault — re-derive wiki/ pages, graph, and search index. Run after ingest, after schema changes, or when freshness is stale.
lint_vault — anti-drift and vault health checks.
If the MCP server is unavailable but the agent has a shell or execute tool, the same operations are available via swarmvault <subcommand> (or npx -y @swarmvaultai/cli <subcommand>) with the working directory set to the vault root.
Workflow
For a fresh question against the vault:
- Call
workspace_info if you haven't already, then read swarmvault.schema.md. If wiki/graph/report.md or wiki/index.md exists, skim it.
- Use
query_vault (or query_graph / get_node / shortest_path for relational questions). Cite returned source_ids and node_ids.
- If the answer reveals a gap, propose
ingest_input for the missing source, then compile_vault.
- Save the final answer with
query_vault save: true so it becomes vault content under wiki/outputs/.
For a new source the user mentions:
ingest_input the file/URL.
compile_vault to derive new wiki pages, graph, and search index.
lint_vault to check frontmatter and links.
- Skim the new pages in
wiki/sources/ and confirm provenance.
Boundaries
- Don't run
compile against an unreviewed change to swarmvault.schema.md — lint first.
- Don't promote candidate pages (
wiki/candidates/) to wiki/concepts/ or wiki/entities/ without the user's confirmation; the approval flow exists for a reason.
- Don't push the vault graph to Neo4j or export to Obsidian without an explicit ask.
1---2name: swarmvault3description: Use when working with a SwarmVault knowledge vault (raw/, wiki/, swarmvault.schema.md). Establishes schema-first conventions and prefers graph queries over broad search.4---56# SwarmVault78Use when the agent has a SwarmVault MCP server enabled (transport `stdio`, command `npx -y @swarmvaultai/cli mcp`) pointed at a vault directory.910A SwarmVault workspace is a three-layer knowledge system:1112- `raw/` — immutable source inputs (PDFs, transcripts, code, emails, URLs, sheets). Never edit.13- `wiki/` — generated markdown owned by the agent and the SwarmVault compiler. Pages carry frontmatter (`page_id`, `source_ids`, `node_ids`, `freshness`, `source_hashes`).14- `state/` — generated indexes, graphs, and approvals. Treat as opaque output of `compile`.1516The vault contract lives in `swarmvault.schema.md` at the workspace root. The vault config lives in `swarmvault.config.json`.1718## Rules19201. **Read `swarmvault.schema.md` first** before any compile or query work. It defines categories, naming, freshness rules, and grounding conventions for this specific vault.212. **Read `wiki/graph/report.md` before broad file searching** when it exists; otherwise start with `wiki/index.md`. Both summarize the vault structure so you don't re-scan everything.223. **Treat `raw/` as immutable.** Never edit, rename, or delete files there. New sources go through `ingest`.234. **Treat `wiki/` as compiler-owned.** Edits should preserve frontmatter fields exactly: `page_id`, `source_ids`, `node_ids`, `freshness`, `source_hashes`. If those drift, the next `compile` will overwrite or flag the page.245. **Prefer graph queries over grep/glob** for "how does X relate to Y" or "what depends on Z" questions. The vault's typed graph is more reliable than text search.256. **Save high-value answers** to `wiki/outputs/` (use the `query` or `explore` tools) instead of leaving them only in chat. That way they become first-class vault content for next time.2627## Tool Palette2829The SwarmVault MCP server exposes the following tools (names are prefixed by SwarmClaw with `mcp_<sanitized server name>_`, e.g. `mcp_SwarmVault_query_vault`). Match the user's intent to the closest tool:3031Vault inspection:32- `workspace_info` — return current vault paths and high-level counts. Use this first when you've never seen this vault.33- `list_sources` — list source manifests under `raw/`.34- `search_pages` — full-text search across compiled wiki pages.35- `read_page` — read a specific wiki page by its `wiki/`-relative path.3637Graph (prefer over grep for relational questions):38- `graph_report` — machine-readable graph report and trust artifact. Read this before broad searching.39- `query_graph` — traverse the graph from search seeds without calling an LLM provider.40- `get_node` — explain a graph node, its page, community, neighbors, and group patterns.41- `get_neighbors` — neighbors of a node or page target.42- `get_hyperedges` — list graph hyperedges, optionally filtered.43- `shortest_path` — shortest path between two graph targets.44- `god_nodes` — highest-connectivity nodes (the vault's hubs).45- `blast_radius` — impact analysis: what depends on this file or module?4647Question answering:48- `query_vault` — natural-language question against the vault. Returns grounded citations. Pass `save: true` to persist the answer to `wiki/outputs/`.4950Ingest and maintenance:51- `ingest_input` — add a file path or URL to `raw/` and register it as a managed source.52- `compile_vault` — re-derive `wiki/` pages, graph, and search index. Run after ingest, after schema changes, or when freshness is stale.53- `lint_vault` — anti-drift and vault health checks.5455If the MCP server is unavailable but the agent has a `shell` or `execute` tool, the same operations are available via `swarmvault <subcommand>` (or `npx -y @swarmvaultai/cli <subcommand>`) with the working directory set to the vault root.5657## Workflow5859For a fresh question against the vault:60611. Call `workspace_info` if you haven't already, then read `swarmvault.schema.md`. If `wiki/graph/report.md` or `wiki/index.md` exists, skim it.622. Use `query_vault` (or `query_graph` / `get_node` / `shortest_path` for relational questions). Cite returned `source_ids` and `node_ids`.633. If the answer reveals a gap, propose `ingest_input` for the missing source, then `compile_vault`.644. Save the final answer with `query_vault` `save: true` so it becomes vault content under `wiki/outputs/`.6566For a new source the user mentions:67681. `ingest_input` the file/URL.692. `compile_vault` to derive new wiki pages, graph, and search index.703. `lint_vault` to check frontmatter and links.714. Skim the new pages in `wiki/sources/` and confirm provenance.7273## Boundaries7475- Don't run `compile` against an unreviewed change to `swarmvault.schema.md` — `lint` first.76- Don't promote candidate pages (`wiki/candidates/`) to `wiki/concepts/` or `wiki/entities/` without the user's confirmation; the approval flow exists for a reason.77- Don't push the vault graph to Neo4j or export to Obsidian without an explicit ask.