Skip to content

Documentation MCP server

Raw

A local, read-only server that lets an agent query this documentation without scraping HTML.

Universe implementation Verified 2026-08-31 Metadata & Sources

Describes what a Bitcoin Universe service actually does today. It is not a statement about the protocol in general.

Page ID
reference/mcp
Normative authority
Universe implementation documentation
Networks
none
Documentation version
2026.08
Audience
developer, integrator
Owner
bitcoin-universe-docs
Known limitations
  • The server is read only by construction. It exposes no mutation, signing, broadcast, wallet, or operator capability, and it requires no credential.

The package in packages/mcp runs a local Model Context Protocol server over the built documentation artefacts. An agent can then query pages, contracts, and vectors directly instead of scraping rendered HTML.

Terminal window
npm install
npm run generate
npm --workspace packages/mcp run build

The --artifacts path points at a built site directory containing manifest.json and the raw/ tree. After installing those artefacts once, the server works offline.

Tool Returns
search_documentation Pages matching a query, with page IDs and scores
get_page One page by its stable page ID, as raw Markdown
get_protocol_status The applicability and authority of a capability, with its limitations
get_api_operation One OpenAPI operation by operation identifier
get_json_schema One schema definition from the shared library
get_source_provenance The source manifest entry for a source identifier
get_version_matrix Every pinned source revision and its networks
get_conformance_vector One executed vector by case identifier
list_glossary_entries Every glossary term and its definition
list_known_limitations Every declared limitation across the documentation
  • No mutation of any kind.
  • No signing or broadcasting.
  • No wallet interaction.
  • No credential, secret, or operator-only material.
  • No network calls to a Universe service.

Those are structural, not configuration. The server has no code paths for them.

Point your MCP client at the built server with the artefacts path. The exact configuration format depends on the client, and the server itself takes only the one argument.

The server answers from the committed artefacts. Given the same artefacts, the same query returns the same answer, which makes it usable in tests.

AI and agent access.