bsv-mcp 0.0.20 → 0.0.21

package/README.md

@@ -75,13 +75,15 @@ 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. Clone this repository and run `bun install` in the project directory
 3. Open your Claude for Desktop configuration file:
+
    ```bash
    # macOS/Linux
-   code ~/Library/Application Support/Claude/claude_desktop_config.json
-   
+   code ~/Library/Application\ Support/Claude/claude_desktop_config.json
+
    # Windows
    code %APPDATA%\Claude\claude_desktop_config.json
    ```
+
 4. Add the BSV MCP server to your configuration (create the file if it doesn't exist):
    ```json
   {
@@ -110,61 +112,76 @@ The toolkit is organized into several categories:
 
 Wallet tools provide core BSV wallet functionality:
 
-| Tool Name | Description | Example Output |
-|-----------|-------------|----------------|
-| `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.<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..."}` |
-| `wallet_createOrdinals` | Creates and inscribes ordinals on the BSV blockchain | `{"txid":"a1b2c3d4e5f6...","inscriptionAddress":"1ExampleAddress...","contentType":"image/png"}` |
+| Tool Name                | Description                                                                                                                                                                                                                                           | Example Output                                                                                            |
+| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
+| `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.<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..."}`                   |
+| `wallet_createOrdinals`  | Creates and inscribes ordinals on the BSV blockchain                                                                                                                                                                                                  | `{"txid":"a1b2c3d4e5f6...","inscriptionAddress":"1ExampleAddress...","contentType":"image/png"}`          |
 
 ### BSV Tools
 
 Tools for interacting with the BSV blockchain and network:
 
-| Tool Name | Description | Example Output |
-|-----------|-------------|----------------|
-| `bsv_getPrice` | Gets the current BSV price from an exchange API | `Current BSV price: $38.75 USD` |
-| `bsv_decodeTransaction` | Decodes a BSV transaction and returns detailed information | `{"txid":"a1b2c3d4e5f6...","version":1,"locktime":0,"size":225,"inputs":[...],"outputs":[...]}` |
-| `bsv_explore` | Comprehensive blockchain explorer tool accessing WhatsOnChain API endpoints | `{"chain_info":{"chain":"main","blocks":826458,"headers":826458,"bestblockhash":"0000000000..."}}` |
+| Tool Name               | Description                                                                 | Example Output                                                                                     |
+| ----------------------- | --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
+| `bsv_getPrice`          | Gets the current BSV price from an exchange API                             | `Current BSV price: $38.75 USD`                                                                    |
+| `bsv_decodeTransaction` | Decodes a BSV transaction and returns detailed information                  | `{"txid":"a1b2c3d4e5f6...","version":1,"locktime":0,"size":225,"inputs":[...],"outputs":[...]}`    |
+| `bsv_explore`           | Comprehensive blockchain explorer tool accessing WhatsOnChain API endpoints | `{"chain_info":{"chain":"main","blocks":826458,"headers":826458,"bestblockhash":"0000000000..."}}` |
 
 ### Ordinals Tools
 
 Tools for working with ordinals (NFTs) on BSV:
 
-| Tool Name | Description | Example Output |
-|-----------|-------------|----------------|
-| `ordinals_getInscription` | Retrieves detailed information about a specific inscription | `{"id":"a1b2c3d4e5f6...","origin":"a1b2c3d4e5f6...","contentType":"image/png","content":"iVBORw0KGgoAAA..."}` |
-| `ordinals_searchInscriptions` | Searches for inscriptions based on various criteria | `{"results":[{"id":"a1b2c3...","contentType":"image/png","owner":"1Example..."},...]}` |
-| `ordinals_marketListings` | Retrieves market listings for NFTs, BSV-20, and BSV-21 tokens with unified interface | `{"results":[{"txid":"a1b2c3...","price":9990000,"tick":"PEPE","listing":true},...]}` |
-| `ordinals_marketSales` | Gets information about BSV-20 and BSV-21 token market sales | `{"results":[{"txid":"a1b2c3...","price":34710050,"tick":"$BTC","sale":true},...]}` |
-| `ordinals_getTokenByIdOrTicker` | Retrieves details about a specific BSV20 token by ID | `{"tick":"PEPE","max":"21000000","lim":"1000","dec":"2"}` |
+| Tool Name                       | Description                                                                          | Example Output                                                                                                |
+| ------------------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- |
+| `ordinals_getInscription`       | Retrieves detailed information about a specific inscription                          | `{"id":"a1b2c3d4e5f6...","origin":"a1b2c3d4e5f6...","contentType":"image/png","content":"iVBORw0KGgoAAA..."}` |
+| `ordinals_searchInscriptions`   | Searches for inscriptions based on various criteria                                  | `{"results":[{"id":"a1b2c3...","contentType":"image/png","owner":"1Example..."},...]}`                        |
+| `ordinals_marketListings`       | Retrieves market listings for NFTs, BSV-20, and BSV-21 tokens with unified interface | `{"results":[{"txid":"a1b2c3...","price":9990000,"tick":"PEPE","listing":true},...]}`                         |
+| `ordinals_marketSales`          | Gets information about BSV-20 and BSV-21 token market sales                          | `{"results":[{"txid":"a1b2c3...","price":34710050,"tick":"$BTC","sale":true},...]}`                           |
+| `ordinals_getTokenByIdOrTicker` | Retrieves details about a specific BSV20 token by ID                                 | `{"tick":"PEPE","max":"21000000","lim":"1000","dec":"2"}`                                                     |
 
 ### Utility Tools
 
 General-purpose utility functions:
 
-| Tool Name | Description | Example Output |
-|-----------|-------------|----------------|
+| Tool Name           | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Example Output                                                 |
+| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------- |
 | `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) |
 
+### MNEE Tools
+
+Tools for working with MNEE tokens:
+
+| Tool Name         | Description                                                                                                                                                                           | Example Output                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `mnee_getBalance` | Retrieves the current MNEE token balance for the wallet                                                                                                                               | `{"balance": {"amount": 2900, "decimalAmount": 0.029}}`                                                                                                                                                                                                                                                                                                                                                                             |
+| `mnee_sendMnee`   | Send MNEE tokens to a specified address. Supports both MNEE and USD amounts                                                                                                           | `{"success": true, "txid": "d1ce853934964e6c1fe9f44c918a824f175c6ab466b966f49ebc0682a8318895", "rawtx": "0100000002a0be40d8942015f1...", "mneeAmount": 0.01, "usdAmount": "$0.01", "recipient": "15mNxEkyKJXPD8amic6oLUjS45zBKQQoLu"}`                                                                                                                                                                                              |
+| `mnee_parseTx`    | Parse an MNEE transaction to get detailed information about its operations and amounts. All amounts are in atomic units with 5 decimal precision (e.g. 1000 atomic units = 0.01 MNEE) | `{"txid": "d1ce853934964e6c1fe9f44c918a824f175c6ab466b966f49ebc0682a8318895", "environment": "production", "type": "transfer", "inputs": [{"address": "18izL7Wtm2fx3ALoRY3MkY2VFSMjArP62D", "amount": 2900}], "outputs": [{"address": "15mNxEkyKJXPD8amic6oLUjS45zBKQQoLu", "amount": 1000}, {"address": "19Vq2TV8aVhFNLQkhDMdnEQ7zT96x6F3PK", "amount": 100}, {"address": "18izL7Wtm2fx3ALoRY3MkY2VFSMjArP62D", "amount": 1800}]}` |
+
 ## Using the Tools with MCP
 
 Once connected, you can use natural language to interact with Bitcoin SV through your AI assistant. Here are some example prompts:
 
 ### Wallet Operations
+
 - "Get my Bitcoin SV address"
 - "Send 0.01 BSV to 1ExampleBsvAddressXXXXXXXXXXXXXXXXX"
 - "Send $5 USD worth of BSV to 1ExampleBsvAddressXXXXXXXXXXXXXXXXX"
+- "Send 0.01 MNEE to 1ExampleBsvAddressXXXXXXXXXXXXXXXXX"
+- "Check my MNEE balance"
+- "Parse this MNEE transaction: txid"
 - "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"
 
 ### Ordinals (NFTs)
+
 - "Show me information about the NFT with outpoint 6a89047af2cfac96da17d51ae8eb62c5f1d982be2bc4ba0d0cd2084b7ffed325_0"
 - "Search for Pixel Zoide NFTs"
 - "Show me the current marketplace listings for BSV NFTs"
@@ -172,6 +189,7 @@ Once connected, you can use natural language to interact with Bitcoin SV through
 - "Get recent BSV-20 token sales"
 
 ### Blockchain Operations
+
 - "What is the current BSV price?"
 - "Decode this BSV transaction: (transaction hex or ID)"
 - "Get the latest Bitcoin SV chain information"
@@ -181,6 +199,7 @@ Once connected, you can use natural language to interact with Bitcoin SV through
 - "Get details for transaction with hash a1b2c3d4e5f6..."
 
 ### Data Conversion
+
 - "Convert 'Hello World' from UTF-8 to hex format"
 
 ## How MCP Works
@@ -203,6 +222,7 @@ If you're having issues connecting to the server:
 4. Look for error messages in the client's console output
 
 For Claude for Desktop, check the logs at:
+
 ```bash
 tail -n 20 -f ~/Library/Logs/Claude/mcp*.log
 ```
@@ -226,47 +246,53 @@ The `bsv_explore` tool provides comprehensive access to the Bitcoin SV blockchai
 The tool supports the following endpoint categories and specific endpoints:
 
 #### Chain Data
-| Endpoint | Description | Required Parameters | Example Response |
-|----------|-------------|---------------------|------------------|
-| `chain_info` | Network statistics, difficulty, and chain work | None | `{"chain":"main","blocks":826458,"headers":826458,"bestblockhash":"000000000000..."}` |
-| `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}]` |
+
+| Endpoint             | Description                                     | Required Parameters | Example Response                                                                      |
+| -------------------- | ----------------------------------------------- | ------------------- | ------------------------------------------------------------------------------------- |
+| `chain_info`         | Network statistics, difficulty, and chain work  | None                | `{"chain":"main","blocks":826458,"headers":826458,"bestblockhash":"000000000000..."}` |
+| `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}]`        |
 
 #### Block Data
-| Endpoint | Description | Required Parameters | Example Response |
-|----------|-------------|---------------------|------------------|
-| `block_by_hash` | Complete block data via hash | `blockHash` | `{"hash":"000000000000...","confirmations":1000,"size":1000000,...}` |
-| `block_by_height` | Complete block data via height | `blockHeight` | `{"hash":"000000000000...","confirmations":1000,"size":1000000,...}` |
-| `tag_count_by_height` | Stats on tag count for a specific block | `blockHeight` | `{"tags":{"amp":3,"bitkey":5,"metanet":12,"planaria":7,"b":120}}` |
-| `block_headers` | Retrieves the last 10 block headers | None | `[{"hash":"000000000000...","height":826458,"version":536870912,...},...]` |
-| `block_pages` | Retrieves pages of transaction IDs for large blocks | `blockHash`, optional: `pageNumber` | `["tx1hash","tx2hash","tx3hash",...]` |
+
+| Endpoint              | Description                                         | Required Parameters                 | Example Response                                                           |
+| --------------------- | --------------------------------------------------- | ----------------------------------- | -------------------------------------------------------------------------- |
+| `block_by_hash`       | Complete block data via hash                        | `blockHash`                         | `{"hash":"000000000000...","confirmations":1000,"size":1000000,...}`       |
+| `block_by_height`     | Complete block data via height                      | `blockHeight`                       | `{"hash":"000000000000...","confirmations":1000,"size":1000000,...}`       |
+| `tag_count_by_height` | Stats on tag count for a specific block             | `blockHeight`                       | `{"tags":{"amp":3,"bitkey":5,"metanet":12,"planaria":7,"b":120}}`          |
+| `block_headers`       | Retrieves the last 10 block headers                 | None                                | `[{"hash":"000000000000...","height":826458,"version":536870912,...},...]` |
+| `block_pages`         | Retrieves pages of transaction IDs for large blocks | `blockHash`, optional: `pageNumber` | `["tx1hash","tx2hash","tx3hash",...]`                                      |
 
 #### Stats Data
-| Endpoint | Description | Required Parameters | Example Response |
-|----------|-------------|---------------------|------------------|
-| `block_stats_by_height` | Block statistics for a specific height | `blockHeight` | `{"size":123456,"txCount":512,"outputTotal":54.12345678,"outputTotalUsd":2345.67,...}` |
-| `block_miner_stats` | Block mining statistics for a time period | optional: `days` (default 7) | `{"blocks":{"miner1":412,"miner2":208,...},"total":1008}` |
-| `miner_summary_stats` | Summary of mining statistics | optional: `days` (default 7) | `{"totalBlocks":1008,"totalFees":1.23456789,"totalFeesUsd":53.67,...}` |
+
+| Endpoint                | Description                               | Required Parameters          | Example Response                                                                       |
+| ----------------------- | ----------------------------------------- | ---------------------------- | -------------------------------------------------------------------------------------- |
+| `block_stats_by_height` | Block statistics for a specific height    | `blockHeight`                | `{"size":123456,"txCount":512,"outputTotal":54.12345678,"outputTotalUsd":2345.67,...}` |
+| `block_miner_stats`     | Block mining statistics for a time period | optional: `days` (default 7) | `{"blocks":{"miner1":412,"miner2":208,...},"total":1008}`                              |
+| `miner_summary_stats`   | Summary of mining statistics              | optional: `days` (default 7) | `{"totalBlocks":1008,"totalFees":1.23456789,"totalFeesUsd":53.67,...}`                 |
 
 #### Transaction Data
-| Endpoint | Description | Required Parameters | Example Response |
-|----------|-------------|---------------------|------------------|
-| `tx_by_hash` | Detailed transaction data | `txHash` | `{"txid":"a1b2c3d4e5f6...","version":1,"locktime":0,"size":225,...}` |
-| `tx_raw` | Raw transaction hex data | `txHash` | `"01000000012345abcdef..."` |
-| `tx_receipt` | Transaction receipt | `txHash` | `{"blockHash":"000000000000...","blockHeight":800000,"confirmations":26458}` |
-| `bulk_tx_details` | Retrieve multiple transactions in one request | `txids` (array) | `[{"txid":"a1b2c3d4e5f6...","version":1,...}, {"txid":"b2c3d4e5f6a7...","version":1,...}]` |
+
+| Endpoint          | Description                                   | Required Parameters | Example Response                                                                           |
+| ----------------- | --------------------------------------------- | ------------------- | ------------------------------------------------------------------------------------------ |
+| `tx_by_hash`      | Detailed transaction data                     | `txHash`            | `{"txid":"a1b2c3d4e5f6...","version":1,"locktime":0,"size":225,...}`                       |
+| `tx_raw`          | Raw transaction hex data                      | `txHash`            | `"01000000012345abcdef..."`                                                                |
+| `tx_receipt`      | Transaction receipt                           | `txHash`            | `{"blockHash":"000000000000...","blockHeight":800000,"confirmations":26458}`               |
+| `bulk_tx_details` | Retrieve multiple transactions in one request | `txids` (array)     | `[{"txid":"a1b2c3d4e5f6...","version":1,...}, {"txid":"b2c3d4e5f6a7...","version":1,...}]` |
 
 #### Address Data
-| Endpoint | Description | Required Parameters | Example Response |
-|----------|-------------|---------------------|------------------|
-| `address_history` | Transaction history for address | `address`, optional: `limit` | `[{"tx_hash":"a1b2c3d4e5f6...","height":800000},...]` |
-| `address_utxos` | Unspent outputs for address | `address` | `[{"tx_hash":"a1b2c3d4e5f6...","tx_pos":0,"value":100000},...]` |
+
+| Endpoint          | Description                     | Required Parameters          | Example Response                                                |
+| ----------------- | ------------------------------- | ---------------------------- | --------------------------------------------------------------- |
+| `address_history` | Transaction history for address | `address`, optional: `limit` | `[{"tx_hash":"a1b2c3d4e5f6...","height":800000},...]`           |
+| `address_utxos`   | Unspent outputs for address     | `address`                    | `[{"tx_hash":"a1b2c3d4e5f6...","tx_pos":0,"value":100000},...]` |
 
 #### Network
-| Endpoint | Description | Required Parameters | Example Response |
-|----------|-------------|---------------------|------------------|
-| `health` | API health check | None | `{"status":"synced"}` |
+
+| Endpoint | Description      | Required Parameters | Example Response      |
+| -------- | ---------------- | ------------------- | --------------------- |
+| `health` | API health check | None                | `{"status":"synced"}` |
 
 ### Usage Examples
 
@@ -305,6 +331,7 @@ Under the hood, the tool accepts parameters to specify which data to retrieve:
 ### Network Options
 
 The tool supports both mainnet and testnet:
+
 - `main`: Bitcoin SV mainnet (default)
 - `test`: Bitcoin SV testnet
 
@@ -324,4 +351,4 @@ bun test
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

package/index.ts

@@ -11,25 +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
@@ -37,7 +45,7 @@ const privKey = validatePrivateKey();
 
 const server = new McpServer({
 	name: "Bitcoin SV MCP Server",
-	version: "0.0.20",
+	version: "0.0.21",
 });
 
 // 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.20",
+	"version": "0.0.21",
 	"license": "MIT",
 	"author": "satchmo",
 	"description": "A collection of Bitcoin SV (BSV) tools for the Model Context Protocol (MCP) framework",
@@ -45,6 +45,7 @@
 		"@modelcontextprotocol/sdk": "^1.9.0",
 		"@types/node": "^22.14.1",
 		"js-1sat-ord": "^0.1.80",
+		"mnee": "^2.0.0",
 		"satoshi-token": "^0.0.4",
 		"zod": "^3.24.2"
 	},

package/tools/index.ts

@@ -2,28 +2,24 @@ import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { registerBsvTools } from "./bsv";
 import { registerOrdinalsTools } from "./ordinals";
 import { registerUtilsTools } from "./utils";
-import { registerA2bDiscoverTool } from "./a2b/discover";
-import { registerA2aCallTool } from "./a2b/call";
+import { registerMneeTools } from "./mnee";
 
 /**
  * Register all tools with the MCP server
  * @param server The MCP server instance
  */
 export function registerAllTools(server: McpServer): void {
-	// Register BSV-related tools
-	registerBsvTools(server);
+  // Register BSV-related tools
+  registerBsvTools(server);
 
-	// Register Ordinals-related tools
-	registerOrdinalsTools(server);
+  // Register Ordinals-related tools
+  registerOrdinalsTools(server);
 
-	// Register utility tools
-	registerUtilsTools(server);
+  // Register utility tools
+  registerUtilsTools(server);
 
-	// 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
+  // Add more tool categories as needed
 }

package/tools/mnee/getBalance.ts

@@ -0,0 +1,56 @@
+import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
+import { z } from "zod";
+import { PrivateKey } from "@bsv/sdk";
+import type { MneeInterface } from "mnee";
+
+export const getBalanceArgsSchema = z.object({});
+
+export type GetBalanceArgs = z.infer<typeof getBalanceArgsSchema>;
+
+export function registerGetBalanceTool(
+  server: McpServer,
+  mnee: MneeInterface
+): void {
+  server.tool(
+    "mnee_getBalance",
+    "Retrieves the current MNEE token balance for the wallet. Returns the balance in MNEE tokens.",
+    {
+      args: getBalanceArgsSchema,
+    },
+    async (
+      { args }: { args: GetBalanceArgs },
+      extra: RequestHandlerExtra<any, any>
+    ) => {
+      try {
+        // Get private key from wallet
+        const privateKey = PrivateKey.fromWif(process.env.PRIVATE_KEY_WIF!);
+        if (!privateKey) {
+          throw new Error("No private key available");
+        }
+
+        const address = privateKey.toAddress().toString();
+        const balance = await mnee.balance(address);
+
+        return {
+          content: [
+            {
+              type: "text",
+              text: JSON.stringify({ balance }, null, 2),
+            },
+          ],
+        };
+      } catch (error) {
+        return {
+          content: [
+            {
+              type: "text",
+              text: error instanceof Error ? error.message : String(error),
+            },
+          ],
+          isError: true,
+        };
+      }
+    }
+  );
+}

package/tools/mnee/index.ts

@@ -0,0 +1,21 @@
+import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { registerGetBalanceTool } from "./getBalance";
+import Mnee from "mnee";
+import { registerSendMneeTool } from "./sendMnee";
+import { registerParseTxTool } from "./parseTx";
+
+const mnee = new Mnee({
+  environment: "production",
+});
+/**
+ * Register all MNEE tools with the MCP server
+ * @param server The MCP server instance
+ */
+export function registerMneeTools(server: McpServer): void {
+  // Register MNEE-related tools
+  registerGetBalanceTool(server, mnee);
+
+  registerSendMneeTool(server, mnee);
+
+  registerParseTxTool(server, mnee);
+}

package/tools/mnee/parseTx.ts

@@ -0,0 +1,45 @@
+import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
+import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import type { MneeInterface, ParseTxResponse } from "mnee";
+import { z } from "zod";
+
+/**
+ * Schema for the parseTx tool arguments.
+ */
+export const parseTxArgsSchema = z.object({
+  txid: z.string().describe("Transaction ID to parse"),
+});
+
+export type ParseTxArgs = z.infer<typeof parseTxArgsSchema>;
+
+export function registerParseTxTool(
+  server: McpServer,
+  mnee: MneeInterface
+): void {
+  server.tool(
+    "mnee_parseTx",
+    "Parse an MNEE transaction to get detailed information about its operations and amounts. All amounts are in atomic units with 5 decimal precision (e.g. 1000 atomic units = 0.01 MNEE).",
+    { args: parseTxArgsSchema },
+    async (
+      { args }: { args: ParseTxArgs },
+      extra: RequestHandlerExtra<any, any>
+    ): Promise<CallToolResult> => {
+      try {
+        const result: ParseTxResponse = await mnee.parseTx(args.txid);
+
+        return {
+          content: [
+            {
+              type: "text",
+              text: JSON.stringify(result, null, 2),
+            },
+          ],
+        };
+      } catch (error) {
+        const msg = error instanceof Error ? error.message : String(error);
+        return { content: [{ type: "text", text: msg }], isError: true };
+      }
+    }
+  );
+}

package/tools/mnee/sendMnee.ts

@@ -0,0 +1,97 @@
+import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
+import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import type Mnee from "mnee";
+import type { SendMNEE, TransferResponse } from "mnee";
+import { z } from "zod";
+
+/**
+ * Schema for the sendMnee tool arguments.
+ */
+export const sendMneeArgsSchema = z.object({
+  address: z.string().describe("The recipient's address"),
+  amount: z.number().describe("Amount to send"),
+  currency: z
+    .enum(["MNEE", "USD"])
+    .default("MNEE")
+    .describe("Currency of the amount (MNEE or USD)"),
+});
+
+export type SendMneeArgs = z.infer<typeof sendMneeArgsSchema>;
+
+/**
+ * Format a number as USD
+ */
+function formatUSD(amount: number): string {
+  return new Intl.NumberFormat("en-US", {
+    style: "currency",
+    currency: "USD",
+    minimumFractionDigits: 2,
+    maximumFractionDigits: 2,
+  }).format(amount);
+}
+
+/**
+ * Registers the mnee_sendMnee tool for sending MNEE tokens
+ */
+export function registerSendMneeTool(server: McpServer, mnee: Mnee): void {
+  server.tool(
+    "mnee_sendMnee",
+    "Send MNEE tokens to a specified address",
+    { args: sendMneeArgsSchema },
+    async (
+      { args }: { args: SendMneeArgs },
+      extra: RequestHandlerExtra<any, any>
+    ): Promise<CallToolResult> => {
+      try {
+        // Since 1 MNEE = $1, the amount is the same in both currencies
+        const mneeAmount = args.amount;
+
+        const transferRequest: SendMNEE[] = [
+          {
+            address: args.address,
+            amount: mneeAmount,
+          },
+        ];
+
+        // Get WIF from environment
+        const wif = process.env.PRIVATE_KEY_WIF;
+        if (!wif) {
+          throw new Error("PRIVATE_KEY_WIF environment variable is not set");
+        }
+
+        const result: TransferResponse = await mnee.transfer(
+          transferRequest,
+          wif
+        );
+
+        if (result.error) {
+          throw new Error(result.error);
+        }
+
+        return {
+          content: [
+            {
+              type: "text",
+              text: JSON.stringify(
+                {
+                  success: true,
+                  txid: result.txid,
+                  rawtx: result.rawtx,
+                  mneeAmount: mneeAmount,
+                  usdAmount: formatUSD(mneeAmount),
+                  recipient: args.address,
+                },
+                null,
+                2
+              ),
+            },
+          ],
+        };
+      } catch (error) {
+        const msg = error instanceof Error ? error.message : String(error);
+        return { content: [{ type: "text", text: msg }], isError: true };
+      }
+    }
+  );
+}

package/tools/wallet/tools.ts

@@ -40,9 +40,7 @@ import { registerGetAddressTool } from "./getAddress";
 import { registerPurchaseListingTool } from "./purchaseListing";
 import { registerSendToAddressTool } from "./sendToAddress";
 import { registerTransferOrdTokenTool } from "./transferOrdToken";
-import { registerA2bPublishTool } from "./a2bPublish";
 import type { transferOrdTokenArgsSchema } from "./transferOrdToken";
-import type { a2bPublishArgsSchema } from "./a2bPublish";
 import { Utils, type WalletProtocol } from "@bsv/sdk";
 
 // Define mapping from tool names to argument schemas
@@ -75,7 +73,6 @@ type ToolArgSchemas = {
 	wallet_sendToAddress: typeof sendToAddressArgsSchema;
 	wallet_purchaseListing: typeof purchaseListingArgsSchema;
 	wallet_transferOrdToken: typeof transferOrdTokenArgsSchema;
-	wallet_a2bPublish: typeof a2bPublishArgsSchema;
 	wallet_createOrdinals: typeof createOrdinalsArgsSchema;
 };
 
@@ -120,9 +117,6 @@ export function registerWalletTools(
 	// Register the wallet_transferOrdToken tool
 	registerTransferOrdTokenTool(server, wallet);
 
-	// Register the wallet_a2bPublish tool
-	registerA2bPublishTool(server, wallet);
-
 	// Register only the minimal public-facing tools
 	// wallet_createAction, wallet_signAction and wallet_getHeight have been removed
 

package/tools/a2b/call.ts

@@ -1,32 +0,0 @@
-import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
-import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
-import { z } from "zod";
-
-// Schema for invoking another agent via A2A protocol
-export const a2aCallArgsSchema = z.object({
-  url: z.string().url().describe("Full agent-to-agent endpoint URL"),
-  method: z.string().describe("A2A method name to invoke"),
-  params: z.record(z.any()).optional().describe("Payload parameters for the A2A call"),
-});
-export type A2aCallArgs = z.infer<typeof a2aCallArgsSchema>;
-
-/**
- * Registers the a2a_call tool for agent-to-agent HTTP/SSE calls
- */
-export function registerA2aCallTool(server: McpServer) {
-  server.tool(
-    "a2a_call",
-    "Invoke a remote agent's A2A endpoint via HTTP/SSE",
-    { args: a2aCallArgsSchema },
-    async (
-      { args }: { args: A2aCallArgs },
-      extra: RequestHandlerExtra
-    ) => {
-      // TODO: implement HTTP request logic (e.g., fetch, SSE)
-      return {
-        content: [{ type: "text", text: "Not implemented" }],
-        isError: true,
-      };
-    }
-  );
-} 

package/tools/a2b/discover.ts

@@ -1,30 +0,0 @@
-import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
-import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
-import { z } from "zod";
-
-// Schema for agent discovery parameters
-export const a2bDiscoverArgsSchema = z.object({
-  query: z.string().describe("Agent name or capability to search for"),
-});
-export type A2bDiscoverArgs = z.infer<typeof a2bDiscoverArgsSchema>;
-
-/**
- * Registers the a2b_discover tool for on-chain agent discovery
- */
-export function registerA2bDiscoverTool(server: McpServer) {
-  server.tool(
-    "a2b_discover",
-    "Search on-chain agent records by name or capability",
-    { args: a2bDiscoverArgsSchema },
-    async (
-      { args }: { args: A2bDiscoverArgs },
-      extra: RequestHandlerExtra
-    ) => {
-      // TODO: implement on-chain lookup logic
-      return {
-        content: [{ type: "text", text: "Not implemented" }],
-        isError: true,
-      };
-    }
-  );
-} 

package/tools/wallet/a2bPublish.ts

@@ -1,150 +0,0 @@
-import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
-import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
-import { z } from "zod";
-import type { Wallet } from "./wallet";
-import { createOrdinals } from "js-1sat-ord";
-import type { Inscription, Destination, ChangeResult, PreMAP } from "js-1sat-ord";
-import { Utils } from "@bsv/sdk";
-const { toArray, toBase64 } = Utils;
-
-// https://raw.githubusercontent.com/google/A2A/refs/heads/main/specification/json/a2a.json
-
-// A2A AgentCard schema (per A2A spec)
-const AgentCapabilitiesSchema = z.object({
-  streaming: z.boolean().default(false),
-  pushNotifications: z.boolean().default(false),
-  stateTransitionHistory: z.boolean().default(false),
-});
-const AgentSkillSchema = z.object({
-  id: z.string(),
-  name: z.string(),
-  description: z.string().nullable(),
-  tags: z.array(z.string()).nullable(),
-  examples: z.array(z.string()).nullable(),
-  inputModes: z.array(z.string()).nullable(),
-  outputModes: z.array(z.string()).nullable(),
-});
-
-// Provider per A2A spec
-const AgentProviderSchema = z.object({
-  organization: z.string(),
-  url: z.string().url().nullable().default(null),
-}).nullable().default(null);
-
-// Authentication per A2A spec
-const AgentAuthenticationSchema = z.object({
-  schemes: z.array(z.string()),
-  credentials: z.string().nullable().default(null),
-}).nullable().default(null);
-
-export const AgentCardSchema = z.object({
-  name: z.string(),
-  description: z.string().nullable().default(null),
-  url: z.string().url(),
-  provider: AgentProviderSchema,
-  version: z.string(),
-  documentationUrl: z.string().url().nullable().default(null),
-  capabilities: AgentCapabilitiesSchema,
-  authentication: AgentAuthenticationSchema,
-  defaultInputModes: z.array(z.string()).default(["text"]),
-  defaultOutputModes: z.array(z.string()).default(["text"]),
-  skills: z.array(AgentSkillSchema),
-});
-
-// Schema for on-chain agent publish parameters
-export const a2bPublishArgsSchema = z.object({
-  agentUrl: z.string().url().describe("Agent base URL (e.g. https://example.com)"),
-  agentName: z.string().describe("Human-friendly agent name"),
-  description: z.string().nullable().optional().describe("Optional agent description"),
-  providerOrganization: z.string().optional().describe("Optional provider organization name"),
-  providerUrl: z.string().url().optional().describe("Optional provider URL"),
-  version: z.string().optional().describe("Optional agent version"),
-  documentationUrl: z.string().url().nullable().optional().describe("Optional documentation URL"),
-  streaming: z.boolean().default(false).describe("Supports SSE (tasks/sendSubscribe)"),
-  pushNotifications: z.boolean().default(false).describe("Supports push notifications"),
-  stateTransitionHistory: z.boolean().default(false).describe("Supports state transition history"),
-  defaultInputModes: z.array(z.string()).default(["text"]).describe("Default input modes"),
-  defaultOutputModes: z.array(z.string()).default(["text"]).describe("Default output modes"),
-  skills: z.array(AgentSkillSchema).optional().default([]).describe("List of agent skills"),
-  destinationAddress: z.string().optional().describe("Optional target address for inscription"),
-});
-export type A2bPublishArgs = z.infer<typeof a2bPublishArgsSchema>;
-
-/**
- * Registers the wallet_a2bPublish tool for publishing an agent record on-chain
- */
-export function registerA2bPublishTool(server: McpServer, wallet: Wallet) {
-  server.tool(
-    "wallet_a2bPublish",
-    "Publish an agent.json record on-chain via Ordinal inscription",
-    { args: a2bPublishArgsSchema },
-    async (
-      { args }: { args: A2bPublishArgs },
-      extra: RequestHandlerExtra
-    ) => {
-      try {
-        const paymentPk = wallet.getPrivateKey();
-        if (!paymentPk) throw new Error("No private key available");
-        const { paymentUtxos } = await wallet.getUtxos();
-        if (!paymentUtxos?.length) throw new Error("No payment UTXOs available to fund inscription");
-
-        // Assemble AgentCard with defaults and user overrides
-        const agentCard = {
-          name: args.agentName,
-          description: args.description ?? null,
-          url: args.agentUrl,
-          provider:
-            args.providerOrganization && args.providerUrl
-              ? { organization: args.providerOrganization, url: args.providerUrl }
-              : null,
-          version: args.version ?? "1.0.0",
-          documentationUrl: args.documentationUrl ?? null,
-          capabilities: {
-            streaming: args.streaming,
-            pushNotifications: args.pushNotifications,
-            stateTransitionHistory: args.stateTransitionHistory,
-          },
-          authentication: null,
-          defaultInputModes: args.defaultInputModes,
-          defaultOutputModes: args.defaultOutputModes,
-          skills: args.skills,
-        };
-        // Validate compliance
-        AgentCardSchema.parse(agentCard);
-        const fileContent = JSON.stringify(agentCard, null, 2);
-        // Base64 payload for inscription
-        const dataB64 = toBase64(toArray(fileContent));
-        const inscription: Inscription = { dataB64, contentType: "application/json" };
-        // Destination for the ordinal
-        const walletAddress = paymentPk.toAddress().toString();
-        const targetAddress = args.destinationAddress ?? walletAddress;
-        const destinations: Destination[] = [{ address: targetAddress, inscription }];
-        // Default MAP metadata: file path, content type, encoding
-        const metaData: PreMAP = { app: 'bsv-mcp', type: 'agent' };
-
-        // Inscribe the ordinal on-chain via js-1sat-ord
-        const result = await createOrdinals({ utxos: paymentUtxos, destinations, paymentPk, changeAddress: walletAddress, metaData });
-        const changeResult = result as ChangeResult;
-        await changeResult.tx.broadcast();
-        // Refresh UTXOs
-        try { await wallet.refreshUtxos(); } catch {}
-        // Return transaction details
-        return {
-          content: [{
-            type: "text",
-            text: JSON.stringify({
-              txid: changeResult.tx.id("hex"),
-              spentOutpoints: changeResult.spentOutpoints,
-              payChange: changeResult.payChange,
-              inscriptionAddress: targetAddress,
-              agentCard,
-            }),
-          }],
-        };
-      } catch (err: unknown) {
-        const msg = err instanceof Error ? err.message : String(err);
-        return { content: [{ type: "text", text: msg }], isError: true };
-      }
-    }
-  );
-}