nirium-mcp 0.6.2 → 0.6.3

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 (2) hide show
  1. package/README.md +44 -28
  2. package/package.json +3 -2
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # nirium-mcp
2
2
 
3
- Model Context Protocol server for [Nirium](https://nirium.xyz) — exposes market data, autonomous treasury loop control, and x402/MPP paid endpoints to any MCP-compatible AI: Claude, GPT, Cursor, VS Code Copilot, and others.
3
+ Model Context Protocol server for [Nirium](https://nirium.xyz) - exposes market data, autonomous treasury loop control, and x402/MPP paid endpoints to any MCP-compatible AI: Claude, GPT, Cursor, VS Code Copilot, and others.
4
4
 
5
- Software-only. This server never holds funds — paid tools sign per-request payments from a Stellar wallet you control via `STELLAR_SECRET_KEY`.
5
+ Software-only. This server never holds funds - paid tools sign per-request payments from a Stellar wallet you control via `STELLAR_SECRET_KEY`.
6
6
 
7
7
  ## Install
8
8
 
9
- No install needed — run directly with `npx`, or add to your MCP client config.
9
+ No install needed - run directly with `npx`, or add to your MCP client config.
10
10
 
11
11
  ## Claude Desktop config
12
12
 
@@ -26,31 +26,47 @@ No install needed — run directly with `npx`, or add to your MCP client config.
26
26
  }
27
27
  ```
28
28
 
29
- `STELLAR_SECRET_KEY` and `NIRIUM_API_KEY` are optional — omit them and the free tools still work; paid (x402/MPP) and authenticated tools will tell you what's missing instead of failing silently.
29
+ `STELLAR_SECRET_KEY` and `NIRIUM_API_KEY` are optional - omit them and the free tools still work; paid (x402/MPP) and authenticated tools will tell you what's missing instead of failing silently.
30
30
 
31
31
  ## Tools
32
32
 
33
- **Free — no key required**
34
- - `get_market_state` — XLM/USDC price, SDEX spread, base fee, Blend rate, CETES rate
35
- - `get_loop_status` — autonomous loop status, scan count, last AI decision
36
- - `execute_demo` — dry-run a strategy via real Soroban simulation, no funds moved
37
- - `get_wallet_info` — show the configured x402/MPP wallet and enabled tools
38
- - `get_nodes` — list the execution nodes with live status, custody model and network
39
- - `anchor_audit_record` — anchor a hash (or a small JSON record) to IPFS, get back a CID
40
- - `get_reporting_summary` — settled payouts, x402/MPP receipts and anchors for a period
33
+ **Free - no key required**
34
+ - `get_market_state` - XLM/USDC price, SDEX spread, base fee, Blend rate, CETES rate
35
+ - `get_loop_status` - autonomous loop status, scan count, last AI decision
36
+ - `execute_demo` - dry-run a strategy via real Soroban simulation, no funds moved
37
+ - `get_wallet_info` - show the configured x402/MPP wallet and enabled tools
38
+ - `get_nodes` - list the execution nodes with live status, custody model and network
39
+ - `anchor_audit_record` - anchor a hash (or a small JSON record) to IPFS, get back a CID
40
+ - `get_reporting_summary` - settled payouts, x402/MPP receipts and anchors for a period
41
+
42
+ **Authenticated - requires `NIRIUM_API_KEY`**
43
+ - `start_loop` - start the autonomous scanning loop
44
+ - `stop_loop` - stop it
45
+
46
+ **Paid via x402 - requires a funded `STELLAR_SECRET_KEY`**
47
+ - `get_premium_signals` - $0.02 USDC - **testnet only**; signals come from the autonomous loop, which runs on testnet. They reference testnet tokens, which have no monetary value, and are not a recommendation to buy, sell or hold anything. The mainnet box returns 501 without charging.
48
+ - `get_premium_market` - $0.05 USDC - market state with reference rates attributed to their source, fee pressure and network conditions. Factual data, no advice.
49
+ - `execute_paid_strategy` - $0.25 USDC - **testnet only**; execution needs a signing key and the mainnet box holds none by design, so it returns 501 without charging.
50
+
51
+ **Paid via MPP - requires a funded `STELLAR_SECRET_KEY`**
52
+ - `get_mpp_signals` - $0.02 USDC - same data and same testnet-only limit as `get_premium_signals`, settled via direct Soroban SAC transfer with no external facilitator
53
+ - `get_mpp_market` - $0.05 USDC - same as `get_premium_market`, MPP-settled
54
+ **Treasury - requires `NIRIUM_API_KEY`**
55
+
56
+ Reading a DeFindex vault is free. Changing one needs the key, and ten of these eleven tools only build an unsigned XDR; you sign it yourself and broadcast it with `submit_treasury_tx`. Only `execute_treasury_rebalance` signs anything, and it does so with Nirium's own key, invite-only while a specific legal question stays open (see below) - everywhere else, Nirium never holds a key that can move your funds.
57
+
58
+ - `get_treasury_info` - Treasury node metadata: what role Nirium holds on DeFindex vaults, what it can and cannot do, fees, security notes
59
+ - `get_treasury_vault` - Read a DeFindex vault's roles, assets and managed funds. Pass `holder` to also get that account's balance in the vault's asset
60
+ - `get_treasury_vaults` - List DeFindex vaults Nirium has deployed or read, on the current network
61
+ - `get_treasury_strategy_asset` - Read which asset a DeFindex strategy manages, as declared by the strategy itself - pairs it correctly before deploying a vault
62
+ - `deploy_treasury_vault` (builds unsigned XDR) - Build an UNSIGNED XDR to deploy a DeFindex vault. `manager` keeps control (rescue, pause, revoke); Nirium only ever holds `rebalanceManager`, which cannot withdraw or change roles
63
+ - `deposit_to_treasury_vault` (builds unsigned XDR) - Build an UNSIGNED XDR to deposit into a DeFindex vault. Sign with `from` and broadcast it with `submit_treasury_tx`
64
+ - `withdraw_from_treasury_vault` (builds unsigned XDR) - Build an UNSIGNED XDR to withdraw from a DeFindex vault. Omit `shares` to withdraw everything the account holds
65
+ - `set_treasury_rebalance_manager` (builds unsigned XDR) - Build an UNSIGNED XDR handing the RebalanceManager role to a new address. Only the vault's current Manager can sign it - the same door that grants Nirium the role also revokes it
66
+ - `build_treasury_rebalance` (builds unsigned XDR) - Build an UNSIGNED rebalance XDR, Unwind/Invest between a vault's own strategies only; no other instruction is expressible, and none takes a destination address
67
+ - `submit_treasury_tx` - Broadcast a treasury XDR you already signed (deploy/deposit/withdraw/rebalance/set-rebalance-manager) and wait for confirmation
68
+ - `execute_treasury_rebalance` (Nirium signs, invite-only) - Sign and submit a rebalance with Nirium's OWN RebalanceManager key, server-side, and wait for confirmation - the only treasury tool that signs anything itself, and it still cannot withdraw funds. **This is invite-only while a specific legal question stays open**: whether executing on a client's behalf without taking custody still counts as regulated facilitation under Mexican law. Only available where that key actually lives; a receive-only mainnet box returns 501 by design, not a broken 500
41
69
 
42
- **Authenticated — requires `NIRIUM_API_KEY`**
43
- - `start_loop` — start the autonomous scanning loop
44
- - `stop_loop` — stop it
45
-
46
- **Paid via x402 — requires a funded `STELLAR_SECRET_KEY`**
47
- - `get_premium_signals` — $0.02 USDC — **testnet only**; signals come from the autonomous loop, which runs on testnet. They reference testnet tokens, which have no monetary value, and are not a recommendation to buy, sell or hold anything. The mainnet box returns 501 without charging.
48
- - `get_premium_market` — $0.05 USDC — market state with reference rates attributed to their source, fee pressure and network conditions. Factual data, no advice.
49
- - `execute_paid_strategy` — $0.25 USDC — **testnet only**; execution needs a signing key and the mainnet box holds none by design, so it returns 501 without charging.
50
-
51
- **Paid via MPP — requires a funded `STELLAR_SECRET_KEY`**
52
- - `get_mpp_signals` — $0.02 USDC — same data and same testnet-only limit as `get_premium_signals`, settled via direct Soroban SAC transfer with no external facilitator
53
- - `get_mpp_market` — $0.05 USDC — same as `get_premium_market`, MPP-settled
54
70
 
55
71
  ## Environment variables
56
72
 
@@ -64,19 +80,19 @@ No install needed — run directly with `npx`, or add to your MCP client config.
64
80
 
65
81
  ### A note on anchoring
66
82
 
67
- `anchor_audit_record` is an integrity seal — it proves a piece of data existed unchanged at a point in time. It is not notarization and carries no legal presumption of authenticity.
83
+ `anchor_audit_record` is an integrity seal - it proves a piece of data existed unchanged at a point in time. It is not notarization and carries no legal presumption of authenticity.
68
84
 
69
85
  Anchor a **hash** of your data rather than the data itself. IPFS content cannot be deleted, so raw personal data would outlive any erasure request.
70
86
 
71
87
  ## Run from source
72
88
 
73
89
  ```bash
74
- git clone https://github.com/nirium-protocol/nirium-sdk
75
- cd nirium-sdk/packages/mcp
90
+ git clone https://github.com/nirium-protocol/nirium
91
+ cd nirium/packages/mcp
76
92
  npm install
77
93
  STELLAR_SECRET_KEY=S... AGENT_API_URL=http://localhost:3001 npx tsx src/index.ts
78
94
  ```
79
95
 
80
96
  ## License
81
97
 
82
- Apache-2.0 — see [LICENSE](./LICENSE).
98
+ Apache-2.0 - see [LICENSE](https://github.com/nirium-protocol/nirium/blob/main/packages/mcp/LICENSE).
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "nirium-mcp",
3
- "version": "0.6.2",
4
- "description": "Model Context Protocol server for Nirium — exposes market data, autonomous loop control, and x402/MPP paid signals to any MCP-compatible AI (Claude, GPT, Cursor, VS Code Copilot).",
3
+ "version": "0.6.3",
4
+ "description": "Model Context Protocol server for Nirium - exposes market data, autonomous loop control, and x402/MPP paid signals to any MCP-compatible AI (Claude, GPT, Cursor, VS Code Copilot).",
5
5
  "main": "dist/index.js",
6
6
  "bin": {
7
7
  "nirium-mcp": "dist/index.js"
@@ -26,6 +26,7 @@
26
26
  "README.md"
27
27
  ],
28
28
  "scripts": {
29
+ "prepublishOnly": "npm run build",
29
30
  "build": "tsc",
30
31
  "start": "node dist/index.js",
31
32
  "dev": "tsc --watch"