bsv-mcp 0.0.21 → 0.0.23

package/README.md

@@ -8,35 +8,12 @@
 
 A collection of Bitcoin SV (BSV) tools for the Model Context Protocol (MCP) framework. This library provides wallet, ordinals, and utility functions for BSV blockchain interaction.
 
-## Installation
-
-To install dependencies:
-
-```bash
-bun install
-```
-
-## External Dependencies
-
-For full functionality of all tools, the following additional dependencies are installed:
-
-```bash
-# For ordinal listing purchase functionality
-js-1sat-ord
-```
-
-## Running the Server
-
-Start the MCP server:
-
-```bash
-bun run index.ts
-```
-
 ## Connecting to MCP Clients
 
 This server implements the [Model Context Protocol](https://modelcontextprotocol.io/) (MCP), allowing AI assistants to utilize Bitcoin SV functionalities. You can connect this server to various MCP-compatible clients.
 
+![MCP Configuration Example](docs/images/mcp-config-example.png)
+
 ### Cursor
 
 To use the BSV MCP server with [Cursor](https://cursor.sh/):
@@ -86,19 +63,19 @@ To connect this server to Claude for Desktop:
 
 4. Add the BSV MCP server to your configuration (create the file if it doesn't exist):
    ```json
-  {
-    "mcpServers": {
-      "Bitcoin SV": {
-        "command": "bunx",
-        "args": [
-          "bsv-mcp@latest"
-        ],
-        "env": {
-          "PRIVATE_KEY_WIF": "<your_private_key_wif>"
+    {
+      "mcpServers": {
+        "Bitcoin SV": {
+          "command": "bunx",
+          "args": [
+            "bsv-mcp@latest"
+          ],
+          "env": {
+            "PRIVATE_KEY_WIF": "<your_private_key_wif>"
+          }
         }
       }
     }
-  }
    ```
 5. Replace `<your_private_key_wif>` with your actual private key WIF
 6. Save the file and restart Claude for Desktop
@@ -335,13 +312,13 @@ The tool supports both mainnet and testnet:
 - `main`: Bitcoin SV mainnet (default)
 - `test`: Bitcoin SV testnet
 
-## Development
-
-This project was created using `bun init` in bun v1.2.9. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
+# Development
 
-### Package Configuration
+## Running the Server
 
-The main entry point for this package is `index.ts`.
+```bash
+bun run index.ts
+```
 
 ### Running Tests
 

package/index.ts

@@ -11,33 +11,33 @@ import { Wallet } from "./tools/wallet/wallet";
  * Exits the process with an error message if validation fails
  */
 function validatePrivateKey(): PrivateKey {
-  const privateKeyWif = process.env.PRIVATE_KEY_WIF;
-
-  // Check if private key is set
-  if (!privateKeyWif) {
-    console.error(
-      "\x1b[31mError: PRIVATE_KEY_WIF environment variable is not set\x1b[0m"
-    );
-    console.error(
-      "Please set this variable with a valid Bitcoin SV private key in WIF format"
-    );
-    console.error(
-      "Example: PRIVATE_KEY_WIF=your_private_key_wif bun run index.ts"
-    );
-    process.exit(1);
-  }
-
-  // Validate the private key format
-  try {
-    return PrivateKey.fromWif(privateKeyWif);
-  } catch (error) {
-    console.error("\x1b[31mError: Invalid private key format\x1b[0m");
-    console.error(
-      "The PRIVATE_KEY_WIF provided is not a valid Bitcoin SV private key in WIF format"
-    );
-    console.error("Please check your key and try again");
-    process.exit(1);
-  }
+	const privateKeyWif = process.env.PRIVATE_KEY_WIF;
+
+	// Check if private key is set
+	if (!privateKeyWif) {
+		console.error(
+			"\x1b[31mError: PRIVATE_KEY_WIF environment variable is not set\x1b[0m",
+		);
+		console.error(
+			"Please set this variable with a valid Bitcoin SV private key in WIF format",
+		);
+		console.error(
+			"Example: PRIVATE_KEY_WIF=your_private_key_wif bun run index.ts",
+		);
+		process.exit(1);
+	}
+
+	// Validate the private key format
+	try {
+		return PrivateKey.fromWif(privateKeyWif);
+	} catch (error) {
+		console.error("\x1b[31mError: Invalid private key format\x1b[0m");
+		console.error(
+			"The PRIVATE_KEY_WIF provided is not a valid Bitcoin SV private key in WIF format",
+		);
+		console.error("Please check your key and try again");
+		process.exit(1);
+	}
 }
 
 // Validate private key early before starting the server
@@ -45,7 +45,7 @@ const privKey = validatePrivateKey();
 
 const server = new McpServer({
 	name: "Bitcoin SV MCP Server",
-	version: "0.0.21",
+	version: "0.0.23",
 });
 
 // Initialize wallet with the validated private key

package/package.json

@@ -2,7 +2,7 @@
 	"name": "bsv-mcp",
 	"module": "index.ts",
 	"type": "module",
-	"version": "0.0.21",
+	"version": "0.0.23",
 	"license": "MIT",
 	"author": "satchmo",
 	"description": "A collection of Bitcoin SV (BSV) tools for the Model Context Protocol (MCP) framework",
@@ -42,12 +42,12 @@
 	},
 	"dependencies": {
 		"@bsv/sdk": "^1.4.19",
-		"@modelcontextprotocol/sdk": "^1.9.0",
+		"@modelcontextprotocol/sdk": "^1.10.1",
 		"@types/node": "^22.14.1",
-		"js-1sat-ord": "^0.1.80",
+		"js-1sat-ord": "^0.1.81",
 		"mnee": "^2.0.0",
 		"satoshi-token": "^0.0.4",
-		"zod": "^3.24.2"
+		"zod": "^3.24.3"
 	},
 	"scripts": {
 		"lint": "biome check .",