bsv-mcp 0.0.26 → 0.0.28

package/CHANGELOG.md

@@ -0,0 +1,52 @@
+# BSV MCP Server Changelog
+
+## v0.0.28 - Enhanced Server Configuration & Maintenance
+
+### Major Changes
+- **Improved Changelog Management**: Added changelog as a MCP resource so you can just ask what has changed between versions
+  - Simplified maintenance with single source of truth for version history
+  - Automatic updates to MCP resources when changelog is modified
+- **Expanded Component Configuration**: Can now configure which components of the MCP are loaded by setting env vars. See the readme for more information.
+
+### Technical Improvements
+- Removed duplicate changelog content in code
+- Better error handling for resource loading
+- Code cleanup and organization improvements
+
+## v0.0.25 - Improved Error Handling & Optional Private Key
+
+### Major Changes
+- **Optional Private Key**: Server now starts without a PRIVATE_KEY_WIF environment variable
+  - Educational resources and non-wallet tools remain available in limited mode
+  - Wallet and MNEE tools gracefully fail with helpful error messages when no private key is provided
+- **Component Configuration**: Added environment variables to enable/disable specific components
+  - Selectively enable/disable prompts, resources, or tools
+  - Fine-grained control over which tool categories are loaded
+- **MNEE Token Support**: Added dedicated tools for MNEE token operations
+  - Get balance, send tokens, and parse transactions
+- **Enhanced Documentation**: Added detailed prompt examples and improved troubleshooting guidance
+- **Resource Improvements**: Added BRC specifications and other reference materials
+
+### Technical Improvements
+- Improved error handling throughout the codebase
+- Better initialization process for wallet component
+- Standardized error messages across tools
+- Expanded README with installation instructions for different platforms
+- Added npm alternatives to Bun commands
+- Added modular loading with configurable components
+
+## v0.0.24 - Initial Public Release
+
+### Features
+- Bitcoin SV wallet operations (send, receive, manage keys)
+- Ordinals creation and management
+- BSV blockchain interaction (transactions, blocks, addresses)
+- Cryptographic operations (signing, verification, encryption)
+- Educational prompts for BSV SDK and Ordinals
+
+### Toolkit Overview
+- Wallet tools for core BSV operations
+- Ordinals tools for NFT functionality
+- BSV tools for blockchain interaction
+- MNEE token tools
+- Utility tools for data conversion 

package/README.md

