@bitpal/mcp 0.1.0 → 0.1.1

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 +116 -116
  2. package/dist/stdio.js +760 -278
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -1,116 +1,116 @@
1
- # @bitpal/mcp
2
-
3
- MCP server for [BitPal](https://bitpal.io) — non-custodial stablecoin checkout.
4
-
5
- It gives your AI coding tool BitPal's developer docs, the OpenAPI spec, webhook event schemas and error codes, so it writes integrations against the real API instead of guessing. With a **test** API key it can also run a full test payment.
6
-
7
- - **Remote:** `https://mcp.bitpal.io/mcp` (Streamable HTTP). Nothing to install.
8
- - **Local:** `npx -y @bitpal/mcp` (stdio).
9
-
10
- ## Tools
11
-
12
- | Tool | What it does |
13
- |---|---|
14
- | `get_integration_guide` | The rules every integration must follow, plus the docs for one flow: `hosted`, `popup`, `headless`, `payment_link`, `x402`, `webhooks`. |
15
- | `search_docs` | Search the docs and return the best-matching sections. |
16
- | `get_doc` | One docs page as Markdown. |
17
- | `list_api_operations` / `get_api_operation` | REST operations from the OpenAPI spec, with request/response schemas. |
18
- | `get_webhook_event` | A webhook event's payload schema. |
19
- | `get_error_code` | What an API error code means and how to fix it. |
20
- | `create_test_session` *(test key)* | Create a test-mode session and issue its deposit address. |
21
- | `simulate_payment` *(test key)* | Send the buyer's deposit on the testnet: `exact`, `underpay`, `overpay`, `wrong_token`. |
22
- | `get_session_status` *(test key)* | Session status. |
23
- | `list_test_events` *(test key)* | Webhook events exactly as your endpoint receives them. |
24
-
25
- The test-key tools appear only when you provide a `bp_test_…` key. Live keys (`bp_live_…`) are rejected — this server never touches real funds.
26
-
27
- ## Setup
28
-
29
- Replace `bp_test_…` with your test key from Console → Developers → API Keys, or leave the key out to use only the docs tools.
30
-
31
- ### Claude Code
32
-
33
- ```bash
34
- # remote
35
- claude mcp add --transport http bitpal https://mcp.bitpal.io/mcp --header "Authorization: Bearer bp_test_…"
36
- # local
37
- claude mcp add bitpal -e BITPAL_API_KEY=bp_test_… -- npx -y @bitpal/mcp
38
- ```
39
-
40
- ### Cursor — `~/.cursor/mcp.json` (or `.cursor/mcp.json` in the project)
41
-
42
- ```json
43
- {
44
- "mcpServers": {
45
- "bitpal": {
46
- "url": "https://mcp.bitpal.io/mcp",
47
- "headers": { "Authorization": "Bearer bp_test_…" }
48
- }
49
- }
50
- }
51
- ```
52
-
53
- ### VS Code — `.vscode/mcp.json`
54
-
55
- ```json
56
- {
57
- "servers": {
58
- "bitpal": {
59
- "type": "http",
60
- "url": "https://mcp.bitpal.io/mcp",
61
- "headers": { "Authorization": "Bearer bp_test_…" }
62
- }
63
- }
64
- }
65
- ```
66
-
67
- ### Windsurf — `~/.codeium/windsurf/mcp_config.json`
68
-
69
- ```json
70
- {
71
- "mcpServers": {
72
- "bitpal": {
73
- "serverUrl": "https://mcp.bitpal.io/mcp",
74
- "headers": { "Authorization": "Bearer bp_test_…" }
75
- }
76
- }
77
- }
78
- ```
79
-
80
- ### Claude Desktop — `claude_desktop_config.json`
81
-
82
- ```json
83
- {
84
- "mcpServers": {
85
- "bitpal": {
86
- "command": "npx",
87
- "args": ["-y", "@bitpal/mcp"],
88
- "env": { "BITPAL_API_KEY": "bp_test_…" }
89
- }
90
- }
91
- }
92
- ```
93
-
94
- ### Codex CLI — `~/.codex/config.toml`
95
-
96
- ```toml
97
- [mcp_servers.bitpal]
98
- command = "npx"
99
- args = ["-y", "@bitpal/mcp"]
100
- env = { BITPAL_API_KEY = "bp_test_…" }
101
- ```
102
-
103
- ## Environment variables (local)
104
-
105
- | Variable | Default | |
106
- |---|---|---|
107
- | `BITPAL_API_KEY` | — | `bp_test_…` enables the test-mode tools. Live keys are ignored. |
108
- | `BITPAL_API_BASE` | `https://api.bitpal.io` | API base URL. |
109
-
110
- ## Try it
111
-
112
- > Integrate BitPal hosted checkout into my Express app and verify webhooks. Then create a test session, simulate the payment and show me the webhook events.
113
-
114
- ## License
115
-
116
- MIT
1
+ # @bitpal/mcp
2
+
3
+ MCP server for [BitPal](https://bitpal.io) — non-custodial stablecoin checkout.
4
+
5
+ It gives your AI coding tool BitPal's developer docs, the OpenAPI spec, webhook event schemas and error codes, so it writes integrations against the real API instead of guessing. With a **test** API key it can also run a full test payment.
6
+
7
+ - **Remote:** `https://mcp.bitpal.io/mcp` (Streamable HTTP). Nothing to install.
8
+ - **Local:** `npx -y @bitpal/mcp` (stdio).
9
+
10
+ ## Tools
11
+
12
+ | Tool | What it does |
13
+ |---|---|
14
+ | `get_integration_guide` | The rules every integration must follow, plus the docs for one flow: `hosted`, `popup`, `headless`, `payment_link`, `x402`, `webhooks`. |
15
+ | `search_docs` | Search the docs and return the best-matching sections. |
16
+ | `get_doc` | One docs page as Markdown. |
17
+ | `list_api_operations` / `get_api_operation` | REST operations from the OpenAPI spec, with request/response schemas. |
18
+ | `get_webhook_event` | A webhook event's payload schema. |
19
+ | `get_error_code` | What an API error code means and how to fix it. |
20
+ | `create_test_session` *(test key)* | Create a test-mode session and issue its deposit address. |
21
+ | `simulate_payment` *(test key)* | Send the buyer's deposit on the testnet: `exact`, `underpay`, `overpay`, `wrong_token`. |
22
+ | `get_session_status` *(test key)* | Session status. |
23
+ | `list_test_events` *(test key)* | Webhook events exactly as your endpoint receives them. |
24
+
25
+ The test-key tools appear only when you provide a `bp_test_…` key. Live keys (`bp_live_…`) are rejected — this server never touches real funds.
26
+
27
+ ## Setup
28
+
29
+ Replace `bp_test_…` with your test key from Console → Developers → API Keys, or leave the key out to use only the docs tools.
30
+
31
+ ### Claude Code
32
+
33
+ ```bash
34
+ # remote
35
+ claude mcp add --transport http bitpal https://mcp.bitpal.io/mcp --header "Authorization: Bearer bp_test_…"
36
+ # local
37
+ claude mcp add bitpal -e BITPAL_API_KEY=bp_test_… -- npx -y @bitpal/mcp
38
+ ```
39
+
40
+ ### Cursor — `~/.cursor/mcp.json` (or `.cursor/mcp.json` in the project)
41
+
42
+ ```json
43
+ {
44
+ "mcpServers": {
45
+ "bitpal": {
46
+ "url": "https://mcp.bitpal.io/mcp",
47
+ "headers": { "Authorization": "Bearer bp_test_…" }
48
+ }
49
+ }
50
+ }
51
+ ```
52
+
53
+ ### VS Code — `.vscode/mcp.json`
54
+
55
+ ```json
56
+ {
57
+ "servers": {
58
+ "bitpal": {
59
+ "type": "http",
60
+ "url": "https://mcp.bitpal.io/mcp",
61
+ "headers": { "Authorization": "Bearer bp_test_…" }
62
+ }
63
+ }
64
+ }
65
+ ```
66
+
67
+ ### Windsurf — `~/.codeium/windsurf/mcp_config.json`
68
+
69
+ ```json
70
+ {
71
+ "mcpServers": {
72
+ "bitpal": {
73
+ "serverUrl": "https://mcp.bitpal.io/mcp",
74
+ "headers": { "Authorization": "Bearer bp_test_…" }
75
+ }
76
+ }
77
+ }
78
+ ```
79
+
80
+ ### Claude Desktop — `claude_desktop_config.json`
81
+
82
+ ```json
83
+ {
84
+ "mcpServers": {
85
+ "bitpal": {
86
+ "command": "npx",
87
+ "args": ["-y", "@bitpal/mcp"],
88
+ "env": { "BITPAL_API_KEY": "bp_test_…" }
89
+ }
90
+ }
91
+ }
92
+ ```
93
+
94
+ ### Codex CLI — `~/.codex/config.toml`
95
+
96
+ ```toml
97
+ [mcp_servers.bitpal]
98
+ command = "npx"
99
+ args = ["-y", "@bitpal/mcp"]
100
+ env = { BITPAL_API_KEY = "bp_test_…" }
101
+ ```
102
+
103
+ ## Environment variables (local)
104
+
105
+ | Variable | Default | |
106
+ |---|---|---|
107
+ | `BITPAL_API_KEY` | — | `bp_test_…` enables the test-mode tools. Live keys are ignored. |
108
+ | `BITPAL_API_BASE` | `https://api.bitpal.io` | API base URL. |
109
+
110
+ ## Try it
111
+
112
+ > Integrate BitPal hosted checkout into my Express app and verify webhooks. Then create a test session, simulate the payment and show me the webhook events.
113
+
114
+ ## License
115
+
116
+ MIT