bsv-mcp 0.0.24 → 0.0.26

package/README.md

@@ -38,6 +38,8 @@ This server implements the [Model Context Protocol](https://modelcontextprotocol
 
 ![MCP Configuration Example](docs/images/mcp-config-example.png)
 
+> **Note:** The PRIVATE_KEY_WIF environment variable is now optional. Without it, the server runs in limited mode with educational resources and non-wallet tools available. Wallet and MNEE token operations require a valid private key.
+
 ### Cursor
 
 To use the BSV MCP server with [Cursor](https://cursor.sh/):
@@ -282,6 +284,11 @@ A collection of prompts providing detailed information about the Bitcoin SV SDK:
 
 The server also provides access to Bitcoin Request for Comments (BRC) specifications and documentation:
 
+#### Changelog Resource
+- **Identifier**: `bsv-mcp-changelog`
+- **Description**: Version history and changelog for the BSV MCP server.
+- **Usage**: "Show me the BSV MCP changelog" or "What's new in the latest version?"
+
 #### BRC Resources
 - **BRCs Overview**
   - **Identifier**: `brcs_readme`
@@ -333,6 +340,49 @@ When you interact with an MCP-enabled AI assistant:
 4. The results are returned to the AI assistant
 5. The assistant presents the information in a natural, conversational way
 
+## Customization Options
+
+The BSV MCP server can be customized using environment variables to enable or disable specific components:
+
+### Component Configuration
+
+| Environment Variable | Default | Description |
+| -------------------- | ------- | ----------- |
+| `DISABLE_PROMPTS` | `false` | Set to `true` to disable all educational prompts |
+| `DISABLE_RESOURCES` | `false` | Set to `true` to disable all resources (BRCs, changelog) |
+| `DISABLE_TOOLS` | `false` | Set to `true` to disable all tools |
+
+### Tool-Specific Configuration
+
+| Environment Variable | Default | Description |
+| -------------------- | ------- | ----------- |
+| `DISABLE_WALLET_TOOLS` | `false` | Set to `true` to disable Bitcoin wallet tools |
+| `DISABLE_MNEE_TOOLS` | `false` | Set to `true` to disable MNEE token tools |
+| `DISABLE_BSV_TOOLS` | `false` | Set to `true` to disable BSV blockchain tools |
+| `DISABLE_ORDINALS_TOOLS` | `false` | Set to `true` to disable Ordinals/NFT tools |
+| `DISABLE_UTILS_TOOLS` | `false` | Set to `true` to disable utility tools |
+| `DISABLE_A2B_TOOLS` | `false` | Set to `true` to disable agent-to-blockchain tools |
+
+### Examples
+
+Run with only educational resources and prompts, no tools:
+
+```bash
+DISABLE_TOOLS=true bunx bsv-mcp@latest
+```
+
+Run with only BSV tools, no wallet or other functionality:
+
+```bash
+DISABLE_PROMPTS=true DISABLE_RESOURCES=true DISABLE_WALLET_TOOLS=true DISABLE_MNEE_TOOLS=true DISABLE_ORDINALS_TOOLS=true DISABLE_UTILS_TOOLS=true bunx bsv-mcp@latest
+```
+
+Use all tools except wallet operations:
+
+```bash
+DISABLE_WALLET_TOOLS=true bunx bsv-mcp@latest
+```
+
 ## Troubleshooting
 
 If you're having issues with the BSV MCP server:
@@ -392,7 +442,7 @@ The tool supports the following endpoint categories and specific endpoints:
 
 | Endpoint             | Description                                     | Required Parameters | Example Response                                                                      |
 | -------------------- | ----------------------------------------------- | ------------------- | ------------------------------------------------------------------------------------- |
-| `chain_info`         | Network statistics, difficulty, and chain work  | None                | `{"chain":"main","blocks":826458,"headers":826458,"bestblockhash":"000000000000..."}` |
+| `chain_info`         | Network statistics, difficulty, and chain work  | None                | `{"chain":"main","blocks":826458,"headers":826458,"bestblockhash":"0000000000..."}` |
 | `chain_tips`         | Current chain tips including heights and states | None                | `[{"height":826458,"hash":"000000000000...","branchlen":0,"status":"active"}]`        |
 | `circulating_supply` | Current BSV circulating supply                  | None                | `{"bsv":21000000}`                                                                    |
 | `peer_info`          | Connected peer statistics                       | None                | `[{"addr":"1.2.3.4:8333","services":"000000000000...","lastsend":1621234567}]`        |

package/index.ts

@@ -7,46 +7,70 @@ import { registerResources } from "./resources/resources";
 import { registerAllTools } from "./tools";
 import { registerWalletTools } from "./tools/wallet/tools";
 import { Wallet } from "./tools/wallet/wallet";
+import { registerMneeTools } from "./tools/mnee";
 
 /**
- * Validate the private key from environment variables
- * Exits the process with an error message if validation fails
+ * Configuration options from environment variables
  */
-function validatePrivateKey(): PrivateKey {
+const CONFIG = {
+	// Whether to load various components
+	loadPrompts: process.env.DISABLE_PROMPTS !== "true",
+	loadResources: process.env.DISABLE_RESOURCES !== "true",
+	loadTools: process.env.DISABLE_TOOLS !== "true",
+	
+	// Fine-grained tool category control
+	loadWalletTools: process.env.DISABLE_WALLET_TOOLS !== "true",
+	loadMneeTools: process.env.DISABLE_MNEE_TOOLS !== "true",
+	loadBsvTools: process.env.DISABLE_BSV_TOOLS !== "true",
+	loadOrdinalsTools: process.env.DISABLE_ORDINALS_TOOLS !== "true",
+	loadUtilsTools: process.env.DISABLE_UTILS_TOOLS !== "true",
+	loadA2bTools: process.env.DISABLE_A2B_TOOLS !== "true",
+};
+
+/**
+ * Try to initialize the private key from environment variables
+ * Returns the private key if valid, or undefined if not present or invalid
+ */
+function initializePrivateKey(): PrivateKey | undefined {
 	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.warn(
+			"\x1b[33mWarning: 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.warn(
+			"The server will run, but wallet operations requiring a private key will return errors.",
 		);
-		console.error(
+		console.warn(
+			"Set this variable with a valid Bitcoin SV private key in WIF format to enable all features:",
+		);
+		console.warn(
 			"Example: PRIVATE_KEY_WIF=your_private_key_wif bun run index.ts",
 		);
-		process.exit(1);
+		return undefined;
 	}
 
 	// 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.warn("\x1b[33mWarning: Invalid private key format\x1b[0m");
+		console.warn(
+			"The PRIVATE_KEY_WIF provided is not a valid Bitcoin SV private key in WIF format.",
+		);
+		console.warn(
+			"The server will run, but wallet operations requiring a private key will return errors.",
 		);
-		console.error("Please check your key and try again");
-		process.exit(1);
+		return undefined;
 	}
 }
 
-// Validate private key early before starting the server
-const privKey = validatePrivateKey();
+// Try to initialize private key but don't stop the server if missing or invalid
+const privKey = initializePrivateKey();
 
 const server = new McpServer(
-	{ name: "Bitcoin SV", version: "0.0.24" },
+	{ name: "Bitcoin SV", version: "0.0.26" },
 	// {
 	// 	// Advertise only what you actually implement
 	// 	capabilities: {
@@ -65,20 +89,46 @@ const server = new McpServer(
 	// },
 );
 
-// Initialize wallet with the validated private key
-const wallet = new Wallet(privKey);
+// Initialize wallet and register tools based on configuration
+let wallet: Wallet | null = null;
 
-// Register wallet tools separately (needs wallet instance)
-registerWalletTools(server, wallet);
+if (CONFIG.loadTools) {
+	if (privKey) {
+		// Register MNEE tools if enabled
+		if (CONFIG.loadMneeTools) {
+			console.log("Registering MNEE tools");
+			registerMneeTools(server);
+		}
 
-// Register all other tools (BSV, Ordinals, Utils, etc.)
-registerAllTools(server);
+		// Initialize wallet with the private key if wallet tools are enabled
+		if (CONFIG.loadWalletTools) {
+			console.log("Initializing wallet and registering wallet tools");
+			wallet = new Wallet(privKey);
+			registerWalletTools(server, wallet);
+		}
+	}
 
-// Register resources
-registerResources(server);
+	// Register all other tools based on configuration
+	console.log("Registering other tools");
+	registerAllTools(server, {
+		enableBsvTools: CONFIG.loadBsvTools,
+		enableOrdinalsTools: CONFIG.loadOrdinalsTools,
+		enableUtilsTools: CONFIG.loadUtilsTools,
+		enableA2bTools: CONFIG.loadA2bTools,
+	});
+}
 
-// Register prompts
-registerAllPrompts(server);
+// Register resources if enabled
+if (CONFIG.loadResources) {
+	console.log("Registering resources");
+	registerResources(server);
+}
+
+// Register prompts if enabled
+if (CONFIG.loadPrompts) {
+	console.log("Registering prompts");
+	registerAllPrompts(server);
+}
 
 // Connect to the transport
 const transport = new StdioServerTransport();

package/package.json

@@ -2,7 +2,7 @@
 	"name": "bsv-mcp",
 	"module": "index.ts",
 	"type": "module",
-	"version": "0.0.24",
+	"version": "0.0.26",
 	"license": "MIT",
 	"author": "satchmo",
 	"description": "A collection of Bitcoin SV (BSV) tools for the Model Context Protocol (MCP) framework",

package/tools/index.ts

@@ -2,32 +2,69 @@ import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { registerA2aCallTool } from "./a2b/call";
 import { registerA2bDiscoverTool } from "./a2b/discover";
 import { registerBsvTools } from "./bsv";
-import { registerMneeTools } from "./mnee";
 import { registerOrdinalsTools } from "./ordinals";
 import { registerUtilsTools } from "./utils";
 
 /**
- * Register all tools with the MCP server
+ * Configuration options for tools
+ * 
+ * These options can be controlled through environment variables:
+ * - enableBsvTools: controlled by DISABLE_BSV_TOOLS
+ * - enableOrdinalsTools: controlled by DISABLE_ORDINALS_TOOLS
+ * - enableUtilsTools: controlled by DISABLE_UTILS_TOOLS
+ * - enableA2bTools: controlled by DISABLE_A2B_TOOLS
+ */
+export interface ToolsConfig {
+	enableBsvTools?: boolean;
+	enableOrdinalsTools?: boolean;
+	enableUtilsTools?: boolean;
+	enableA2bTools?: boolean;
+}
+
+/**
+ * Register all tools with the MCP server based on configuration
  * @param server The MCP server instance
+ * @param config Configuration options
  */
-export function registerAllTools(server: McpServer): void {
+export function registerAllTools(
+	server: McpServer, 
+	config: ToolsConfig = {
+		enableBsvTools: true,
+		enableOrdinalsTools: true,
+		enableUtilsTools: true,
+		enableA2bTools: true
+	}
+): void {
+	const {
+		enableBsvTools = true,
+		enableOrdinalsTools = true,
+		enableUtilsTools = true,
+		enableA2bTools = true
+	} = config;
+
 	// Register BSV-related tools
-	registerBsvTools(server);
+	if (enableBsvTools) {
+		registerBsvTools(server);
+	}
 
 	// Register Ordinals-related tools
-	registerOrdinalsTools(server);
+	if (enableOrdinalsTools) {
+		registerOrdinalsTools(server);
+	}
 
 	// Register utility tools
-	registerUtilsTools(server);
-
-	// Register agent-to-blockchain discovery tool
-	registerA2bDiscoverTool(server);
+	if (enableUtilsTools) {
+		registerUtilsTools(server);
+	}
 
-	// Register agent-to-agent call tool
-	// registerA2aCallTool(server);
+	// Register agent-to-blockchain tools
+	if (enableA2bTools) {
+		// Register agent-to-blockchain discovery tool
+		registerA2bDiscoverTool(server);
 
-	// Register MNEE tools
-	registerMneeTools(server);
+		// Register agent-to-agent call tool
+		// registerA2aCallTool(server);
+	}
 
 	// Add more tool categories as needed
 }

package/tools/mnee/sendMnee.ts

@@ -61,7 +61,19 @@ export function registerSendMneeTool(server: McpServer, mnee: Mnee): void {
 				// Get WIF from environment
 				const wif = process.env.PRIVATE_KEY_WIF;
 				if (!wif) {
-					throw new Error("PRIVATE_KEY_WIF environment variable is not set");
+					return {
+						content: [
+							{
+								type: "text",
+								text: JSON.stringify({
+									success: false,
+									error: "No private key available",
+									message: "Please set PRIVATE_KEY_WIF environment variable with a valid Bitcoin SV private key in WIF format.",
+								}, null, 2),
+							},
+						],
+						isError: true,
+					};
 				}
 
 				const result: TransferResponse = await mnee.transfer(

package/tools/wallet/getAddress.ts

@@ -21,7 +21,22 @@ export function registerGetAddressTool(server: McpServer): void {
 		async () => {
 			try {
 				const wif = process.env.PRIVATE_KEY_WIF;
-				if (!wif) throw new Error("PRIVATE_KEY_WIF env var not set");
+				if (!wif) {
+					return {
+						content: [
+							{
+								type: "text",
+								text: JSON.stringify({ 
+									error: "No private key available", 
+									message: "Please set PRIVATE_KEY_WIF environment variable with a valid Bitcoin SV private key in WIF format.",
+									status: "error"
+								}),
+							},
+						],
+						isError: true,
+					};
+				}
+				
 				const privKey = PrivateKey.fromWif(wif);
 				const address = privKey.toAddress();
 				return {
@@ -35,7 +50,14 @@ export function registerGetAddressTool(server: McpServer): void {
 			} catch (err: unknown) {
 				const msg = err instanceof Error ? err.message : String(err);
 				return {
-					content: [{ type: "text", text: msg }],
+					content: [{ 
+						type: "text", 
+						text: JSON.stringify({ 
+							error: "Invalid private key", 
+							message: msg,
+							status: "error"
+						})
+					}],
 					isError: true,
 				};
 			}