nirium-mcp 0.6.5 → 0.6.6

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 (4) hide show
  1. package/LICENSE +190 -190
  2. package/README.md +103 -103
  3. package/dist/index.js +4 -4
  4. package/package.json +66 -66
package/LICENSE CHANGED
@@ -1,190 +1,190 @@
1
- Apache License
2
- Version 2.0, January 2004
3
- http://www.apache.org/licenses/
4
-
5
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
-
7
- 1. Definitions.
8
-
9
- "License" shall mean the terms and conditions for use, reproduction,
10
- and distribution as defined by Sections 1 through 9 of this document.
11
-
12
- "Licensor" shall mean the copyright owner or entity authorized by
13
- the copyright owner that is granting the License.
14
-
15
- "Legal Entity" shall mean the union of the acting entity and all
16
- other entities that control, are controlled by, or are under common
17
- control with that entity. For the purposes of this definition,
18
- "control" means (i) the power, direct or indirect, to cause the
19
- direction or management of such entity, whether by contract or
20
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
- outstanding shares, or (iii) beneficial ownership of such entity.
22
-
23
- "You" (or "Your") shall mean an individual or Legal Entity
24
- exercising permissions granted by this License.
25
-
26
- "Source" form shall mean the preferred form for making modifications,
27
- including but not limited to software source code, documentation
28
- source, and configuration files.
29
-
30
- "Object" form shall mean any form resulting from mechanical
31
- transformation or translation of a Source form, including but
32
- not limited to compiled object code, generated documentation,
33
- and conversions to other media types.
34
-
35
- "Work" shall mean the work of authorship, whether in Source or
36
- Object form, made available under the License, as indicated by a
37
- copyright notice that is included in or attached to the work
38
- (an example is provided in the Appendix below).
39
-
40
- "Derivative Works" shall mean any work, whether in Source or Object
41
- form, that is based on (or derived from) the Work and for which the
42
- editorial revisions, annotations, elaborations, or other modifications
43
- represent, as a whole, an original work of authorship. For the purposes
44
- of this License, Derivative Works shall not include works that remain
45
- separable from, or merely link (or bind by name) to the interfaces of,
46
- the Work and Derivative Works thereof.
47
-
48
- "Contribution" shall mean any work of authorship, including
49
- the original version of the Work and any modifications or additions
50
- to that Work or Derivative Works thereof, that is intentionally
51
- submitted to Licensor for inclusion in the Work by the copyright owner
52
- or by an individual or Legal Entity authorized to submit on behalf of
53
- the copyright owner. For the purposes of this definition, "submitted"
54
- means any form of electronic, verbal, or written communication sent
55
- to the Licensor or its representatives, including but not limited to
56
- communication on electronic mailing lists, source code control systems,
57
- and issue tracking systems that are managed by, or on behalf of, the
58
- Licensor for the purpose of discussing and improving the Work, but
59
- excluding communication that is conspicuously marked or otherwise
60
- designated in writing by the copyright owner as "Not a Contribution."
61
-
62
- "Contributor" shall mean Licensor and any individual or Legal Entity
63
- on behalf of whom a Contribution has been received by Licensor and
64
- subsequently incorporated within the Work.
65
-
66
- 2. Grant of Copyright License. Subject to the terms and conditions of
67
- this License, each Contributor hereby grants to You a perpetual,
68
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
- copyright license to reproduce, prepare Derivative Works of,
70
- publicly display, publicly perform, sublicense, and distribute the
71
- Work and such Derivative Works in Source or Object form.
72
-
73
- 3. Grant of Patent License. Subject to the terms and conditions of
74
- this License, each Contributor hereby grants to You a perpetual,
75
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
- (except as stated in this section) patent license to make, have made,
77
- use, offer to sell, sell, import, and otherwise transfer the Work,
78
- where such license applies only to those patent claims licensable
79
- by such Contributor that are necessarily infringed by their
80
- Contribution(s) alone or by combination of their Contribution(s)
81
- with the Work to which such Contribution(s) was submitted. If You
82
- institute patent litigation against any entity (including a
83
- cross-claim or counterclaim in a lawsuit) alleging that the Work
84
- or a Contribution incorporated within the Work constitutes direct
85
- or contributory patent infringement, then any patent licenses
86
- granted to You under this License for that Work shall terminate
87
- as of the date such litigation is filed.
88
-
89
- 4. Redistribution. You may reproduce and distribute copies of the
90
- Work or Derivative Works thereof in any medium, with or without
91
- modifications, and in Source or Object form, provided that You
92
- meet the following conditions:
93
-
94
- (a) You must give any other recipients of the Work or
95
- Derivative Works a copy of this License; and
96
-
97
- (b) You must cause any modified files to carry prominent notices
98
- stating that You changed the files; and
99
-
100
- (c) You must retain, in the Source form of any Derivative Works
101
- that You distribute, all copyright, patent, trademark, and
102
- attribution notices from the Source form of the Work,
103
- excluding those notices that do not pertain to any part of
104
- the Derivative Works; and
105
-
106
- (d) If the Work includes a "NOTICE" text file as part of its
107
- distribution, then any Derivative Works that You distribute must
108
- include a readable copy of the attribution notices contained
109
- within such NOTICE file, excluding those notices that do not
110
- pertain to any part of the Derivative Works, in at least one
111
- of the following places: within a NOTICE text file distributed
112
- as part of the Derivative Works; within the Source form or
113
- documentation, if provided along with the Derivative Works; or,
114
- within a display generated by the Derivative Works, if and
115
- wherever such third-party notices normally appear. The contents
116
- of the NOTICE file are for informational purposes only and
117
- do not modify the License. You may add Your own attribution
118
- notices within Derivative Works that You distribute, alongside
119
- or as an addendum to the NOTICE text from the Work, provided
120
- that such additional attribution notices cannot be construed
121
- as modifying the License.
122
-
123
- You may add Your own copyright statement to Your modifications and
124
- may provide additional or different license terms and conditions
125
- for use, reproduction, or distribution of Your modifications, or
126
- for any such Derivative Works as a whole, provided Your use,
127
- reproduction, and distribution of the Work otherwise complies with
128
- the conditions stated in this License.
129
-
130
- 5. Submission of Contributions. Unless You explicitly state otherwise,
131
- any Contribution intentionally submitted for inclusion in the Work
132
- by You to the Licensor shall be under the terms and conditions of
133
- this License, without any additional terms or conditions.
134
- Notwithstanding the above, nothing herein shall supersede or modify
135
- the terms of any separate license agreement you may have executed
136
- with Licensor regarding such Contributions.
137
-
138
- 6. Trademarks. This License does not grant permission to use the trade
139
- names, trademarks, service marks, or product names of the Licensor,
140
- except as required for reasonable and customary use in describing the
141
- origin of the Work and reproducing the content of the NOTICE file.
142
-
143
- 7. Disclaimer of Warranty. Unless required by applicable law or
144
- agreed to in writing, Licensor provides the Work (and each
145
- Contributor provides its Contributions) on an "AS IS" BASIS,
146
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
- implied, including, without limitation, any warranties or conditions
148
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
- PARTICULAR PURPOSE. You are solely responsible for determining the
150
- appropriateness of using or redistributing the Work and assume any
151
- risks associated with Your exercise of permissions under this License.
152
-
153
- 8. Limitation of Liability. In no event and under no legal theory,
154
- whether in tort (including negligence), contract, or otherwise,
155
- unless required by applicable law (such as deliberate and grossly
156
- negligent acts) or agreed to in writing, shall any Contributor be
157
- liable to You for damages, including any direct, indirect, special,
158
- incidental, or consequential damages of any character arising as a
159
- result of this License or out of the use or inability to use the
160
- Work (including but not limited to damages for loss of goodwill,
161
- work stoppage, computer failure or malfunction, or any and all
162
- other commercial damages or losses), even if such Contributor
163
- has been advised of the possibility of such damages.
164
-
165
- 9. Accepting Warranty or Additional Liability. While redistributing
166
- the Work or Derivative Works thereof, You may choose to offer,
167
- and charge a fee for, acceptance of support, warranty, indemnity,
168
- or other liability obligations and/or rights consistent with this
169
- License. However, in accepting such obligations, You may act only
170
- on Your own behalf and on Your sole responsibility, not on behalf
171
- of any other Contributor, and only if You agree to indemnify,
172
- defend, and hold each Contributor harmless for any liability
173
- incurred by, or claims asserted against, such Contributor by reason
174
- of your accepting any such warranty or additional liability.
175
-
176
- END OF TERMS AND CONDITIONS
177
-
178
- Copyright 2026 Nirium Protocol Contributors
179
-
180
- Licensed under the Apache License, Version 2.0 (the "License");
181
- you may not use this file except in compliance with the License.
182
- You may obtain a copy of the License at
183
-
184
- http://www.apache.org/licenses/LICENSE-2.0
185
-
186
- Unless required by applicable law or agreed to in writing, software
187
- distributed under the License is distributed on an "AS IS" BASIS,
188
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
- See the License for the specific language governing permissions and
190
- limitations under the License.
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ Copyright 2026 Nirium Protocol Contributors
179
+
180
+ Licensed under the Apache License, Version 2.0 (the "License");
181
+ you may not use this file except in compliance with the License.
182
+ You may obtain a copy of the License at
183
+
184
+ http://www.apache.org/licenses/LICENSE-2.0
185
+
186
+ Unless required by applicable law or agreed to in writing, software
187
+ distributed under the License is distributed on an "AS IS" BASIS,
188
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
+ See the License for the specific language governing permissions and
190
+ limitations under the License.
package/README.md CHANGED
@@ -1,103 +1,103 @@
1
- # nirium-mcp
2
-
3
- Model Context Protocol server for [Nirium](https://nirium.xyz) - lets any MCP-compatible AI (Claude, GPT, Cursor, VS Code Copilot, and others) anchor verifiable receipts to IPFS with Audit Trail, pay x402 endpoints (MPP tools are experimental), read market data and control the treasury loop.
4
-
5
- Every receipt the `anchor_audit_record` tool returns can be re-checked by anyone with `npx nirium-cli verify <cid>` or at [nirium.xyz/verify](https://nirium.xyz/verify).
6
-
7
- Software-only. This server never holds funds - paid tools sign per-request payments from a Stellar wallet you control via `STELLAR_SECRET_KEY`.
8
-
9
- ## Install
10
-
11
- No install needed - run directly with `npx`, or add to your MCP client config.
12
-
13
- ## Claude Desktop config
14
-
15
- ```json
16
- {
17
- "mcpServers": {
18
- "nirium": {
19
- "command": "npx",
20
- "args": ["-y", "nirium-mcp"],
21
- "env": {
22
- "AGENT_API_URL": "https://nirium-agent.fly.dev",
23
- "STELLAR_SECRET_KEY": "S...",
24
- "NIRIUM_API_KEY": "sk_free_..."
25
- }
26
- }
27
- }
28
- }
29
- ```
30
-
31
- `STELLAR_SECRET_KEY` and `NIRIUM_API_KEY` are optional - omit them and the free tools still work; paid x402 (MPP experimental) and authenticated tools will tell you what's missing instead of failing silently.
32
-
33
- ## Tools
34
-
35
- **Free - no key required**
36
- - `get_market_state` - XLM/USDC price, SDEX spread, base fee, Blend rate, CETES rate
37
- - `get_loop_status` - autonomous loop status, scan count, last AI decision
38
- - `execute_demo` - dry-run a strategy via real Soroban simulation, no funds moved
39
- - `get_wallet_info` - show the configured x402 (MPP experimental) wallet and enabled tools
40
- - `get_nodes` - list the execution nodes with live status, custody model and network
41
- - `anchor_audit_record` - anchor a hash (or a small JSON record) to IPFS, get back a CID
42
- - `get_reporting_summary` - settled payouts, x402 receipts and anchors for a period
43
-
44
- **Authenticated - requires `NIRIUM_API_KEY`**
45
- - `start_loop` - start the autonomous scanning loop
46
- - `stop_loop` - stop it
47
-
48
- **Paid via x402 - requires a funded `STELLAR_SECRET_KEY`**
49
- - `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.
50
- - `get_premium_market` - $0.05 USDC - market state with reference rates attributed to their source, fee pressure and network conditions. Factual data, no advice.
51
- - `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.
52
-
53
- **Paid via MPP - requires a funded `STELLAR_SECRET_KEY`**
54
- - `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
55
- - `get_mpp_market` - $0.05 USDC - same as `get_premium_market`, MPP-settled
56
-
57
- **Treasury - requires `NIRIUM_API_KEY`**
58
-
59
- 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.
60
-
61
- - `get_treasury_info` - Treasury node metadata: what role Nirium holds on DeFindex vaults, what it can and cannot do, fees, security notes
62
- - `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
63
- - `get_treasury_vaults` - List DeFindex vaults Nirium has deployed or read, on the current network
64
- - `get_treasury_strategy_asset` - Read which asset a DeFindex strategy manages, as declared by the strategy itself - pairs it correctly before deploying a vault
65
- - `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
66
- - `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`
67
- - `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
68
- - `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
69
- - `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
70
- - `submit_treasury_tx` - Broadcast a treasury XDR you already signed (deploy/deposit/withdraw/rebalance/set-rebalance-manager) and wait for confirmation
71
- - `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
72
-
73
-
74
- ## Environment variables
75
-
76
- | Variable | Required | Purpose |
77
- |---|---|---|
78
- | `AGENT_API_URL` | No (defaults to `http://127.0.0.1:3002`) | Nirium agent API base URL |
79
- | `STELLAR_SECRET_KEY` | For paid tools | Funds x402 and MPP payments |
80
- | `NIRIUM_API_KEY` | For `start_loop`/`stop_loop` | Agent API key from [nirium.xyz/keys](https://nirium.xyz/keys) |
81
- | `STELLAR_NETWORK` | No (defaults to `testnet`) | `testnet` or `mainnet` |
82
- | `SOROBAN_RPC_URL` | **Yes on mainnet** | Soroban RPC endpoint. Testnet falls back to the public one; mainnet has no open public RPC, so paid tools stay disabled until you set this. [Providers](https://developers.stellar.org/docs/data/apis/rpc/providers) |
83
-
84
- ### A note on anchoring
85
-
86
- `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.
87
-
88
- 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.
89
-
90
- ## Run from source
91
-
92
- ```bash
93
- git clone https://github.com/nirium-protocol/nirium
94
- cd nirium/packages/mcp
95
- npm install
96
- STELLAR_SECRET_KEY=S... AGENT_API_URL=http://localhost:3002 npx tsx src/index.ts
97
- ```
98
-
99
- `viem` is a required (non-optional) peer dependency of `mppx`, which this package depends on - it's listed here as a direct dependency so a plain `npm install` resolves it without an extra manual `npm i viem` step.
100
-
101
- ## License
102
-
103
- Apache-2.0 - see [LICENSE](https://github.com/nirium-protocol/nirium/blob/main/packages/mcp/LICENSE).
1
+ # nirium-mcp
2
+
3
+ Model Context Protocol server for [Nirium](https://nirium.xyz) - lets any MCP-compatible AI (Claude, GPT, Cursor, VS Code Copilot, and others) anchor verifiable receipts to IPFS with Audit Trail, pay x402 endpoints (MPP tools are experimental), read market data and control the treasury loop.
4
+
5
+ Every receipt the `anchor_audit_record` tool returns can be re-checked by anyone with `npx nirium-cli verify <cid>` or at [nirium.xyz/verify](https://nirium.xyz/verify).
6
+
7
+ Software-only. This server never holds funds - paid tools sign per-request payments from a Stellar wallet you control via `STELLAR_SECRET_KEY`.
8
+
9
+ ## Install
10
+
11
+ No install needed - run directly with `npx`, or add to your MCP client config.
12
+
13
+ ## Claude Desktop config
14
+
15
+ ```json
16
+ {
17
+ "mcpServers": {
18
+ "nirium": {
19
+ "command": "npx",
20
+ "args": ["-y", "nirium-mcp"],
21
+ "env": {
22
+ "AGENT_API_URL": "https://nirium-agent.fly.dev",
23
+ "STELLAR_SECRET_KEY": "S...",
24
+ "NIRIUM_API_KEY": "sk_free_..."
25
+ }
26
+ }
27
+ }
28
+ }
29
+ ```
30
+
31
+ `STELLAR_SECRET_KEY` and `NIRIUM_API_KEY` are optional - omit them and the free tools still work; paid x402 (MPP experimental) and authenticated tools will tell you what's missing instead of failing silently.
32
+
33
+ ## Tools
34
+
35
+ **Free - no key required**
36
+ - `get_market_state` - XLM/USDC price, SDEX spread, base fee, Blend rate, CETES rate
37
+ - `get_loop_status` - autonomous loop status, scan count, last AI decision
38
+ - `execute_demo` - dry-run a strategy via real Soroban simulation, no funds moved
39
+ - `get_wallet_info` - show the configured x402 (MPP experimental) wallet and enabled tools
40
+ - `get_nodes` - list the execution nodes with live status, custody model and network
41
+ - `anchor_audit_record` - anchor a hash (or a small JSON record) to IPFS, get back a CID
42
+ - `get_reporting_summary` - settled payouts, x402 receipts and anchors for a period
43
+
44
+ **Authenticated - requires `NIRIUM_API_KEY`**
45
+ - `start_loop` - start the autonomous scanning loop
46
+ - `stop_loop` - stop it
47
+
48
+ **Paid via x402 - requires a funded `STELLAR_SECRET_KEY`**
49
+ - `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.
50
+ - `get_premium_market` - $0.05 USDC - market state with reference rates attributed to their source, fee pressure and network conditions. Factual data, no advice.
51
+ - `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.
52
+
53
+ **Paid via MPP - requires a funded `STELLAR_SECRET_KEY`**
54
+ - `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
55
+ - `get_mpp_market` - $0.05 USDC - same as `get_premium_market`, MPP-settled
56
+
57
+ **Treasury - requires `NIRIUM_API_KEY`**
58
+
59
+ 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.
60
+
61
+ - `get_treasury_info` - Treasury node metadata: what role Nirium holds on DeFindex vaults, what it can and cannot do, fees, security notes
62
+ - `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
63
+ - `get_treasury_vaults` - List DeFindex vaults Nirium has deployed or read, on the current network
64
+ - `get_treasury_strategy_asset` - Read which asset a DeFindex strategy manages, as declared by the strategy itself - pairs it correctly before deploying a vault
65
+ - `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. On mainnet: invite-only (institutional key).
66
+ - `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`. On mainnet: invite-only (institutional key).
67
+ - `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
68
+ - `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. On mainnet: invite-only (institutional key).
69
+ - `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. On mainnet: invite-only (institutional key).
70
+ - `submit_treasury_tx` - Broadcast a treasury XDR you already signed (deploy/deposit/withdraw/rebalance/set-rebalance-manager) and wait for confirmation
71
+ - `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
72
+
73
+
74
+ ## Environment variables
75
+
76
+ | Variable | Required | Purpose |
77
+ |---|---|---|
78
+ | `AGENT_API_URL` | No (defaults to `http://127.0.0.1:3002`) | Nirium agent API base URL |
79
+ | `STELLAR_SECRET_KEY` | For paid tools | Funds x402 and MPP payments |
80
+ | `NIRIUM_API_KEY` | For `start_loop`/`stop_loop` | Agent API key from [nirium.xyz/keys](https://nirium.xyz/keys) |
81
+ | `STELLAR_NETWORK` | No (defaults to `testnet`) | `testnet` or `mainnet` |
82
+ | `SOROBAN_RPC_URL` | **Yes on mainnet** | Soroban RPC endpoint. Testnet falls back to the public one; mainnet has no open public RPC, so paid tools stay disabled until you set this. [Providers](https://developers.stellar.org/docs/data/apis/rpc/providers) |
83
+
84
+ ### A note on anchoring
85
+
86
+ `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.
87
+
88
+ 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.
89
+
90
+ ## Run from source
91
+
92
+ ```bash
93
+ git clone https://github.com/nirium-protocol/nirium
94
+ cd nirium/packages/mcp
95
+ npm install
96
+ STELLAR_SECRET_KEY=S... AGENT_API_URL=http://localhost:3002 npx tsx src/index.ts
97
+ ```
98
+
99
+ `viem` is a required (non-optional) peer dependency of `mppx`, which this package depends on - it's listed here as a direct dependency so a plain `npm install` resolves it without an extra manual `npm i viem` step.
100
+
101
+ ## License
102
+
103
+ Apache-2.0 - see [LICENSE](https://github.com/nirium-protocol/nirium/blob/main/packages/mcp/LICENSE).
package/dist/index.js CHANGED
@@ -319,7 +319,7 @@ server.tool('get_treasury_vaults', 'List DeFindex vaults Nirium has deployed or
319
319
  server.tool('get_treasury_strategy_asset', 'Read which asset a DeFindex strategy manages, as declared by the strategy itself — pairs it correctly before deploying a vault. Free.', {
320
320
  strategyId: zod_1.z.string().describe('Strategy contract id (C...)'),
321
321
  }, async (args) => callJson(`${API_URL}/api/treasury/strategy/${args.strategyId}`));
322
- server.tool('deploy_treasury_vault', "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. Sign the returned XDR with `caller` and broadcast it with submit_treasury_tx. Requires NIRIUM_API_KEY env var.", {
322
+ server.tool('deploy_treasury_vault', "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. Sign the returned XDR with `caller` and broadcast it with submit_treasury_tx. Requires NIRIUM_API_KEY env var. On mainnet this is invite-only (institutional key); a free key gets a 403. Open on testnet.", {
323
323
  manager: zod_1.z.string().describe('Stellar account (G...) that owns and controls the vault'),
324
324
  caller: zod_1.z.string().describe('Stellar account (G...) that pays to deploy and signs the returned XDR'),
325
325
  assets: zod_1.z.array(zod_1.z.object({
@@ -339,7 +339,7 @@ server.tool('deploy_treasury_vault', "Build an UNSIGNED XDR to deploy a DeFindex
339
339
  headers: { 'Content-Type': 'application/json', ...authHeaders() },
340
340
  body: JSON.stringify(args),
341
341
  }));
342
- server.tool('deposit_to_treasury_vault', 'Build an UNSIGNED XDR to deposit into a DeFindex vault. Sign with `from` and broadcast it with submit_treasury_tx. Requires NIRIUM_API_KEY env var.', {
342
+ server.tool('deposit_to_treasury_vault', 'Build an UNSIGNED XDR to deposit into a DeFindex vault. Sign with `from` and broadcast it with submit_treasury_tx. Requires NIRIUM_API_KEY env var. On mainnet this is invite-only (institutional key); a free key gets a 403. Open on testnet.', {
343
343
  vault: zod_1.z.string().describe('Vault contract id (C...)'),
344
344
  from: zod_1.z.string().describe('Stellar account (G...) funding the deposit and signing the returned XDR'),
345
345
  amounts: zod_1.z.array(zod_1.z.string()).min(1).describe('One amount per vault asset, in stroops, as strings — an i128 does not survive a JSON number'),
@@ -360,7 +360,7 @@ server.tool('withdraw_from_treasury_vault', 'Build an UNSIGNED XDR to withdraw f
360
360
  headers: { 'Content-Type': 'application/json', ...authHeaders() },
361
361
  body: JSON.stringify(args),
362
362
  }));
363
- server.tool('set_treasury_rebalance_manager', "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. Requires NIRIUM_API_KEY env var.", {
363
+ server.tool('set_treasury_rebalance_manager', "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. Requires NIRIUM_API_KEY env var. On mainnet this is invite-only (institutional key); a free key gets a 403. Open on testnet.", {
364
364
  vault: zod_1.z.string().describe('Vault contract id (C...)'),
365
365
  manager: zod_1.z.string().describe("The vault's current Manager (G...), who must sign the returned XDR"),
366
366
  rebalanceManager: zod_1.z.string().describe('The new RebalanceManager address (G...)'),
@@ -374,7 +374,7 @@ const treasuryInstruction = zod_1.z.object({
374
374
  strategy: zod_1.z.string().describe('Strategy contract id (C...)'),
375
375
  amount: zod_1.z.string().describe('Stroops, as a string — an i128 does not survive a JSON number'),
376
376
  });
377
- server.tool('build_treasury_rebalance', "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. Sign with the vault's RebalanceManager and broadcast it with submit_treasury_tx. Requires NIRIUM_API_KEY env var.", {
377
+ server.tool('build_treasury_rebalance', "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. Sign with the vault's RebalanceManager and broadcast it with submit_treasury_tx. Requires NIRIUM_API_KEY env var. On mainnet this is invite-only (institutional key); a free key gets a 403. Open on testnet.", {
378
378
  vault: zod_1.z.string().describe('Vault contract id (C...)'),
379
379
  instructions: zod_1.z.array(treasuryInstruction).min(1),
380
380
  caller: zod_1.z.string().optional().describe("Defaults to Nirium's configured rebalanceManager address"),
package/package.json CHANGED
@@ -1,66 +1,66 @@
1
- {
2
- "name": "nirium-mcp",
3
- "version": "0.6.5",
4
- "description": "Model Context Protocol server for Nirium - exposes market data, autonomous loop control, and x402 paid signals (MPP tools are experimental) to any MCP-compatible AI (Claude, GPT, Cursor, VS Code Copilot).",
5
- "main": "dist/index.js",
6
- "bin": {
7
- "nirium-mcp": "dist/index.js"
8
- },
9
- "homepage": "https://nirium.xyz",
10
- "repository": {
11
- "type": "git",
12
- "url": "git+https://github.com/nirium-protocol/nirium.git",
13
- "directory": "packages/mcp"
14
- },
15
- "bugs": {
16
- "url": "https://github.com/nirium-protocol/nirium/issues",
17
- "email": "niriumprotocol@gmail.com"
18
- },
19
- "author": {
20
- "name": "Nirium Protocol",
21
- "email": "niriumprotocol@gmail.com",
22
- "url": "https://nirium.xyz"
23
- },
24
- "files": [
25
- "dist",
26
- "README.md"
27
- ],
28
- "scripts": {
29
- "prepublishOnly": "npm run build",
30
- "build": "tsc",
31
- "start": "node dist/index.js",
32
- "dev": "tsc --watch"
33
- },
34
- "dependencies": {
35
- "@modelcontextprotocol/sdk": "^1.27.1",
36
- "@stellar/mpp": "^0.7.1",
37
- "@stellar/stellar-sdk": "^16.3.0",
38
- "@x402/core": "^2.29.0",
39
- "@x402/fetch": "^2.29.0",
40
- "@x402/stellar": "^2.29.0",
41
- "mppx": "^0.6.31",
42
- "viem": "^2.57.16",
43
- "zod": "^3.25.0"
44
- },
45
- "devDependencies": {
46
- "@types/node": "^25.9.9",
47
- "tsx": "^4.19.0",
48
- "typescript": "^5.7.0"
49
- },
50
- "keywords": [
51
- "nirium",
52
- "mcp",
53
- "model-context-protocol",
54
- "stellar",
55
- "soroban",
56
- "agent",
57
- "autonomous",
58
- "treasury",
59
- "x402",
60
- "mpp",
61
- "agentic-payments",
62
- "claude",
63
- "llm-tools"
64
- ],
65
- "license": "Apache-2.0"
66
- }
1
+ {
2
+ "name": "nirium-mcp",
3
+ "version": "0.6.6",
4
+ "description": "Model Context Protocol server for Nirium - exposes market data, autonomous loop control, and x402 paid signals (MPP tools are experimental) to any MCP-compatible AI (Claude, GPT, Cursor, VS Code Copilot).",
5
+ "main": "dist/index.js",
6
+ "bin": {
7
+ "nirium-mcp": "dist/index.js"
8
+ },
9
+ "homepage": "https://nirium.xyz",
10
+ "repository": {
11
+ "type": "git",
12
+ "url": "git+https://github.com/nirium-protocol/nirium.git",
13
+ "directory": "packages/mcp"
14
+ },
15
+ "bugs": {
16
+ "url": "https://github.com/nirium-protocol/nirium/issues",
17
+ "email": "niriumprotocol@gmail.com"
18
+ },
19
+ "author": {
20
+ "name": "Nirium Protocol",
21
+ "email": "niriumprotocol@gmail.com",
22
+ "url": "https://nirium.xyz"
23
+ },
24
+ "files": [
25
+ "dist",
26
+ "README.md"
27
+ ],
28
+ "scripts": {
29
+ "prepublishOnly": "npm run build",
30
+ "build": "tsc",
31
+ "start": "node dist/index.js",
32
+ "dev": "tsc --watch"
33
+ },
34
+ "dependencies": {
35
+ "@modelcontextprotocol/sdk": "^1.27.1",
36
+ "@stellar/mpp": "^0.7.1",
37
+ "@stellar/stellar-sdk": "^16.3.0",
38
+ "@x402/core": "^2.29.0",
39
+ "@x402/fetch": "^2.29.0",
40
+ "@x402/stellar": "^2.29.0",
41
+ "mppx": "^0.6.31",
42
+ "viem": "^2.57.16",
43
+ "zod": "^3.25.0"
44
+ },
45
+ "devDependencies": {
46
+ "@types/node": "^25.9.9",
47
+ "tsx": "^4.19.0",
48
+ "typescript": "^5.7.0"
49
+ },
50
+ "keywords": [
51
+ "nirium",
52
+ "mcp",
53
+ "model-context-protocol",
54
+ "stellar",
55
+ "soroban",
56
+ "agent",
57
+ "autonomous",
58
+ "treasury",
59
+ "x402",
60
+ "mpp",
61
+ "agentic-payments",
62
+ "claude",
63
+ "llm-tools"
64
+ ],
65
+ "license": "Apache-2.0"
66
+ }