bsv-mcp 0.0.6 → 0.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +19 -39
  2. package/package.json +1 -1
  3. package/smithery.yaml +21 -0
package/README.md CHANGED
@@ -14,16 +14,6 @@ To install dependencies:
14
14
  bun install
15
15
  ```
16
16
 
17
- For global installation (recommended for MCP client integration):
18
-
19
- ```bash
20
- # Install globally with bun
21
- bun install -g bsv-mcp
22
-
23
- # Or with npm
24
- npm install -g bsv-mcp
25
- ```
26
-
27
17
  ## External Dependencies
28
18
 
29
19
  For full functionality of all tools, the following additional dependencies are installed:
@@ -38,11 +28,7 @@ js-1sat-ord
38
28
  Start the MCP server:
39
29
 
40
30
  ```bash
41
- # If installed locally
42
31
  bun run index.ts
43
-
44
- # If installed globally
45
- bunx bsv-mcp
46
32
  ```
47
33
 
48
34
  ## Connecting to MCP Clients
@@ -54,7 +40,7 @@ This server implements the [Model Context Protocol](https://modelcontextprotocol
54
40
  To use the BSV MCP server with [Cursor](https://cursor.sh/):
55
41
 
56
42
  1. Install Cursor if you haven't already
57
- 2. Install this package globally: `bun install -g bsv-mcp`
43
+ 2. Clone this repository and run `bun install` in the project directory
58
44
  3. Open Cursor and navigate to Settings → Extensions → Model Context Protocol
59
45
  4. Click "Add a new global MCP server"
60
46
  5. Enter the following configuration in JSON format:
@@ -65,15 +51,17 @@ To use the BSV MCP server with [Cursor](https://cursor.sh/):
65
51
  "command": "env",
66
52
  "args": [
67
53
  "PRIVATE_KEY_WIF=<your_private_key_wif>",
68
- "bunx",
69
- "bsv-mcp"
54
+ "bun",
55
+ "run",
56
+ "<path_to_project>/index.ts"
70
57
  ]
71
58
  }
72
59
  }
73
60
  ```
74
61
 
75
62
  6. Replace `<your_private_key_wif>` with your actual private key WIF (keep this secure!)
76
- 7. Click "Save"
63
+ 7. Replace `<path_to_project>` with the full path to where you cloned this repository
64
+ 8. Click "Save"
77
65
 
78
66
  The BSV tools will now be available to Cursor's AI assistant under the "Bitcoin SV" namespace.
79
67
 
@@ -82,7 +70,7 @@ The BSV tools will now be available to Cursor's AI assistant under the "Bitcoin
82
70
  To connect this server to Claude for Desktop:
83
71
 
84
72
  1. Ensure you have [Claude for Desktop](https://claude.ai/desktop) installed and updated to the latest version
85
- 2. Install this package globally: `bun install -g bsv-mcp`
73
+ 2. Clone this repository and run `bun install` in the project directory
86
74
  3. Open your Claude for Desktop configuration file:
87
75
  ```bash
88
76
  # macOS/Linux
@@ -99,16 +87,18 @@ To connect this server to Claude for Desktop:
99
87
  "command": "env",
100
88
  "args": [
101
89
  "PRIVATE_KEY_WIF=<your_private_key_wif>",
102
- "bunx",
103
- "bsv-mcp"
90
+ "bun",
91
+ "run",
92
+ "<path_to_project>/index.ts"
104
93
  ]
105
94
  }
106
95
  }
107
96
  }
108
97
  ```
109
98
  5. Replace `<your_private_key_wif>` with your actual private key WIF
110
- 6. Save the file and restart Claude for Desktop
111
- 7. The BSV tools will appear when you click the tools icon (hammer) in Claude for Desktop
99
+ 6. Replace `<path_to_project>` with the full path to where you cloned this repository
100
+ 7. Save the file and restart Claude for Desktop
101
+ 8. The BSV tools will appear when you click the tools icon (hammer) in Claude for Desktop
112
102
 
113
103
  ### Generic MCP Client Integration
114
104
 
@@ -120,8 +110,9 @@ For other MCP clients that support JSON configuration:
120
110
  "command": "env",
121
111
  "args": [
122
112
  "PRIVATE_KEY_WIF=<your_private_key_wif>",
123
- "bunx",
124
- "bsv-mcp"
113
+ "bun",
114
+ "run",
115
+ "<path_to_project>/index.ts"
125
116
  ]
126
117
  }
127
118
  }
@@ -134,7 +125,7 @@ If running the server directly:
134
125
  export PRIVATE_KEY_WIF=<your_private_key_wif>
135
126
 
136
127
  # Then run the server
137
- bunx bsv-mcp
128
+ bun run index.ts
138
129
  ```
139
130
 
140
131
  ## Available Tools
@@ -225,7 +216,7 @@ When you interact with an MCP-enabled AI assistant:
225
216
 
226
217
  If you're having issues connecting to the server:
227
218
 
228
- 1. Ensure the package is properly installed: `bun install -g bsv-mcp`
219
+ 1. Ensure the package dependencies are properly installed: `bun install`
229
220
  2. Verify your WIF private key is correctly set in the environment
230
221
  3. Check that your client supports MCP and is properly configured
231
222
  4. Look for error messages in the client's console output
@@ -254,18 +245,7 @@ This project was created using `bun init` in bun v1.2.9. [Bun](https://bun.sh) i
254
245
 
255
246
  ### Package Configuration
256
247
 
257
- To ensure the package can be run with `bunx bsv-mcp`, make sure your `package.json` includes:
258
-
259
- ```json
260
- {
261
- "name": "bsv-mcp",
262
- "bin": {
263
- "bsv-mcp": "./index.ts"
264
- },
265
- "type": "module"
266
- // ...other configuration
267
- }
268
- ```
248
+ The main entry point for this package is `index.ts`.
269
249
 
270
250
  ### Running Tests
271
251
 
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "bsv-mcp",
3
3
  "module": "index.ts",
4
4
  "type": "module",
5
- "version": "0.0.6",
5
+ "version": "0.0.7",
6
6
  "bin": {
7
7
  "bsv-mcp": "./index.ts"
8
8
  },
package/smithery.yaml ADDED
@@ -0,0 +1,21 @@
1
+ startCommand:
2
+ type: stdio
3
+ configSchema:
4
+ type: object
5
+ required:
6
+ - privateKeyWif
7
+ properties:
8
+ privateKeyWif:
9
+ type: string
10
+ description: "Your private key WIF (Wallet Import Format) for Bitcoin SV transactions. This key is used to sign transactions and is required for wallet operations."
11
+ commandFunction: |
12
+ (config) => ({
13
+ "command": "bun",
14
+ "args": [
15
+ "run",
16
+ "index.ts"
17
+ ],
18
+ "env": {
19
+ "PRIVATE_KEY_WIF": config.privateKeyWif
20
+ }
21
+ })