bsv-mcp 0.0.6 → 0.0.8

package/Dockerfile

@@ -0,0 +1,20 @@
+# Use the official Bun image
+FROM oven/bun:1
+
+# Set working directory
+WORKDIR /app
+
+# Copy all application code first
+COPY . .
+
+# Install dependencies
+RUN bun install --frozen-lockfile
+
+# Set user for security
+USER bun
+
+# Expose port (if needed)
+EXPOSE 3000
+
+# Run the application
+CMD ["bun", "run", "index.ts"] 

package/README.md

@@ -1,5 +1,7 @@
 # Bitcoin SV MCP Server
 
+[![smithery badge](https://smithery.ai/badge/@b-open-io/bsv-mcp)](https://smithery.ai/server/@b-open-io/bsv-mcp)
+
 > **⚠️ NOTICE: Experimental Work in Progress**  
 > This project is in an early experimental stage. Features may change, and the API is not yet stable.
 > Contributions, feedback, and bug reports are welcome! Feel free to open issues or submit pull requests.
@@ -14,16 +16,6 @@ To install dependencies:
 bun install
 ```
 
-For global installation (recommended for MCP client integration):
-
-```bash
-# Install globally with bun
-bun install -g bsv-mcp
-
-# Or with npm
-npm install -g bsv-mcp
-```
-
 ## External Dependencies
 
 For full functionality of all tools, the following additional dependencies are installed:
@@ -38,11 +30,7 @@ js-1sat-ord
 Start the MCP server:
 
 ```bash
-# If installed locally
 bun run index.ts
-
-# If installed globally
-bunx bsv-mcp
 ```
 
 ## Connecting to MCP Clients
@@ -54,7 +42,7 @@ This server implements the [Model Context Protocol](https://modelcontextprotocol
 To use the BSV MCP server with [Cursor](https://cursor.sh/):
 
 1. Install Cursor if you haven't already
-2. Install this package globally: `bun install -g bsv-mcp`
+2. Clone this repository and run `bun install` in the project directory
 3. Open Cursor and navigate to Settings → Extensions → Model Context Protocol
 4. Click "Add a new global MCP server"
 5. Enter the following configuration in JSON format:
@@ -65,15 +53,17 @@ To use the BSV MCP server with [Cursor](https://cursor.sh/):
     "command": "env",
     "args": [
       "PRIVATE_KEY_WIF=<your_private_key_wif>",
-      "bunx",
-      "bsv-mcp"
+      "bun",
+      "run",
+      "<path_to_project>/index.ts"
     ]
   }
 }
 ```
 
 6. Replace `<your_private_key_wif>` with your actual private key WIF (keep this secure!)
-7. Click "Save"
+7. Replace `<path_to_project>` with the full path to where you cloned this repository
+8. Click "Save"
 
 The BSV tools will now be available to Cursor's AI assistant under the "Bitcoin SV" namespace.
 
@@ -82,7 +72,7 @@ The BSV tools will now be available to Cursor's AI assistant under the "Bitcoin
 To connect this server to Claude for Desktop:
 
 1. Ensure you have [Claude for Desktop](https://claude.ai/desktop) installed and updated to the latest version
-2. Install this package globally: `bun install -g bsv-mcp`
+2. Clone this repository and run `bun install` in the project directory
 3. Open your Claude for Desktop configuration file:
    ```bash
    # macOS/Linux
@@ -99,16 +89,18 @@ To connect this server to Claude for Desktop:
          "command": "env",
          "args": [
            "PRIVATE_KEY_WIF=<your_private_key_wif>",
-           "bunx",
-           "bsv-mcp"
+           "bun",
+           "run",
+           "<path_to_project>/index.ts"
          ]
        }
      }
    }
    ```
 5. Replace `<your_private_key_wif>` with your actual private key WIF
-6. Save the file and restart Claude for Desktop
-7. The BSV tools will appear when you click the tools icon (hammer) in Claude for Desktop
+6. Replace `<path_to_project>` with the full path to where you cloned this repository
+7. Save the file and restart Claude for Desktop
+8. The BSV tools will appear when you click the tools icon (hammer) in Claude for Desktop
 
 ### Generic MCP Client Integration
 
@@ -120,8 +112,9 @@ For other MCP clients that support JSON configuration:
     "command": "env",
     "args": [
       "PRIVATE_KEY_WIF=<your_private_key_wif>",
-      "bunx",
-      "bsv-mcp"
+      "bun",
+      "run",
+      "<path_to_project>/index.ts"
     ]
   }
 }
@@ -134,7 +127,7 @@ If running the server directly:
 export PRIVATE_KEY_WIF=<your_private_key_wif>
 
 # Then run the server
-bunx bsv-mcp
+bun run index.ts
 ```
 
 ## Available Tools
@@ -150,8 +143,7 @@ Wallet tools provide core BSV wallet functionality:
 | `wallet_getPublicKey` | Retrieves a public key for a specified protocol and key ID |
 | `wallet_createSignature` | Creates a cryptographic signature for the provided data |
 | `wallet_verifySignature` | Verifies a cryptographic signature against the provided data |
-| `wallet_encrypt` | Encrypts data using a specified protocol and key |
-| `wallet_decrypt` | Decrypts data using a specified protocol and key |
+| `wallet_encryption` | Combined tool for encrypting and decrypting data using the wallet's cryptographic keys (replaces separate encrypt/decrypt tools) |
 | `wallet_getAddress` | Returns a BSV address for the current wallet or a derived path |
 | `wallet_sendToAddress` | Sends BSV to a specified address (supports BSV or USD amounts) |
 | `wallet_purchaseListing` | Purchases NFTs or BSV-20/BSV-21 tokens from marketplace listings |
@@ -194,6 +186,8 @@ Once connected, you can use natural language to interact with Bitcoin SV through
 - "Get my Bitcoin SV address"
 - "Send 0.01 BSV to 1ExampleBsvAddressXXXXXXXXXXXXXXXXX"
 - "Send $5 USD worth of BSV to 1ExampleBsvAddressXXXXXXXXXXXXXXXXX"
+- "Encrypt this message using my wallet's keys"
+- "Decrypt this data that was previously encrypted for me"
 - "Purchase this NFT listing: txid_vout"
 - "Purchase this BSV-20 token listing: txid_vout"
 
@@ -225,7 +219,7 @@ When you interact with an MCP-enabled AI assistant:
 
 If you're having issues connecting to the server:
 
-1. Ensure the package is properly installed: `bun install -g bsv-mcp`
+1. Ensure the package dependencies are properly installed: `bun install`
 2. Verify your WIF private key is correctly set in the environment
 3. Check that your client supports MCP and is properly configured
 4. Look for error messages in the client's console output
@@ -239,6 +233,9 @@ For Cursor, check the Cursor MCP logs in Settings → Extensions → Model Conte
 
 ## Recent Updates
 
+### Unified Encryption Tool
+- **Combined Wallet Encryption**: The `wallet_encrypt` and `wallet_decrypt` tools have been merged into a single `wallet_encryption` tool with a mode parameter to switch between encryption and decryption operations.
+
 ### Enhanced Marketplace Tools
 - **Unified Market Listings**: The `ordinals_marketListings` tool now supports NFTs, BSV-20, and BSV-21 tokens through a single interface with appropriate filtering.
 - **Improved Market Sales**: The `ordinals_marketSales` tool (renamed from `ordinals_bsv20MarketSales`) now supports both BSV-20 and BSV-21 token sales.
@@ -254,18 +251,7 @@ This project was created using `bun init` in bun v1.2.9. [Bun](https://bun.sh) i
 
 ### Package Configuration
 
-To ensure the package can be run with `bunx bsv-mcp`, make sure your `package.json` includes:
-
-```json
-{
-  "name": "bsv-mcp",
-  "bin": {
-    "bsv-mcp": "./index.ts"
-  },
-  "type": "module"
-  // ...other configuration
-}
-```
+The main entry point for this package is `index.ts`.
 
 ### Running Tests
 

package/package.json

@@ -2,7 +2,7 @@
 	"name": "bsv-mcp",
 	"module": "index.ts",
 	"type": "module",
-	"version": "0.0.6",
+	"version": "0.0.8",
 	"bin": {
 		"bsv-mcp": "./index.ts"
 	},

package/smithery.yaml

@@ -0,0 +1,21 @@
+build:
+  dockerBuildPath: ./ 
+  
+startCommand:
+  type: stdio
+  configSchema:
+    type: object
+    required:
+      - privateKeyWif
+    properties:
+      privateKeyWif:
+        type: string
+        description: "The private key WIF (Wallet Import Format) for Bitcoin SV transactions. This key is used to sign transactions and is required for wallet operations."
+  commandFunction: |
+    (config) => ({ 
+      command: 'bun', 
+      args: ['run', 'index.ts'], 
+      env: { 
+        PRIVATE_KEY_WIF: config.privateKeyWif 
+      } 
+    })

package/tools/wallet/schemas.ts

@@ -72,6 +72,19 @@ export const walletDecryptArgsSchema = z.object({
 	privileged: z.boolean().optional(),
 });
 
+// Combined wallet encryption/decryption args
+export const walletEncryptionArgsSchema = z.object({
+	mode: z.enum(["encrypt", "decrypt"]).describe("Operation mode: 'encrypt' to encrypt data or 'decrypt' to decrypt data"),
+	data: z.array(z.number()).describe("Data to process: plaintext for encryption or ciphertext for decryption"),
+	protocolID: walletProtocolSchema,
+	keyID: z.string(),
+	privilegedReason: z.string().optional(),
+	counterparty: z
+		.union([z.string(), z.literal("self"), z.literal("anyone")])
+		.optional(),
+	privileged: z.boolean().optional(),
+}).describe("Combined schema for encryption and decryption operations, with a mode parameter to switch between functions");
+
 // Create HMAC arguments
 export const createHmacArgsSchema = z.object({
 	message: z.string(),
@@ -296,3 +309,4 @@ export const purchaseListingArgsSchema = z.object({
 // Export types
 export type SendToAddressArgs = z.infer<typeof sendToAddressArgsSchema>;
 export type PurchaseListingArgs = z.infer<typeof purchaseListingArgsSchema>;
+export type WalletEncryptionArgs = z.infer<typeof walletEncryptionArgsSchema>;

package/tools/wallet/tools.ts

@@ -31,8 +31,7 @@ import {
 	type purchaseListingArgsSchema,
 	type sendToAddressArgsSchema,
 	verifySignatureArgsSchema,
-	walletDecryptArgsSchema,
-	walletEncryptArgsSchema,
+	walletEncryptionArgsSchema,
 } from "./schemas";
 
 import { registerCreateOrdinalsTool } from "./createOrdinals";
@@ -46,8 +45,7 @@ type ToolArgSchemas = {
 	wallet_getPublicKey: typeof getPublicKeyArgsSchema;
 	wallet_createSignature: typeof createSignatureArgsSchema;
 	wallet_verifySignature: typeof verifySignatureArgsSchema;
-	wallet_encrypt: typeof walletEncryptArgsSchema;
-	wallet_decrypt: typeof walletDecryptArgsSchema;
+	wallet_encryption: typeof walletEncryptionArgsSchema;
 	wallet_listActions: typeof listActionsArgsSchema;
 	wallet_listOutputs: typeof listOutputsArgsSchema;
 	wallet_getNetwork: typeof emptyArgsSchema;
@@ -94,11 +92,12 @@ export function registerWalletTools(
 	// Handle tools registration with properly typed parameters
 	function registerTool<T extends z.ZodType>(
 		name: keyof ToolArgSchemas,
+		description: string,
 		schema: { args: T },
 		handler: ToolCallback<{ args: T }>,
 	): void {
 		// Register all tools normally
-		server.tool(name, schema, handler);
+		server.tool(name, description, schema, handler);
 		handlers[name] = handler as ToolHandler;
 	}
 
@@ -117,6 +116,7 @@ export function registerWalletTools(
 	// Register wallet_getPublicKey
 	registerTool(
 		"wallet_getPublicKey",
+		"Retrieves the current wallet's public key. This public key can be used for cryptographic operations like signature verification or encryption.",
 		{ args: getPublicKeyArgsSchema },
 		async (
 			{ args }: { args: z.infer<typeof getPublicKeyArgsSchema> },
@@ -135,6 +135,7 @@ export function registerWalletTools(
 	// Register wallet_createSignature
 	registerTool(
 		"wallet_createSignature",
+		"Creates a cryptographic signature using the wallet's private key. This tool enables secure message signing and transaction authorization, supporting various signature protocols.",
 		{ args: createSignatureArgsSchema },
 		async (
 			{ args }: { args: z.infer<typeof createSignatureArgsSchema> },
@@ -153,6 +154,7 @@ export function registerWalletTools(
 	// Register wallet_verifySignature
 	registerTool(
 		"wallet_verifySignature",
+		"Verifies a cryptographic signature against a message or data. This tool supports various verification protocols and can validate signatures from both the wallet's own keys and external public keys.",
 		{ args: verifySignatureArgsSchema },
 		async (
 			{ args }: { args: z.infer<typeof verifySignatureArgsSchema> },
@@ -168,16 +170,38 @@ export function registerWalletTools(
 		},
 	);
 
-	// Register wallet_encrypt
+	// Register combined wallet_encryption tool
 	registerTool(
-		"wallet_encrypt",
-		{ args: walletEncryptArgsSchema },
+		"wallet_encryption",
+		"Combined tool for encrypting and decrypting data using the wallet's cryptographic keys. Supports both encryption of plaintext data and decryption of previously encrypted content. Use the 'mode' parameter to switch between operations.",
+		{ args: walletEncryptionArgsSchema },
 		async (
-			{ args }: { args: z.infer<typeof walletEncryptArgsSchema> },
+			{ args }: { args: z.infer<typeof walletEncryptionArgsSchema> },
 			extra: RequestHandlerExtra,
 		) => {
 			try {
-				const result = await wallet.encrypt(args);
+				let result: { ciphertext?: number[]; plaintext?: number[] };
+				if (args.mode === "encrypt") {
+					// For encryption, the data is treated as plaintext
+					result = await wallet.encrypt({
+						plaintext: args.data,
+						protocolID: args.protocolID,
+						keyID: args.keyID,
+						privilegedReason: args.privilegedReason,
+						counterparty: args.counterparty,
+						privileged: args.privileged,
+					});
+				} else {
+					// For decryption, the data is treated as ciphertext
+					result = await wallet.decrypt({
+						ciphertext: args.data,
+						protocolID: args.protocolID,
+						keyID: args.keyID,
+						privilegedReason: args.privilegedReason,
+						counterparty: args.counterparty,
+						privileged: args.privileged,
+					});
+				}
 				return { content: [{ type: "text", text: JSON.stringify(result) }] };
 			} catch (err: unknown) {
 				const msg = err instanceof Error ? err.message : String(err);
@@ -186,27 +210,8 @@ export function registerWalletTools(
 		},
 	);
 
-	// Register wallet_decrypt
-	registerTool(
-		"wallet_decrypt",
-		{ args: walletDecryptArgsSchema },
-		async (
-			{ args }: { args: z.infer<typeof walletDecryptArgsSchema> },
-			extra: RequestHandlerExtra,
-		) => {
-			try {
-				const result = await wallet.decrypt(args);
-				return { content: [{ type: "text", text: JSON.stringify(result) }] };
-			} catch (err: unknown) {
-				const msg = err instanceof Error ? err.message : String(err);
-				return { content: [{ type: "text", text: msg }], isError: true };
-			}
-		},
-	);
-
-	// Register ordinals extension tools
-	// Register the wallet_createOrdinals tool
+	// Register createOrdinals tool
 	registerCreateOrdinalsTool(server, wallet);
-
+	
 	return handlers;
 }

package/tools/wallet/wallet.ts

@@ -38,6 +38,7 @@ import type {
 	ListOutputsResult,
 	ProveCertificateArgs,
 	ProveCertificateResult,
+	PubKeyHex,
 	RelinquishCertificateArgs,
 	RelinquishCertificateResult,
 	RelinquishOutputArgs,
@@ -127,7 +128,15 @@ export class Wallet extends ProtoWallet implements WalletInterface {
 	}
 
 	async getPublicKey(args: GetPublicKeyArgs): Promise<GetPublicKeyResult> {
-		return Promise.reject(new Error("Not implemented"));
+		const privateKey = this.getPrivateKey();
+		if (!privateKey) {
+			throw new Error("No private key available");
+		}
+		
+		const publicKey = privateKey.toPublicKey();
+		return {
+			publicKey: publicKey.toDER("hex") as PubKeyHex,
+		};
 	}
 	async revealCounterpartyKeyLinkage(
 		args: RevealCounterpartyKeyLinkageArgs,