@@ -112,9 +112,9 @@ Open the Claude configuration json file in your favorite text editor. If you pre
    {
      "mcpServers": {
        "Bitcoin SV": {
-         "command": "bunx",
+         "command": "bun",
          "args": [
-           "bsv-mcp@latest"
+           "run", "bsv-mcp@latest"
          ],
          "env": {
            "PRIVATE_KEY_WIF": "<your_private_key_wif>"

package/index.ts

@@ -2,12 +2,12 @@
 import { PrivateKey } from "@bsv/sdk";
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
-import { registerAllPrompts } from "./prompts";
-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";
+import { registerAllPrompts } from "./prompts/index.ts";
+import { registerResources } from "./resources/resources.ts";
+import { registerAllTools } from "./tools/index.ts";
+import { registerMneeTools } from "./tools/mnee/index.ts";
+import { registerWalletTools } from "./tools/wallet/tools.ts";
+import { Wallet } from "./tools/wallet/wallet.ts";
 
 /**
  * Configuration options from environment variables
@@ -17,7 +17,7 @@ const CONFIG = {
 	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",
@@ -70,7 +70,7 @@ function initializePrivateKey(): PrivateKey | undefined {
 const privKey = initializePrivateKey();
 
 const server = new McpServer(
-	{ name: "Bitcoin SV", version: "0.0.26" },
+	{ name: "Bitcoin SV", version: "0.0.28" },
 	// {
 	// 	// Advertise only what you actually implement
 	// 	capabilities: {

package/package.json

@@ -2,7 +2,7 @@
 	"name": "bsv-mcp",
 	"module": "index.ts",
 	"type": "module",
-	"version": "0.0.26",
+	"version": "0.0.28",
 	"license": "MIT",
 	"author": "satchmo",
 	"description": "A collection of Bitcoin SV (BSV) tools for the Model Context Protocol (MCP) framework",
@@ -25,8 +25,13 @@
 		"*.ts",
 		"tools/*.ts",
 		"tools/**/*.ts",
+		"prompts/*.ts",
+		"prompts/**/*.ts",
+		"resources/*.ts",
+		"resources/**/*.ts",
 		"LICENSE",
 		"README.md",
+		"CHANGELOG.md",
 		"smithery.yaml"
 	],
 	"bin": {
@@ -51,7 +56,6 @@
 	},
 	"scripts": {
 		"lint": "biome check .",
-		"lint:fix": "biome check . --write",
-		"prepare": "chmod +x ./index.ts"
+		"lint:fix": "biome check . --write"
 	}
 }

package/prompts/bsvSdk/auth.ts

@@ -0,0 +1,61 @@
+import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
+import type {
+	ServerNotification,
+	ServerRequest,
+} from "@modelcontextprotocol/sdk/types.js";
+
+/**
+ * BSV SDK Authentication Prompt
+ *
+ * Provides detailed information about the authentication functionality in the BSV SDK,
+ * including identity protocols, certificates, and session management.
+ */
+export const BSV_SDK_AUTH_PROMPT = `
+# BSV SDK - Authentication Module
+
+The Authentication module in the BSV SDK provides robust mechanisms for identity management, peer authentication, and certificate handling on the Bitcoin SV blockchain.
+
+## Key Components
+
+This section includes a placeholder for detailed content about the BSV SDK authentication mechanisms.
+
+## Core Features
+
+- Identity management
+- Certificate handling
+- Peer authentication
+- Session management
+
+## Best Practices
+
+1. **Security**: Follow best practices for authentication security
+2. **Testing**: Test authentication flows thoroughly before production use
+3. **Error Handling**: Implement proper error handling
+
+For complete API documentation and additional authentication features, refer to the official BSV SDK documentation.
+`;
+
+/**
+ * Register the BSV SDK Authentication prompt with the MCP server
+ * @param server The MCP server instance
+ */
+export function registerAuthPrompt(server: McpServer): void {
+	server.prompt(
+		"bitcoin_sv_sdk_auth",
+		"Detailed information about the authentication functionality in the BSV SDK, including identity protocols, certificates, and session management.",
+		async (extra: RequestHandlerExtra<ServerRequest, ServerNotification>) => {
+			return {
+				messages: [
+					{
+						role: "assistant",
+						content: {
+							type: "text",
+							text: BSV_SDK_AUTH_PROMPT,
+						},
+					},
+				],
+			};
+		},
+	);
+}

package/prompts/bsvSdk/cryptography.ts

@@ -0,0 +1,62 @@
+import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
+import type {
+	ServerNotification,
+	ServerRequest,
+} from "@modelcontextprotocol/sdk/types.js";
+
+/**
+ * BSV SDK Cryptography Prompt
+ *
+ * Provides detailed information about the cryptographic functionality in the BSV SDK,
+ * including key generation, signing, encryption, and hashing.
+ */
+export const BSV_SDK_CRYPTOGRAPHY_PROMPT = `
+# BSV SDK - Cryptography Module
+
+The Cryptography module in the BSV SDK provides comprehensive tools for handling cryptographic operations required for secure Bitcoin transactions and applications.
+
+## Key Cryptographic Operations
+
+This section includes a placeholder for detailed content about the BSV SDK cryptographic operations.
+
+## Core Features
+
+- Key generation and management
+- Digital signatures (ECDSA)
+- Message signing and verification
+- Encryption and decryption
+- Hash functions (SHA-256, RIPEMD-160, etc.)
+
+## Best Practices
+
+1. **Key Security**: Always handle private keys securely
+2. **Random Number Generation**: Use cryptographically secure random number generation
+3. **Testing**: Verify cryptographic operations with known test vectors
+
+For complete API documentation and additional cryptographic features, refer to the official BSV SDK documentation.
+`;
+
+/**
+ * Register the BSV SDK Cryptography prompt with the MCP server
+ * @param server The MCP server instance
+ */
+export function registerCryptographyPrompt(server: McpServer): void {
+	server.prompt(
+		"bitcoin_sv_sdk_cryptography",
+		"Detailed information about the cryptographic functionality in the BSV SDK, including key generation, signing, encryption, and hashing.",
+		async (extra: RequestHandlerExtra<ServerRequest, ServerNotification>) => {
+			return {
+				messages: [
+					{
+						role: "assistant",
+						content: {
+							type: "text",
+							text: BSV_SDK_CRYPTOGRAPHY_PROMPT,
+						},
+					},
+				],
+			};
+		},
+	);
+}

package/prompts/bsvSdk/index.ts

@@ -0,0 +1,34 @@
+import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+
+import { registerAuthPrompt } from "./auth";
+import { registerCryptographyPrompt } from "./cryptography";
+// Import all prompt registration functions
+import { registerOverviewPrompt } from "./overview";
+import { registerPrimitivesPrompt } from "./primitives";
+import { registerScriptPrompt } from "./script";
+import { registerTransactionPrompt } from "./transaction";
+import { registerWalletPrompt } from "./wallet";
+
+/**
+ * Register all BSV SDK prompts with the MCP server
+ * @param server The MCP server instance
+ */
+export function registerAllBsvSdkPrompts(server: McpServer): void {
+	// Register all BSV SDK related prompts
+	registerOverviewPrompt(server);
+	registerWalletPrompt(server);
+	registerTransactionPrompt(server);
+	registerAuthPrompt(server);
+	registerCryptographyPrompt(server);
+	registerScriptPrompt(server);
+	registerPrimitivesPrompt(server);
+}
+
+// Export all prompts
+export { registerOverviewPrompt } from "./overview";
+export { registerWalletPrompt } from "./wallet";
+export { registerTransactionPrompt } from "./transaction";
+export { registerAuthPrompt } from "./auth";
+export { registerCryptographyPrompt } from "./cryptography";
+export { registerScriptPrompt } from "./script";
+export { registerPrimitivesPrompt } from "./primitives";

package/prompts/bsvSdk/overview.ts

@@ -0,0 +1,105 @@
+import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
+import type {
+	ServerNotification,
+	ServerRequest,
+} from "@modelcontextprotocol/sdk/types.js";
+
+/**
+ * BSV SDK Overview Prompt
+ *
+ * Provides a general overview of the Bitcoin SV SDK,
+ * including what it is, its purpose, and its main components.
+ */
+export const BSV_SDK_OVERVIEW_PROMPT = `
+# BSV SDK - Overview
+
+The BSV SDK is a comprehensive TypeScript/JavaScript library designed to provide a unified and modern 
+layer for developing scalable applications on the Bitcoin SV blockchain. This SDK addresses limitations 
+of previous tools by offering a fresh approach that adheres to the principles of SPV (Simplified Payment 
+Verification) while ensuring privacy and scalability.
+
+## Core Objectives
+
+- Provide a unified, modern API for Bitcoin SV development
+- Enable secure, peer-to-peer operations
+- Support SPV (Simplified Payment Verification) principles
+- Ensure privacy and scalability in blockchain applications
+- Simplify integration with the Bitcoin SV ecosystem
+
+## Main Components
+
+The BSV SDK is organized into several key modules:
+
+1. **Wallet**: Manage keys, addresses, and UTXOs
+2. **Transaction**: Build and manipulate Bitcoin transactions
+3. **Auth**: Authentication and identity protocols
+4. **Cryptography**: Signing, encryption, and verification
+5. **Script**: Bitcoin scripting and contract capabilities
+6. **Primitives**: Core data types and structures
+7. **Messages**: Network message handling
+8. **Overlay Tools**: Additional utilities and extensions
+
+## Getting Started
+
+To use the BSV SDK in your project:
+
+\`\`\`bash
+# Install with npm
+npm install @bsv/sdk
+
+# Or with yarn
+yarn add @bsv/sdk
+\`\`\`
+
+Then import the components you need:
+
+\`\`\`typescript
+import { PrivateKey, Transaction } from "@bsv/sdk";
+\`\`\`
+
+## Use Cases
+
+- Wallet applications
+- Payment systems
+- Smart contract platforms
+- Token systems
+- Identity solutions
+- Data storage and verification
+
+## Additional Resources
+
+For detailed information about specific components, please see the dedicated prompts for each module:
+- Wallet operations: Use prompt "bitcoin_sv_sdk_wallet"
+- Transaction building: Use prompt "bitcoin_sv_sdk_transaction"
+- Authentication: Use prompt "bitcoin_sv_sdk_auth"
+- Cryptography: Use prompt "bitcoin_sv_sdk_cryptography"
+- Scripting: Use prompt "bitcoin_sv_sdk_script"
+- Primitives: Use prompt "bitcoin_sv_sdk_primitives"
+
+For official documentation, visit the BSV Blockchain Libraries Project repository.
+`;
+
+/**
+ * Register the BSV SDK Overview prompt with the MCP server
+ * @param server The MCP server instance
+ */
+export function registerOverviewPrompt(server: McpServer): void {
+	server.prompt(
+		"bitcoin_sv_sdk_overview",
+		"General overview of the Bitcoin SV SDK, including its purpose and main components.",
+		async (extra: RequestHandlerExtra<ServerRequest, ServerNotification>) => {
+			return {
+				messages: [
+					{
+						role: "assistant",
+						content: {
+							type: "text",
+							text: BSV_SDK_OVERVIEW_PROMPT,
+						},
+					},
+				],
+			};
+		},
+	);
+}

package/prompts/bsvSdk/primitives.ts

@@ -0,0 +1,69 @@
+import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
+import type {
+	ServerNotification,
+	ServerRequest,
+} from "@modelcontextprotocol/sdk/types.js";
+
+/**
+ * BSV SDK Primitives Prompt
+ *
+ * Provides detailed information about the primitive data types and structures in the BSV SDK,
+ * including Binary, Hex, Points, and other fundamental types.
+ */
+export const BSV_SDK_PRIMITIVES_PROMPT = `
+# BSV SDK - Primitives Module
+
+The Primitives module in the BSV SDK provides fundamental data types and structures that form the building blocks for working with Bitcoin transactions and blockchain data.
+
+## Core Primitive Types
+
+This section includes a placeholder for detailed content about the primitive types available in the BSV SDK.
+
+## Key Primitives
+
+- Binary data handling
+- Hex string conversion
+- Point and curve operations
+- Bitcoin-specific data structures
+- Network message formats
+
+## Common Operations
+
+- Serialization and deserialization
+- Type conversion
+- Data validation
+- Encoding and decoding
+
+## Best Practices
+
+1. **Type Safety**: Use appropriate types for Bitcoin operations
+2. **Validation**: Validate input data before processing
+3. **Performance**: Consider performance implications when working with large data structures
+
+For complete API documentation and additional information about primitives, refer to the official BSV SDK documentation.
+`;
+
+/**
+ * Register the BSV SDK Primitives prompt with the MCP server
+ * @param server The MCP server instance
+ */
+export function registerPrimitivesPrompt(server: McpServer): void {
+	server.prompt(
+		"bitcoin_sv_sdk_primitives",
+		"Detailed information about the primitive data types and structures in the BSV SDK, including Binary, Hex, Points, and other fundamental types.",
+		async (extra: RequestHandlerExtra<ServerRequest, ServerNotification>) => {
+			return {
+				messages: [
+					{
+						role: "assistant",
+						content: {
+							type: "text",
+							text: BSV_SDK_PRIMITIVES_PROMPT,
+						},
+					},
+				],
+			};
+		},
+	);
+}

package/prompts/bsvSdk/script.ts

@@ -0,0 +1,70 @@
+import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
+import type {
+	ServerNotification,
+	ServerRequest,
+} from "@modelcontextprotocol/sdk/types.js";
+
+/**
+ * BSV SDK Script Prompt
+ *
+ * Provides detailed information about the script functionality in the BSV SDK,
+ * including Bitcoin Script operations, locking and unlocking scripts, and OP_CODES.
+ */
+export const BSV_SDK_SCRIPT_PROMPT = `
+# BSV SDK - Script Module
+
+The Script module in the BSV SDK provides comprehensive tools for working with Bitcoin Script, the programming language used to specify conditions for spending Bitcoin.
+
+## Bitcoin Script Basics
+
+This section includes a placeholder for detailed content about Bitcoin Script and its implementation in the BSV SDK.
+
+## Core Features
+
+- Creating and manipulating scripts
+- Locking script (scriptPubKey) creation
+- Unlocking script (scriptSig) creation
+- Script verification and execution
+- Support for all Bitcoin OP_CODES
+
+## Common Script Types
+
+- P2PKH (Pay to Public Key Hash)
+- P2PK (Pay to Public Key)
+- P2MS (Multi-signature)
+- OP_RETURN (Data storage)
+- Custom scripts
+
+## Best Practices
+
+1. **Testing**: Test scripts thoroughly before production use
+2. **Security**: Be aware of potential script vulnerabilities
+3. **Compatibility**: Ensure scripts are compatible with network rules
+
+For complete API documentation and additional script features, refer to the official BSV SDK documentation.
+`;
+
+/**
+ * Register the BSV SDK Script prompt with the MCP server
+ * @param server The MCP server instance
+ */
+export function registerScriptPrompt(server: McpServer): void {
+	server.prompt(
+		"bitcoin_sv_sdk_script",
+		"Detailed information about the script functionality in the BSV SDK, including Bitcoin Script operations, locking and unlocking scripts, and OP_CODES.",
+		async (extra: RequestHandlerExtra<ServerRequest, ServerNotification>) => {
+			return {
+				messages: [
+					{
+						role: "assistant",
+						content: {
+							type: "text",
+							text: BSV_SDK_SCRIPT_PROMPT,
+						},
+					},
+				],
+			};
+		},
+	);
+}