MCP
Agents & MCP

Tools

The six MCP tools superlore exposes — search, get_page, get_section, list, navigate, get_component_data — with their arguments and what each returns.

The superlore MCP server (/api/mcp on this deploy) exposes six tools over the structured index. Each returns JSON — the typed knowledge behind the pages, never scraped HTML.

ToolArgumentsReturns
searchquery, limit?Ranked page hits across the corpus
get_pagepathFrontmatter + ordered knowledge nodes for one page
get_sectionidA single knowledge node by ${path}#${id}
listkind?, tag?, entityType?Filtered knowledge nodes across the corpus
navigatetargetOutgoing refs + backlinks for a path / node id / ref
get_component_dataidA single component's knowledge face by id

Each tool

search(query, limit?)

Full-text search across the documentation. Returns ranked page hits — summary weighs heavily in ranking, which is why every page should carry one.

get_page(path)

Fetch a page's full structured content by path (e.g. /docs/architecture): its frontmatter plus the ordered list of knowledge nodes — prose sections and the serialized knowledge faces of every component on the page. Returns { error: "not_found", path } for an unknown path.

get_section(id)

Fetch a single knowledge node by its ${path}#${id} address — one prose section or one component's face, without the rest of the page. Returns { error: "not_found", id } for an unknown id.

list({ kind?, tag?, entityType? })

List knowledge nodes across the whole corpus, filtered by node kind, by frontmatter tag, or by entityType. Use it to enumerate, say, every timeline or every page tagged roadmap.

navigate(target)

Follow relations from a page path, a node id, or an entity ref. Returns the outgoing refs (depends-on, part-of, related, …) and the backlinks — the corpus as a graph.

get_component_data(id)

Get the typed data behind a single rendered component (its knowledge face) by id — e.g. the node/edge graph behind a Canvas, or the items behind a Timeline. Returns { error: "not_found", id } for an unknown id.

The same index the site renders

Every tool reads the structured index superlore builds from your MDX. There is no separate agent content to maintain — the tools and the pages are two projections of one source.

To wire a client up to these tools, see Connect a client.

On this page

Built withsuperlore