bsv-mcp 0.0.15 → 0.0.17

package/README.md

@@ -143,7 +143,7 @@ Wallet tools provide core BSV wallet functionality:
 | `wallet_getPublicKey` | Retrieves a public key for a specified protocol and key ID | `{"publicKey":"032d0c73eb9270e9e009fd1f9dd77e19cf764fbad5f799560c4e8fd414e40d6fc2"}` |
 | `wallet_createSignature` | Creates a cryptographic signature for the provided data | `{"signature":[144,124,85,193,226,45,140,249,9,177,11,167,33,215,209,38,...]}` |
 | `wallet_verifySignature` | Verifies a cryptographic signature against the provided data | `{"isValid":true}` |
-| `wallet_encryption` | Combined tool for encrypting and decrypting data using the wallet's cryptographic keys (replaces separate encrypt/decrypt tools) | Encrypt: `{"ciphertext":[89,32,155,38,125,22,49,226,26,...]}` <br> Decrypt: `{"plaintext":[104,101,108,108,111,32,119,111,114,108,100]}` |
+| `wallet_encryption` | Combined tool for encrypting and decrypting data using the wallet's cryptographic keys.<br><br>**Examples:**<br>1. Encrypt text: `"Encrypt this message: Hello World"`<br>2. Decrypt data: `"Decrypt this data that was previously encrypted for me"` | Encrypt: `{"ciphertext":[89,32,155,38,125,22,49,226,26,...]}` <br> Decrypt: `{"plaintext":"hello world"}` |
 | `wallet_getAddress` | Returns a BSV address for the current wallet or a derived path | `{"address":"1ExampleBsvAddressXXXXXXXXXXXXXXXXX","status":"ok"}` |
 | `wallet_sendToAddress` | Sends BSV to a specified address (supports BSV or USD amounts) | `{"status":"success","txid":"a1b2c3d4e5f6...","satoshis":1000000}` |
 | `wallet_purchaseListing` | Purchases NFTs or BSV-20/BSV-21 tokens from marketplace listings | `{"status":"success","txid":"a1b2c3d4e5f6...","type":"nft","origin":"abcdef123456..."}` |
@@ -177,7 +177,7 @@ General-purpose utility functions:
 
 | Tool Name | Description | Example Output |
 |-----------|-------------|----------------|
-| `utils_convertData` | Converts data between different encodings (utf8, hex, base64, binary) | `68656c6c6f20776f726c64` (UTF-8 "hello world" converted to hex) |
+| `utils_convertData` | Converts data between different encoding formats (utf8, hex, base64, binary).<br><br>**Parameters:**<br>- `data` (required): The string to convert<br>- `from` (required): Source encoding format (utf8, hex, base64, or binary)<br>- `to` (required): Target encoding format (utf8, hex, base64, or binary)<br><br>**Examples:**<br>- UTF-8 to hex: `{"data": "hello world", "from": "utf8", "to": "hex"}` → `68656c6c6f20776f726c64`<br>- UTF-8 to base64: `{"data": "Hello World", "from": "utf8", "to": "base64"}` → `SGVsbG8gV29ybGQ=`<br>- base64 to UTF-8: `{"data": "SGVsbG8gV29ybGQ=", "from": "base64", "to": "utf8"}` → `Hello World`<br>- hex to base64: `{"data": "68656c6c6f20776f726c64", "from": "hex", "to": "base64"}` → `aGVsbG8gd29ybGQ=`<br><br>**Notes:**<br>- All parameters are required<br>- The tool returns the converted data as a string<br>- For binary conversion, data is represented as an array of byte values | `"SGVsbG8gV29ybGQ="` (UTF-8 "Hello World" converted to base64) |
 
 ## Using the Tools with MCP
 

package/index.ts

@@ -37,7 +37,7 @@ const privKey = validatePrivateKey();
 
 const server = new McpServer({
 	name: "Bitcoin SV MCP Server",
-	version: "0.0.15",
+	version: "0.0.17",
 });
 
 // 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.15",
