mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-08-13 18:44:52 -07:00
global: docs
This commit is contained in:
@@ -7,6 +7,8 @@ blk*.dat ──▶ Reader ──┐
|
||||
├──▶ Indexer ──▶ Computer ──┐
|
||||
RPC Client ──┤ ├──▶ Query ──▶ Server
|
||||
└──▶ Mempool ───────────────┘
|
||||
|
||||
MCP clients ──▶ MCP Adapter ──▶ Server
|
||||
```
|
||||
|
||||
## Components
|
||||
@@ -61,6 +63,14 @@ REST API exposing Query functionality:
|
||||
- ETag caching
|
||||
- mempool.space compatible endpoints
|
||||
|
||||
### MCP Adapter (`brk_mcp`)
|
||||
|
||||
Provides stateless, read-only MCP tools generated from the server's OpenAPI
|
||||
operations. It forwards tool calls to the configured REST origin, allowing a
|
||||
Cloudflare-fronted API to keep serving cached responses. The official endpoint
|
||||
is [mcp.bitview.space](https://mcp.bitview.space/) and requires no
|
||||
authentication.
|
||||
|
||||
## Data Flow
|
||||
|
||||
**Initial sync:**
|
||||
|
||||
@@ -13,6 +13,8 @@
|
||||
Open-source Bitcoin data toolkit that can parse blocks, index the chain, compute metrics, serve data and render it, all from a Bitcoin Core node. It combines what [Glassnode](https://glassnode.com) and [mempool.space](https://mempool.space) do separately into a single self-hostable package, with a built-in price oracle inspired by [UTXO Oracle](https://utxo.live/oracle/).
|
||||
|
||||
[Bitview](https://bitview.space) is the official free hosted instance of BRK.
|
||||
Stateless, read-only MCP access is available at
|
||||
[mcp.bitview.space](https://mcp.bitview.space/), with no authentication required.
|
||||
|
||||
## Data
|
||||
|
||||
@@ -42,6 +44,17 @@ Query metrics and blockchain data in JSON or CSV. No rate limit.
|
||||
|
||||
[Documentation](https://bitview.space/api) · [JavaScript](https://www.npmjs.com/package/brk-client) · [Python](https://pypi.org/project/brk-client) · [Rust](https://crates.io/crates/brk_client) · [llms.txt](https://bitview.space/llms.txt) · [LLM-friendly schema](https://bitview.space/api.json)
|
||||
|
||||
### MCP
|
||||
|
||||
Connect any Streamable HTTP MCP client to:
|
||||
|
||||
```text
|
||||
https://mcp.bitview.space/
|
||||
```
|
||||
|
||||
The server is stateless, read-only, and requires no authentication. Its tools
|
||||
are generated from the same OpenAPI operations as the typed clients.
|
||||
|
||||
### Self-host
|
||||
|
||||
```bash
|
||||
|
||||
Reference in New Issue
Block a user