From 005774a4c21701b7af920e67a80a28f0df94946b Mon Sep 17 00:00:00 2001 From: nym21 Date: Tue, 24 Jun 2025 08:41:08 +0000 Subject: [PATCH] mcp: update readme --- crates/brk_mcp/README.md | 44 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/crates/brk_mcp/README.md b/crates/brk_mcp/README.md index 679749860..a4bef4581 100644 --- a/crates/brk_mcp/README.md +++ b/crates/brk_mcp/README.md @@ -1,3 +1,47 @@ # BRK MCP A Model Context Protocol (MCP) which gives LLMs access to all available tools in BRK + +## Usage + +To connect to the MCP you only need the correct URL ([https://bitcoinresearchkit.org/mcp](https://bitcoinresearchkit.org/mcp)) no token or auth is needed. + +This implementation has only been tested with Claude and the [MCP inspector](https://modelcontextprotocol.io/docs/tools/inspector). + +Please be aware thtat the technology is very rapidly evolving, thus having issues if probably expected. + +### Claude + +#### Step 1 + +First we need to connect BRK to Claude. + +![Caude MCP setup step 1](https://github.com/bitcoinresearchkit/brk/blob/main/assets/claude-step1.png) + +#### Step 2 + +Which is done by adding an integration. + +![Caude MCP setup step 2](https://github.com/bitcoinresearchkit/brk/blob/main/assets/claude-step2.png) + +#### Step 3 + +Since BRK's open and free, only a URL is needed. + +![Caude MCP setup step 3](https://github.com/bitcoinresearchkit/brk/blob/main/assets/claude-step3.png) + +#### Step 4 + +Verify that it has access to BRK's tools. + +Optionally and highly recommended, giving it unsupervised access gives a more fluid experience and prevents possible issues and errors. + +![Caude MCP setup step 4](https://github.com/bitcoinresearchkit/brk/blob/main/assets/claude-step4.png) + +#### Results + +Some examples of dashboard and documents generated by Claude using BRK's tools: + +- [Document](https://claude.ai/public/artifacts/71194d29-f965-417c-ba09-fdf0e4ecb1d5) +- [Dashboard](https://claude.ai/public/artifacts/beef143f-399a-4ed4-b8bf-c986b776de42) +- [Dashboard2](https://claude.ai/public/artifacts/5430ae49-bb3d-4fc1-ab24-f1e33deb40dc)