+	"version": "0.0.17",
 	"license": "MIT",
 	"author": "satchmo",
 	"description": "A collection of Bitcoin SV (BSV) tools for the Model Context Protocol (MCP) framework",

package/tools/utils/index.ts

@@ -11,7 +11,20 @@ const encodingSchema = z.enum(["utf8", "hex", "base64", "binary"]);
 export function registerUtilsTools(server: McpServer): void {
 	server.tool(
 		"utils_convertData",
-		"Converts data between different encodings (utf8, hex, base64, binary). Useful for transforming data formats when working with blockchain data, encryption, or file processing.",
+		"Converts data between different encodings (utf8, hex, base64, binary). Useful for transforming data formats when working with blockchain data, encryption, or file processing.\n\n" +
+		"Parameters:\n" +
+		"- data (required): The string to convert\n" +
+		"- from (required): Source encoding format (utf8, hex, base64, or binary)\n" +
+		"- to (required): Target encoding format (utf8, hex, base64, or binary)\n\n" +
+		"Example usage:\n" +
+		"- UTF-8 to hex: {\"data\": \"hello world\", \"from\": \"utf8\", \"to\": \"hex\"} → 68656c6c6f20776f726c64\n" +
+		"- UTF-8 to base64: {\"data\": \"Hello World\", \"from\": \"utf8\", \"to\": \"base64\"} → SGVsbG8gV29ybGQ=\n" +
+		"- base64 to UTF-8: {\"data\": \"SGVsbG8gV29ybGQ=\", \"from\": \"base64\", \"to\": \"utf8\"} → Hello World\n" +
+		"- hex to base64: {\"data\": \"68656c6c6f20776f726c64\", \"from\": \"hex\", \"to\": \"base64\"} → aGVsbG8gd29ybGQ=\n\n" +
+		"Notes:\n" +
+		"- All parameters are required\n" +
+		"- The tool returns the converted data as a string\n" +
+		"- For binary conversion, data is represented as an array of byte values",
 		{
 			args: z.object({
 				data: z.string().describe("The data string to be converted"),

package/tools/wallet/schemas.ts

@@ -75,7 +75,11 @@ export const walletDecryptArgsSchema = z.object({
 // 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"),
+	data: z.union([
+		z.string().describe("Text data (with encoding specified by the encoding parameter)"),
+		z.array(z.number()).describe("Binary data as an array of numbers")
+	]).describe("Data to process: plaintext for encryption or ciphertext for decryption"),
+	encoding: z.enum(["utf8", "hex", "base64"]).optional().default("utf8").describe("Encoding of text data (default: utf8)"),
 	protocolID: walletProtocolSchema.describe("Protocol identifier - common values are 'aes' for symmetric encryption or 'ecies' for asymmetric encryption"),
 	keyID: z.string().describe("Key identifier - use 'default' or 'primary' for the default wallet key"),
 	privilegedReason: z.string().optional().describe("Required reason for privileged operations"),

package/tools/wallet/tools.ts

@@ -39,6 +39,7 @@ import type { createOrdinalsArgsSchema } from "./createOrdinals";
 import { registerGetAddressTool } from "./getAddress";
 import { registerPurchaseListingTool } from "./purchaseListing";
 import { registerSendToAddressTool } from "./sendToAddress";
+import { Utils } from "@bsv/sdk";
 
 // Define mapping from tool names to argument schemas
 type ToolArgSchemas = {
@@ -176,24 +177,23 @@ export function registerWalletTools(
 		"Combined tool for encrypting and decrypting data using the wallet's cryptographic keys.\n\n" +
 		"PARAMETERS:\n" +
 		"- mode: (required) Either \"encrypt\" to encrypt plaintext or \"decrypt\" to decrypt ciphertext\n" +
-		"- data: (required) Array of byte values to process (plaintext for encryption or ciphertext for decryption)\n" +
-		"- protocolID: (required) Protocol to use (commonly \"aes\" or \"ecies\")\n" +
-		"- keyID: (required) Key identifier (use \"default\" or \"primary\" for default wallet key)\n" +
-		"- counterparty: (optional) Set to \"self\" for personal encryption or specific key for recipient\n" +
-		"- privileged: (optional) Boolean indicating if operation requires elevated privileges\n\n" +
+		"- data: (required) Text string or array of numbers to process (plaintext for encryption or ciphertext for decryption)\n" +
+		"- encoding: (optional) For text input, the encoding format (utf8, hex, base64) - default is utf8\n" +
+		"- protocolID: (required) Protocol identifier - common values are 'aes' for symmetric encryption or 'ecies' for asymmetric encryption\n" +
+		"- keyID: (required) Key identifier - use 'default' or 'primary' for the default wallet key\n\n" +
 		"EXAMPLES:\n" +
-		"1. Encrypt data:\n" +
+		"1. Encrypt text data:\n" +
 		"   {\n" +
 		"     \"mode\": \"encrypt\",\n" +
-		"     \"data\": [84, 104, 105, 115, 32, 105, 115, 32, 116, 101, 115, 116],\n" +
-		"     \"protocolID\": \"aes\",\n" +
+		"     \"data\": \"Hello World\",\n" +
+		"     \"protocolID\": [1, \"aes\"],\n" +
 		"     \"keyID\": \"default\"\n" +
 		"   }\n\n" +
 		"2. Decrypt previously encrypted data:\n" +
 		"   {\n" +
 		"     \"mode\": \"decrypt\",\n" +
 		"     \"data\": [encrypted bytes from previous response],\n" +
-		"     \"protocolID\": \"aes\",\n" +
+		"     \"protocolID\": [1, \"aes\"],\n" +
 		"     \"keyID\": \"default\"\n" +
 		"   }",
 		{ args: walletEncryptionArgsSchema },
@@ -202,32 +202,59 @@ export function registerWalletTools(
 			extra: RequestHandlerExtra,
 		) => {
 			try {
-				let result: { ciphertext?: number[]; plaintext?: number[] };
-				if (args.mode === "encrypt") {
-					// For encryption, the data is treated as plaintext
+				const { mode, data, protocolID, keyID, encoding } = args;
+				
+				// Convert string data to binary if needed
+				let binaryData: number[];
+				if (Array.isArray(data)) {
+					binaryData = data;
+				} else {
+					// String data with encoding
+					const { toArray } = Utils;
+					binaryData = toArray(data, encoding || "utf8");
+				}
+				
+				let result: { ciphertext?: number[]; plaintext?: number[] } = {};
+				if (mode === "encrypt") {
 					result = await wallet.encrypt({
-						plaintext: args.data,
-						protocolID: args.protocolID,
-						keyID: args.keyID,
-						privilegedReason: args.privilegedReason,
-						counterparty: args.counterparty,
-						privileged: args.privileged,
+						plaintext: binaryData,
+						protocolID,
+						keyID,
 					});
-				} else {
-					// For decryption, the data is treated as ciphertext
+				} else if (mode === "decrypt") {
 					result = await wallet.decrypt({
-						ciphertext: args.data,
-						protocolID: args.protocolID,
-						keyID: args.keyID,
-						privilegedReason: args.privilegedReason,
-						counterparty: args.counterparty,
-						privileged: args.privileged,
+						ciphertext: binaryData,
+						protocolID,
+						keyID,
 					});
+					
+					// For decryption, convert plaintext back to string if it's likely UTF-8 text
+					if (result.plaintext) {
+						try {
+							const { toUTF8 } = Utils;
+							const textResult = toUTF8(result.plaintext);
+							// If conversion succeeds and seems like valid text, return as string
+							if (textResult && textResult.length > 0) {
+								return { 
+									content: [{ 
+										type: "text", 
+										text: JSON.stringify({ plaintext: textResult }) 
+									}] 
+								};
+							}
+						} catch (e) {
+							// If UTF-8 conversion fails, continue with binary result
+						}
+					}
 				}
+				
 				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 };
+			} catch (error) {
+				const errorMessage = error instanceof Error ? error.message : String(error);
+				return { 
+					content: [{ type: "text", text: `Error during ${args.mode}: ${errorMessage}` }],
+					isError: true
+				};
 			}
 		},
 	);