Mirror/brk
1
0
Fork 0
mirror of https://github.com/bitcoinresearchkit/brk.git synced 2026-05-27 10:04:48 -07:00
Code Issues Packages Projects Releases Wiki Activity

server: fix README

Browse Source
This commit is contained in:
nym21
2025-12-21 23:28:03 +01:00
parent 5a5d4da57d
commit 40ec356cc3
2 changed files with 2 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
crates/brk_mcp/README.md
View File

@@ -37,7 +37,7 @@ let mcp = MCP::new(&async_query);
## Integration ## Integration
The MCP server is integrated into `brk_server` and exposed at `/mcp/sse` endpoint for SSE-based MCP transport. The MCP server is integrated into `brk_server` and exposed at `/mcp` endpoint for MCP transport.
## Built On ## Built On

3
crates/brk_server/README.md
View File

@@ -11,7 +11,6 @@ Serve BRK data via REST API with OpenAPI documentation, response caching, MCP en
- **OpenAPI spec**: Auto-generated documentation at `/api/openapi.json` - **OpenAPI spec**: Auto-generated documentation at `/api/openapi.json`
- **Response caching**: LRU cache with 5000 entries for repeated queries - **Response caching**: LRU cache with 5000 entries for repeated queries
- **Compression**: Brotli, gzip, deflate, zstd support - **Compression**: Brotli, gzip, deflate, zstd support
- **MCP endpoint**: Server-Sent Events transport at `/mcp/sse`
- **Static files**: Optional web interface hosting - **Static files**: Optional web interface hosting
- **Request logging**: Colorized status/latency logging - **Request logging**: Colorized status/latency logging
@@ -32,7 +31,7 @@ server.serve(true).await?; // true enables MCP endpoint
| `/api/metrics` | Metric catalog and data queries | | `/api/metrics` | Metric catalog and data queries |
| `/api/mining/*` | Hashrate, difficulty, pools, epochs | | `/api/mining/*` | Hashrate, difficulty, pools, epochs |
| `/api/mempool/*` | Fee estimates, projected blocks | | `/api/mempool/*` | Fee estimates, projected blocks |
| `/mcp/sse` | MCP Server-Sent Events endpoint | | `/mcp` | MCP endpoint (if enabled) |
## Caching ## Caching