@buildaureon/mcp 0.1.8 → 0.1.9
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.
- package/CHANGELOG.md +62 -0
- package/README.md +402 -401
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/docs/agent-guide.md +652 -652
- package/docs/architecture.md +377 -377
- package/docs/auth.md +351 -351
- package/docs/security.md +335 -335
- package/docs/setup.md +347 -347
- package/docs/tools.md +765 -765
- package/examples/claude-desktop.json +11 -11
- package/examples/cursor.mcp.json +11 -11
- package/package.json +3 -2
package/docs/tools.md
CHANGED
|
@@ -1,765 +1,765 @@
|
|
|
1
|
-
# AUREON MCP Tool Reference
|
|
2
|
-
|
|
3
|
-
Complete reference for every tool exposed by `@buildaureon/mcp`.
|
|
4
|
-
|
|
5
|
-
Each tool maps to one public method on the `@buildaureon/sdk` client. Handlers validate arguments, call the live AUREON API, and return pretty-printed JSON (or an agent-readable error envelope).
|
|
6
|
-
|
|
7
|
-
For request/response shapes, error codes, and HTTP contracts, see the **@buildaureon/sdk documentation**.
|
|
8
|
-
|
|
9
|
-
**Tool count:**
|
|
10
|
-
|
|
11
|
-
**API:** default
|
|
12
|
-
|
|
13
|
-
---
|
|
14
|
-
|
|
15
|
-
## Conventions
|
|
16
|
-
|
|
17
|
-
These conventions apply to every tool below.
|
|
18
|
-
|
|
19
|
-
| Convention | Meaning |
|
|
20
|
-
| --- | --- |
|
|
21
|
-
| Issued API key | Set `AUREON_API_KEY` to an issued Developers key. That key is product access **and** wallet identity for control-plane calls. |
|
|
22
|
-
| Optional Bearer | You may also supply a wallet Bearer (`AUREON_AUTH_TOKEN` or `aureon_verify_wallet`). If both key and Bearer are present, Bearer wins. |
|
|
23
|
-
| Default network |
|
|
24
|
-
| Private key outside MCP | Deposit and withdraw **prepare** tools return unsigned steps. Signing and broadcast happen in the host wallet — never inside the MCP process. |
|
|
25
|
-
| Default automation | `aureon_create_objective` defaults `automationMode` to `"auto"`. |
|
|
26
|
-
| Locked at create | `targetSymbol` and `automationMode` are immutable after create. Recreate the objective to change them. |
|
|
27
|
-
| Unsigned prepare | `aureon_prepare_vault_deposit` and `aureon_prepare_vault_withdraw` never broadcast. |
|
|
28
|
-
| Settlement honesty | Restore / execution receipts may show `settlement: "vault"` (on-chain) or `"staged"` (ledger-local). Label them honestly. |
|
|
29
|
-
|
|
30
|
-
The catalog includes `aureon_dev_login` for preview APIs only. On hosted APIs it fails by design — agents should use an issued key (or optional Bearer) instead. The public host is still testnet 46630, not 4663.
|
|
31
|
-
|
|
32
|
-
### Auth bootstrap (agents)
|
|
33
|
-
|
|
34
|
-
1. Create an issued key in the operator utility **Developers** console.
|
|
35
|
-
2. Configure the MCP host with `AUREON_API_KEY`. Omit `AUREON_API_URL`
|
|
36
|
-
3. Call tools. Day-to-day agent work does **not** require a wallet handshake.
|
|
37
|
-
|
|
38
|
-
Optional wallet path: `aureon_get_auth_nonce` → host signs → `aureon_verify_wallet`. Prefer issued keys for always-on agents.
|
|
39
|
-
|
|
40
|
-
### Response shape
|
|
41
|
-
|
|
42
|
-
Successful calls return structured JSON (formatted for agents). Failures return an error object with a stable code and message — see the **@buildaureon/sdk documentation** error model.
|
|
43
|
-
|
|
44
|
-
### Quick index
|
|
45
|
-
|
|
46
|
-
| Group | Tools |
|
|
47
|
-
| --- | --- |
|
|
48
|
-
| Health | `aureon_ping` |
|
|
49
|
-
| Auth & identity | `aureon_get_auth_nonce`, `aureon_verify_wallet`, `aureon_dev_login`, `aureon_logout`, `aureon_me` |
|
|
50
|
-
| Dashboard & read | `aureon_get_overview`, `aureon_get_allocation_vs_target`, `aureon_get_objective_portfolio_flow`, `aureon_get_drift_restore_flow`, `aureon_get_receipt_verification_flow`, `aureon_get_portfolio_watch_flow`, `aureon_get_full_aureon_loop_flow`, `aureon_get_portfolio`, `aureon_list_objectives`, `aureon_get_objective`, `aureon_get_health`, `aureon_list_timeline`, `aureon_list_market_presets`, `aureon_get_restore_plan`, `aureon_list_executions`, `aureon_get_vault`, `aureon_get_vault_status` |
|
|
51
|
-
| Objectives | `aureon_create_objective`, `aureon_apply_financial_intent`, `aureon_run_drift_restore_demo`, `aureon_run_receipt_verification_demo`, `aureon_run_portfolio_watch_demo`, `aureon_run_full_aureon_loop_demo`, `aureon_update_objective`, `aureon_pause_objective`, `aureon_resume_objective` |
|
|
52
|
-
| Portfolio write | `aureon_set_portfolio`, `aureon_clear_portfolio`, `aureon_sync_portfolio` |
|
|
53
|
-
| Execution | `aureon_run_execution`, `aureon_restore_objective` |
|
|
54
|
-
| Market | `aureon_apply_market_event`, `aureon_refresh_watchdog` |
|
|
55
|
-
| Vault prepare | `aureon_prepare_vault_deposit`, `aureon_prepare_vault_withdraw` |
|
|
56
|
-
| Developer keys | `aureon_list_api_keys`, `aureon_create_api_key`, `aureon_revoke_api_key`, `aureon_toggle_api_key` |
|
|
57
|
-
|
|
58
|
-
---
|
|
59
|
-
|
|
60
|
-
## Health
|
|
61
|
-
|
|
62
|
-
### `aureon_ping`
|
|
63
|
-
|
|
64
|
-
**Purpose:** Confirm the live API is reachable and return a lightweight service / version smoke payload.
|
|
65
|
-
|
|
66
|
-
**Typical args:** none.
|
|
67
|
-
|
|
68
|
-
**When to use:** First call in a session; connectivity checks; before diagnosing auth or policy failures.
|
|
69
|
-
|
|
70
|
-
**Caveats:** A successful ping does not prove the issued key is valid for wallet-scoped tools — follow with `aureon_me` when identity matters.
|
|
71
|
-
|
|
72
|
-
---
|
|
73
|
-
|
|
74
|
-
## Auth & identity
|
|
75
|
-
|
|
76
|
-
### `aureon_get_auth_nonce`
|
|
77
|
-
|
|
78
|
-
**Purpose:** Fetch an EIP-191 challenge message for a wallet address so the host can sign a Bearer login.
|
|
79
|
-
|
|
80
|
-
**Typical args:**
|
|
81
|
-
|
|
82
|
-
| Arg | Required | Notes |
|
|
83
|
-
| --- | --- | --- |
|
|
84
|
-
| `address` | yes | Wallet `0x…` |
|
|
85
|
-
|
|
86
|
-
**When to use:** Optional wallet handshake only. Issued API keys usually skip this path.
|
|
87
|
-
|
|
88
|
-
**Caveats:** The message must be signed by the matching wallet. Early-access wallets may still need an invite on verify.
|
|
89
|
-
|
|
90
|
-
### `aureon_verify_wallet`
|
|
91
|
-
|
|
92
|
-
**Purpose:** Exchange a signed nonce for a Bearer session and store it in-process for later tools in this MCP session.
|
|
93
|
-
|
|
94
|
-
**Typical args:**
|
|
95
|
-
|
|
96
|
-
| Arg | Required | Notes |
|
|
97
|
-
| --- | --- | --- |
|
|
98
|
-
| `address` | yes | Same wallet as the nonce |
|
|
99
|
-
| `message` | yes | From `aureon_get_auth_nonce` |
|
|
100
|
-
| `signature` | yes | Wallet signature hex |
|
|
101
|
-
| `inviteCode` | no | First-login invite when required |
|
|
102
|
-
|
|
103
|
-
**When to use:** When you intentionally want a Bearer session instead of (or in addition to) an issued key.
|
|
104
|
-
|
|
105
|
-
**Caveats:** Bearer wins over the API key when both are present. Do not ask the user for a private key — only a signature over the challenge.
|
|
106
|
-
|
|
107
|
-
### `aureon_dev_login`
|
|
108
|
-
|
|
109
|
-
**Purpose:** Preview-API shortcut that returns a Bearer session without a wallet signature.
|
|
110
|
-
|
|
111
|
-
**Typical args:** none.
|
|
112
|
-
|
|
113
|
-
**When to use:** Only on a preview / staging API that explicitly enables `AUREON_ALLOW_DEV_LOGIN=1`.
|
|
114
|
-
|
|
115
|
-
**Caveats:** Fails on `https://api.aureonlabs.network`. Do not put this tool in production agent playbooks. Prefer issued keys.
|
|
116
|
-
|
|
117
|
-
### `aureon_logout`
|
|
118
|
-
|
|
119
|
-
**Purpose:** Revoke the current Bearer session and clear the in-process token.
|
|
120
|
-
|
|
121
|
-
**Typical args:** none.
|
|
122
|
-
|
|
123
|
-
**When to use:** End a wallet session; rotate away from a Bearer after debugging.
|
|
124
|
-
|
|
125
|
-
**Caveats:** Does not revoke the issued `AUREON_API_KEY`. Key-only agents may not need this tool.
|
|
126
|
-
|
|
127
|
-
### `aureon_me`
|
|
128
|
-
|
|
129
|
-
**Purpose:** Return the wallet bound to the issued API key or the current Bearer session.
|
|
130
|
-
|
|
131
|
-
**Typical args:** none.
|
|
132
|
-
|
|
133
|
-
**When to use:** Identity confirmation after connect; every morning check; before mutating portfolio or objectives.
|
|
134
|
-
|
|
135
|
-
**Caveats:** If you see an error about env keys that cannot identify a wallet, replace the key with an **issued** Developers key.
|
|
136
|
-
|
|
137
|
-
---
|
|
138
|
-
|
|
139
|
-
## Dashboard & portfolio (read)
|
|
140
|
-
|
|
141
|
-
### `aureon_get_overview`
|
|
142
|
-
|
|
143
|
-
**Purpose:** Dashboard rollup — AUM, objective counts, aggregate health posture.
|
|
144
|
-
|
|
145
|
-
**Typical args:** none.
|
|
146
|
-
|
|
147
|
-
**When to use:** Morning checks; high-level status before diving into a single objective.
|
|
148
|
-
|
|
149
|
-
**Caveats:** Overview is a summary. Drill into `aureon_get_health` / `aureon_get_objective` for policy decisions.
|
|
150
|
-
|
|
151
|
-
### `aureon_get_allocation_vs_target`
|
|
152
|
-
|
|
153
|
-
**Purpose:** Objective vs actual portfolio — current weight vs policy target per active objective, plus a green-book/off-plan paradox flag.
|
|
154
|
-
|
|
155
|
-
**Typical args:** none.
|
|
156
|
-
|
|
157
|
-
**When to use:** demos; explain when the book is up but objectives are in warning/violation; avoid stitching overview + health manually.
|
|
158
|
-
|
|
159
|
-
**Returns:** `{ rows, paradox, overview }` — see `@buildaureon/sdk` `getAllocationVsTarget()`.
|
|
160
|
-
|
|
161
|
-
**Caveats:** Paradox detection uses 24h book change when available. Pair with `aureon_apply_market_event` (`autoRestore: false`) for rehearsal demos.
|
|
162
|
-
|
|
163
|
-
### `aureon_get_objective_portfolio_flow`
|
|
164
|
-
|
|
165
|
-
**Purpose:** Read AI → objective → portfolio flow for active objectives (intent summary, objective, health, portfolio snapshot).
|
|
166
|
-
|
|
167
|
-
**Typical args:**
|
|
168
|
-
|
|
169
|
-
| Arg | Required | Notes |
|
|
170
|
-
| --- | --- | --- |
|
|
171
|
-
| `objectiveId` | no | Filter to one objective; omit for all active |
|
|
172
|
-
|
|
173
|
-
**When to use:** — confirm intent is linked to live portfolio after `aureon_apply_financial_intent`; read-only refresh without creating a new objective.
|
|
174
|
-
|
|
175
|
-
**Returns:** Array of flow objects — see `@buildaureon/sdk` `getObjectivePortfolioFlow()`.
|
|
176
|
-
|
|
177
|
-
**Caveats:** Only active objectives are included. Pair with `aureon_get_allocation_vs_target` for ongoing objective vs actual tracking.
|
|
178
|
-
|
|
179
|
-
### `aureon_run_drift_restore_demo`
|
|
180
|
-
|
|
181
|
-
**Purpose:** Run drift → detection → restore demo in one call (seed book, create stable objective, NVDA rally with `autoRestore: false`, manual restore).
|
|
182
|
-
|
|
183
|
-
**Typical args:** none.
|
|
184
|
-
|
|
185
|
-
**When to use:** Content Arc Day 4; teach the full loop without stitching portfolio, market, plan, and restore tools.
|
|
186
|
-
|
|
187
|
-
**Returns:** `DriftRestoreFlow` — see `@buildaureon/sdk` `runDriftRestoreDemo()`.
|
|
188
|
-
|
|
189
|
-
**Caveats:** Mutates portfolio and creates a new objective. Settlement may be `vault` or `staged`. Controlled rehearsal — not discretionary trading.
|
|
190
|
-
|
|
191
|
-
### `aureon_get_drift_restore_flow`
|
|
192
|
-
|
|
193
|
-
**Purpose:** Read drift → detection → restore flow for active objectives (health, allocation row, restore plan when off-plan, latest receipt).
|
|
194
|
-
|
|
195
|
-
**Typical args:**
|
|
196
|
-
|
|
197
|
-
| Arg | Required | Notes |
|
|
198
|
-
| --- | --- | --- |
|
|
199
|
-
| `objectiveId` | no | Filter to one objective; omit for all active |
|
|
200
|
-
|
|
201
|
-
**When to use:** Confirm three-beat arc after manual steps in workflow J; read-only monitoring.
|
|
202
|
-
|
|
203
|
-
**Returns:** Array of `DriftRestoreFlow` — see `@buildaureon/sdk` `getDriftRestoreFlow()`.
|
|
204
|
-
|
|
205
|
-
**Caveats:** Inferred phases when historical aligned/drift snapshots are not stored; pair with `aureon_list_timeline` for audit trail.
|
|
206
|
-
|
|
207
|
-
### `aureon_run_receipt_verification_demo`
|
|
208
|
-
|
|
209
|
-
**Purpose:** Run receipt → verification demo (drift-restore + validate receipt + settlement lookup + timeline).
|
|
210
|
-
|
|
211
|
-
**Typical args:** none.
|
|
212
|
-
|
|
213
|
-
**When to use:** Content Arc Day 5; teach claim vs validation vs chain proof without stitching restore, validate, and settlement tools.
|
|
214
|
-
|
|
215
|
-
**Returns:** `ReceiptVerificationFlow` — see `@buildaureon/sdk` `runReceiptVerificationDemo()`.
|
|
216
|
-
|
|
217
|
-
**Caveats:** Mutates portfolio via embedded drift-restore. Validator is local — does not re-query chain. Staged receipts validate but are not chain-verified.
|
|
218
|
-
|
|
219
|
-
### `aureon_get_receipt_verification_flow`
|
|
220
|
-
|
|
221
|
-
**Purpose:** Read receipt → verification flow for execution receipts (claim, validation result, settlement lookup, timeline).
|
|
222
|
-
|
|
223
|
-
**Typical args:**
|
|
224
|
-
|
|
225
|
-
| Arg | Required | Notes |
|
|
226
|
-
| --- | --- | --- |
|
|
227
|
-
| `executionId` | no | Filter to one execution; omit for five most recent |
|
|
228
|
-
|
|
229
|
-
**When to use:** Confirm verification tier after manual steps in workflow K.
|
|
230
|
-
|
|
231
|
-
**Returns:** Array of `ReceiptVerificationFlow` — see `@buildaureon/sdk` `getReceiptVerificationFlow()`.
|
|
232
|
-
|
|
233
|
-
**Caveats:** Pair with `aureon_validate_receipt` for local checks; use `aureon_get_execution_settlement` for vault chain proof.
|
|
234
|
-
|
|
235
|
-
### `aureon_run_portfolio_watch_demo`
|
|
236
|
-
|
|
237
|
-
**Purpose:** Run portfolio watch demo (brief → Automatic objective → while-away market event with auto restore → return briefing).
|
|
238
|
-
|
|
239
|
-
**Typical args:**
|
|
240
|
-
|
|
241
|
-
| Arg | Required | Notes |
|
|
242
|
-
| --- | --- | --- |
|
|
243
|
-
| `brief` | no | User wording; default watch-while-away brief |
|
|
244
|
-
| `host` | no | `cursor` \| `claude` \| `mcp` for briefing labels |
|
|
245
|
-
|
|
246
|
-
**When to use:** Content Arc Day 6; Claude/Cursor + AUREON agent-in-host teaching.
|
|
247
|
-
|
|
248
|
-
**Returns:** `PortfolioWatchFlow` — see `@buildaureon/sdk` `runPortfolioWatchDemo()`.
|
|
249
|
-
|
|
250
|
-
**Caveats:** Mutates portfolio and objectives. Uses `autoRestore: true`. Not unsupervised trading — registered Automatic policy only.
|
|
251
|
-
|
|
252
|
-
### `aureon_get_portfolio_watch_flow`
|
|
253
|
-
|
|
254
|
-
**Purpose:** Read portfolio watch briefing for Automatic objectives.
|
|
255
|
-
|
|
256
|
-
**Typical args:**
|
|
257
|
-
|
|
258
|
-
| Arg | Required | Notes |
|
|
259
|
-
| --- | --- | --- |
|
|
260
|
-
| `objectiveId` | no | Filter to one objective |
|
|
261
|
-
| `brief` | no | User brief for summary lines |
|
|
262
|
-
| `host` | no | Agent host label |
|
|
263
|
-
|
|
264
|
-
**When to use:** Confirm briefing after manual steps in workflow L.
|
|
265
|
-
|
|
266
|
-
**Returns:** Array of `PortfolioWatchFlow` — see `@buildaureon/sdk` `getPortfolioWatchFlow()`.
|
|
267
|
-
|
|
268
|
-
### `aureon_run_full_aureon_loop_demo`
|
|
269
|
-
|
|
270
|
-
**Purpose:** Run Content Arc full AUREON loop (intent → plan check with autoRestore false → restore → receipt verification).
|
|
271
|
-
|
|
272
|
-
**Typical args:**
|
|
273
|
-
|
|
274
|
-
| Arg | Required | Notes |
|
|
275
|
-
| --- | --- | --- |
|
|
276
|
-
| `brief` | no | User wording; default full-loop brief |
|
|
277
|
-
|
|
278
|
-
**When to use:** Content Arc Day 7; positioning demo — not a portfolio tracker.
|
|
279
|
-
|
|
280
|
-
**Returns:** `FullAureonLoopFlow` — see `@buildaureon/sdk` `runFullAureonLoopDemo()`.
|
|
281
|
-
|
|
282
|
-
**Caveats:** Mutates portfolio. Uses `autoRestore: false` then manual restore. Staged receipts validate but are not chain-verified.
|
|
283
|
-
|
|
284
|
-
### `aureon_get_full_aureon_loop_flow`
|
|
285
|
-
|
|
286
|
-
**Purpose:** Read full AUREON loop for active objectives that already have an execution receipt.
|
|
287
|
-
|
|
288
|
-
**Typical args:**
|
|
289
|
-
|
|
290
|
-
| Arg | Required | Notes |
|
|
291
|
-
| --- | --- | --- |
|
|
292
|
-
| `objectiveId` | no | Filter to one objective |
|
|
293
|
-
| `brief` | no | User brief for teaching shape |
|
|
294
|
-
|
|
295
|
-
**When to use:** Confirm closed loop after manual steps in workflow M.
|
|
296
|
-
|
|
297
|
-
**Returns:** Array of `FullAureonLoopFlow` — see `@buildaureon/sdk` `getFullAureonLoopFlow()`.
|
|
298
|
-
|
|
299
|
-
### `aureon_get_portfolio`
|
|
300
|
-
|
|
301
|
-
**Purpose:** Current Capital Book snapshot — positions, marks, and weights.
|
|
302
|
-
|
|
303
|
-
**Typical args:** none.
|
|
304
|
-
|
|
305
|
-
**When to use:** After sync; before creating objectives; when explaining current exposure.
|
|
306
|
-
|
|
307
|
-
**Caveats:** Stale books mislead restore logic. Prefer `aureon_sync_portfolio` when chain balances may have changed.
|
|
308
|
-
|
|
309
|
-
### `aureon_list_objectives`
|
|
310
|
-
|
|
311
|
-
**Purpose:** List all Financial Compass objectives for the authenticated wallet.
|
|
312
|
-
|
|
313
|
-
**Typical args:** none.
|
|
314
|
-
|
|
315
|
-
**When to use:** Discover IDs; inventory auto vs paused objectives; pick a target for restore.
|
|
316
|
-
|
|
317
|
-
**Caveats:** Empty list is normal for new wallets. Create with `automationMode: "auto"` for agent-driven restores.
|
|
318
|
-
|
|
319
|
-
### `aureon_get_objective`
|
|
320
|
-
|
|
321
|
-
**Purpose:** Fetch one objective by ID (policy fields, status, locked create-time fields).
|
|
322
|
-
|
|
323
|
-
**Typical args:**
|
|
324
|
-
|
|
325
|
-
| Arg | Required | Notes |
|
|
326
|
-
| --- | --- | --- |
|
|
327
|
-
| `objectiveId` | yes | From list or create |
|
|
328
|
-
|
|
329
|
-
**When to use:** Inspect before update / pause / restore; confirm `targetSymbol` and `automationMode`.
|
|
330
|
-
|
|
331
|
-
**Caveats:** Remember `targetSymbol` and `automationMode` cannot be patched later.
|
|
332
|
-
|
|
333
|
-
### `aureon_get_health`
|
|
334
|
-
|
|
335
|
-
**Purpose:** Health / drift / breach state for one objective or all objectives.
|
|
336
|
-
|
|
337
|
-
**Typical args:**
|
|
338
|
-
|
|
339
|
-
| Arg | Required | Notes |
|
|
340
|
-
| --- | --- | --- |
|
|
341
|
-
| `objectiveId` | no | Omit for all |
|
|
342
|
-
|
|
343
|
-
**When to use:** After watchdog refresh; before restore; when the operator asks why something looks red.
|
|
344
|
-
|
|
345
|
-
**Caveats:** Health can flap after marks update. Re-read after restore instead of spamming restores.
|
|
346
|
-
|
|
347
|
-
### `aureon_list_timeline`
|
|
348
|
-
|
|
349
|
-
**Purpose:** Event timeline — objective changes, executions, health transitions.
|
|
350
|
-
|
|
351
|
-
**Typical args:**
|
|
352
|
-
|
|
353
|
-
| Arg | Required | Notes |
|
|
354
|
-
| --- | --- | --- |
|
|
355
|
-
| `objectiveId` | no | Omit for all |
|
|
356
|
-
|
|
357
|
-
**When to use:** Post-restore confirmation; audit trail for the operator; debugging unexpected state.
|
|
358
|
-
|
|
359
|
-
**Caveats:** Timeline is historical context, not a substitute for the latest health snapshot.
|
|
360
|
-
|
|
361
|
-
### `aureon_list_market_presets`
|
|
362
|
-
|
|
363
|
-
**Purpose:** List available market-event
|
|
364
|
-
|
|
365
|
-
**Typical args:** none.
|
|
366
|
-
|
|
367
|
-
**When to use:** Before `aureon_apply_market_event` in integration / demo flows.
|
|
368
|
-
|
|
369
|
-
**Caveats:** Presets are for rehearsal, not live oracle prices.
|
|
370
|
-
|
|
371
|
-
### `aureon_get_restore_plan`
|
|
372
|
-
|
|
373
|
-
**Purpose:** Inspect the proposed restore plan for an objective (steps to return to policy).
|
|
374
|
-
|
|
375
|
-
**Typical args:**
|
|
376
|
-
|
|
377
|
-
| Arg | Required | Notes |
|
|
378
|
-
| --- | --- | --- |
|
|
379
|
-
| `objectiveId` | yes | Target objective |
|
|
380
|
-
|
|
381
|
-
**When to use:** Always prefer reading the plan before `aureon_restore_objective` when explaining risk to a human.
|
|
382
|
-
|
|
383
|
-
**Caveats:** Plans can change after marks or vault balances move. Refresh health / watchdog if the book is stale.
|
|
384
|
-
|
|
385
|
-
### `aureon_list_executions`
|
|
386
|
-
|
|
387
|
-
**Purpose:** Recent execution receipts for restorative actions.
|
|
388
|
-
|
|
389
|
-
**Typical args:**
|
|
390
|
-
|
|
391
|
-
| Arg | Required | Notes |
|
|
392
|
-
| --- | --- | --- |
|
|
393
|
-
| `objectiveId` | no | Omit for all |
|
|
394
|
-
|
|
395
|
-
**When to use:** Confirm last restore; check `settlement` field (`vault` vs `staged`).
|
|
396
|
-
|
|
397
|
-
**Caveats:** Never claim on-chain settlement unless the receipt says `settlement: "vault"`.
|
|
398
|
-
|
|
399
|
-
### `aureon_get_vault`
|
|
400
|
-
|
|
401
|
-
**Purpose:** Full vault overview — balances, tokens, deposit-related history.
|
|
402
|
-
|
|
403
|
-
**Typical args:** none.
|
|
404
|
-
|
|
405
|
-
**When to use:** Funding diagnosis; after a broadcasted deposit; capital readiness reviews.
|
|
406
|
-
|
|
407
|
-
**Caveats:** Vault overview can lag until chain txs confirm and portfolio sync runs.
|
|
408
|
-
|
|
409
|
-
### `aureon_get_vault_status`
|
|
410
|
-
|
|
411
|
-
**Purpose:** Compact funding / readiness status before Automatic restores.
|
|
412
|
-
|
|
413
|
-
**Typical args:** none.
|
|
414
|
-
|
|
415
|
-
**When to use:** Morning checks; gate before creating auto objectives; after prepare+broadcast deposits.
|
|
416
|
-
|
|
417
|
-
**Caveats:** Empty vault often blocks meaningful Automatic restores — prepare a deposit and have the host sign.
|
|
418
|
-
|
|
419
|
-
---
|
|
420
|
-
|
|
421
|
-
## Portfolio (write)
|
|
422
|
-
|
|
423
|
-
### `aureon_set_portfolio`
|
|
424
|
-
|
|
425
|
-
**Purpose:** Replace the Capital Book with an explicit position list.
|
|
426
|
-
|
|
427
|
-
**Typical args:**
|
|
428
|
-
|
|
429
|
-
| Arg | Required | Notes |
|
|
430
|
-
| --- | --- | --- |
|
|
431
|
-
| `positions` | yes | Array of rows: `symbol`, `name`, `category`, `quantity`, `markPriceUsd` |
|
|
432
|
-
| `positions[].category` | yes | `stable` \| `stock_token` \| `gas` \| `other` |
|
|
433
|
-
|
|
434
|
-
**When to use:** Controlled demos or explicit book overrides when the operator supplies positions.
|
|
435
|
-
|
|
436
|
-
**Caveats:** Overwrites the book. Prefer `aureon_sync_portfolio` for live chain marks in production agent loops.
|
|
437
|
-
|
|
438
|
-
### `aureon_clear_portfolio`
|
|
439
|
-
|
|
440
|
-
**Purpose:** Clear all Capital Book positions for the authenticated wallet.
|
|
441
|
-
|
|
442
|
-
**Typical args:** none.
|
|
443
|
-
|
|
444
|
-
**When to use:** Reset before a clean sync or demo restart.
|
|
445
|
-
|
|
446
|
-
**Caveats:** Destructive. Confirm with the operator before clearing a live book.
|
|
447
|
-
|
|
448
|
-
### `aureon_sync_portfolio`
|
|
449
|
-
|
|
450
|
-
**Purpose:** Replace the Capital Book with on-chain balances for the session wallet.
|
|
451
|
-
|
|
452
|
-
**Typical args:** none.
|
|
453
|
-
|
|
454
|
-
**When to use:** Default read-path refresh; after deposits/withdraws broadcast; before create / restore.
|
|
455
|
-
|
|
456
|
-
**Caveats:** Sync does not move vault funds by itself — it refreshes the book the policy engine reads.
|
|
457
|
-
|
|
458
|
-
---
|
|
459
|
-
|
|
460
|
-
## Objectives (write)
|
|
461
|
-
|
|
462
|
-
### `aureon_create_objective`
|
|
463
|
-
|
|
464
|
-
**Purpose:** Create a Financial Compass objective. Defaults `automationMode` to `"auto"`.
|
|
465
|
-
|
|
466
|
-
**Typical args:**
|
|
467
|
-
|
|
468
|
-
| Arg | Required | Notes |
|
|
469
|
-
| --- | --- | --- |
|
|
470
|
-
| `name` | yes | Display name |
|
|
471
|
-
| `kind` | yes | `stable_allocation` \| `balanced_portfolio` \| `risk_ceiling` \| `reward_reinvestment` |
|
|
472
|
-
| `targetWeight` | yes | 0–1 |
|
|
473
|
-
| `tolerance` | yes | Drift band 0–1 |
|
|
474
|
-
| `priority` | no | `low` \| `medium` \| `high` \| `critical` |
|
|
475
|
-
| `maxRiskScore` | no | For risk-ceiling kinds |
|
|
476
|
-
| `reinvestRatio` | no | For reward kinds |
|
|
477
|
-
| `targetSymbol` | no | Asset symbol (nullable); **locked after create** |
|
|
478
|
-
| `automationMode` | no | `auto` \| `manual`; default **`auto`**; **locked after create** |
|
|
479
|
-
|
|
480
|
-
**When to use:** New policy intent (e.g. maintain ~15% WETH automatically).
|
|
481
|
-
|
|
482
|
-
**Caveats:** Agents should use **Automatic** (`auto`) unless the human explicitly wants Manual Approve. To change symbol or mode later, create a new objective (pause or leave the old one).
|
|
483
|
-
|
|
484
|
-
### `aureon_apply_financial_intent`
|
|
485
|
-
|
|
486
|
-
**Purpose:** Register user/agent intent as an Automatic objective and return the full AI → objective → portfolio flow in one call.
|
|
487
|
-
|
|
488
|
-
**Typical args:**
|
|
489
|
-
|
|
490
|
-
| Arg | Required | Notes |
|
|
491
|
-
| --- | --- | --- |
|
|
492
|
-
| `brief` | yes | What the user wants their money to do — agent-extracted wording |
|
|
493
|
-
| `kind` | yes | `stable_allocation` \| `balanced_portfolio` \| `risk_ceiling` \| `reward_reinvestment` |
|
|
494
|
-
| `targetWeight` | yes | 0–1 |
|
|
495
|
-
| `tolerance` | yes | Drift band 0–1 |
|
|
496
|
-
| `targetSymbol` | no | Asset symbol for `balanced_portfolio` |
|
|
497
|
-
| `name` | no | Display name override |
|
|
498
|
-
| `priority` | no | `low` \| `medium` \| `high` \| `critical` |
|
|
499
|
-
|
|
500
|
-
**When to use:** turn structured agent intent into persistent policy without stitching create + health + portfolio calls.
|
|
501
|
-
|
|
502
|
-
**Returns:** `{ intent, objective, health, portfolio, message }` — see `@buildaureon/sdk` `applyFinancialIntent()`.
|
|
503
|
-
|
|
504
|
-
**Caveats:** Agent must supply structured fields; `brief` is for audit/teaching, not autonomous NLU. Creates a new objective each call.
|
|
505
|
-
|
|
506
|
-
### `aureon_update_objective`
|
|
507
|
-
|
|
508
|
-
**Purpose:** Partial update of mutable fields (name, weight, tolerance, priority, optional risk/reinvest fields).
|
|
509
|
-
|
|
510
|
-
**Typical args:**
|
|
511
|
-
|
|
512
|
-
| Arg | Required | Notes |
|
|
513
|
-
| --- | --- | --- |
|
|
514
|
-
| `objectiveId` | yes | Target |
|
|
515
|
-
| `name` | no | Display name |
|
|
516
|
-
| `priority` | no | Priority enum |
|
|
517
|
-
| `targetWeight` | no | 0–1 |
|
|
518
|
-
| `tolerance` | no | 0–1 |
|
|
519
|
-
| `maxRiskScore` | no | Optional |
|
|
520
|
-
| `reinvestRatio` | no | Optional |
|
|
521
|
-
|
|
522
|
-
**When to use:** Tighten tolerance; rename; adjust weight without changing token or automation mode.
|
|
523
|
-
|
|
524
|
-
**Caveats:** **Cannot** change `targetSymbol` or `automationMode`. If the API rejects those fields, recreate instead.
|
|
525
|
-
|
|
526
|
-
### `aureon_pause_objective`
|
|
527
|
-
|
|
528
|
-
**Purpose:** Pause continuous evaluation for an objective.
|
|
529
|
-
|
|
530
|
-
**Typical args:** `objectiveId` (required).
|
|
531
|
-
|
|
532
|
-
**When to use:** Temporary halt during funding, maintenance, or operator review.
|
|
533
|
-
|
|
534
|
-
**Caveats:** Paused objectives will not drive Automatic restores until resumed.
|
|
535
|
-
|
|
536
|
-
### `aureon_resume_objective`
|
|
537
|
-
|
|
538
|
-
**Purpose:** Resume evaluation for a paused objective.
|
|
539
|
-
|
|
540
|
-
**Typical args:** `objectiveId` (required).
|
|
541
|
-
|
|
542
|
-
**When to use:** After funding the vault or finishing a maintenance window.
|
|
543
|
-
|
|
544
|
-
**Caveats:** Re-check health after resume; a breach may already exist.
|
|
545
|
-
|
|
546
|
-
---
|
|
547
|
-
|
|
548
|
-
## Compass / execution
|
|
549
|
-
|
|
550
|
-
### `aureon_run_execution`
|
|
551
|
-
|
|
552
|
-
**Purpose:** Run restorative execution for an objective currently outside policy.
|
|
553
|
-
|
|
554
|
-
**Typical args:** `objectiveId` (required).
|
|
555
|
-
|
|
556
|
-
**When to use:** Explicit execution path when the product flow calls for `runExecution` rather than vault-backed restore.
|
|
557
|
-
|
|
558
|
-
**Caveats:** Prefer reading health / plan first. Report settlement type honestly from the receipt.
|
|
559
|
-
|
|
560
|
-
### `aureon_restore_objective`
|
|
561
|
-
|
|
562
|
-
**Purpose:** Run restorative execution for an objective outside policy. Not always vault-backed.
|
|
563
|
-
|
|
564
|
-
**Typical args:** `objectiveId` (required).
|
|
565
|
-
|
|
566
|
-
**When to use:** After a clear breach and a reviewed restore plan.
|
|
567
|
-
|
|
568
|
-
**Caveats:** Automatic + configured vault that cannot execute returns 409 — it does not
|
|
569
|
-
|
|
570
|
-
### How to read a receipt (agents)
|
|
571
|
-
|
|
572
|
-
1. Call `aureon_list_executions` or use the receipt from restore/run.
|
|
573
|
-
2. Check **`settlement`**: `vault` vs `staged` — never claim on-chain for `staged`.
|
|
574
|
-
3. If **`explorerUrl`** is present, the vault tx can be verified on the explorer.
|
|
575
|
-
4. If **`registryRef`** is present, the objective was registered on ObjectiveRegistry.
|
|
576
|
-
5. Match **`aureon_list_timeline`** events via `payload.executionId === receipt.id`.
|
|
577
|
-
6. For vault receipts, check **`verifiedOnChain`**. When true, cite **`settlementRecord`** or call **`aureon_get_execution_settlement`**. Never invent chain proof when `verifiedOnChain` is false.
|
|
578
|
-
|
|
579
|
-
### `aureon_get_execution_settlement`
|
|
580
|
-
|
|
581
|
-
**Purpose:** Returns the durable on-chain settlement record for a vault execution when the API listener observed a `Rebalanced` event.
|
|
582
|
-
|
|
583
|
-
**When to use:** After a vault restore when you need independent chain proof (tx hash, block, token pair, amounts).
|
|
584
|
-
|
|
585
|
-
**Caveats:** Staged executions return `verifiedOnChain: false` with no settlement. Vault without listener confirmation is **not** chain-verified — say “vault submitted, not yet observed on-chain.”
|
|
586
|
-
|
|
587
|
-
### `aureon_list_settlements`
|
|
588
|
-
|
|
589
|
-
**Purpose:** Lists settlement records for the wallet (optional `objectiveId` filter). May include orphans — observed vault events not yet bound to an execution.
|
|
590
|
-
|
|
591
|
-
**When to use:** Audit trail review; cross-check multiple restores. Read `status` and `executionId` before claiming proof.
|
|
592
|
-
|
|
593
|
-
### `aureon_validate_receipt`
|
|
594
|
-
|
|
595
|
-
**Purpose:** Validates an execution receipt locally (no API call). Returns `{ valid, issues }`.
|
|
596
|
-
|
|
597
|
-
**When to use:** After `aureon_restore_objective` or `aureon_list_executions` — confirm the receipt is honest before reporting to the operator.
|
|
598
|
-
|
|
599
|
-
**Caveats:** Validation is schema + policy only; it does not re-fetch chain state. If `valid: false`, quote `issues` and do not claim on-chain settlement.
|
|
600
|
-
|
|
601
|
-
---
|
|
602
|
-
|
|
603
|
-
## Market
|
|
604
|
-
|
|
605
|
-
### `aureon_apply_market_event`
|
|
606
|
-
|
|
607
|
-
**Purpose:** Apply a controlled mark shock to a symbol for integration rehearsal; optionally trigger auto-restore.
|
|
608
|
-
|
|
609
|
-
**Typical args:**
|
|
610
|
-
|
|
611
|
-
| Arg | Required | Notes |
|
|
612
|
-
| --- | --- | --- |
|
|
613
|
-
| `symbol` | yes | e.g. `TSLA` |
|
|
614
|
-
| `priceChangeRatio` | yes | Fractional change (`-0.1` = −10%) |
|
|
615
|
-
| `name` | no | Event label |
|
|
616
|
-
| `description` | no | Human description |
|
|
617
|
-
| `autoRestore` | no | If true, may run restorative execution on breach |
|
|
618
|
-
|
|
619
|
-
**When to use:** Demo / rehearsal of drift → plan → restore. Not for production price discovery.
|
|
620
|
-
|
|
621
|
-
**Caveats:** Do not treat rehearsal shocks as live oracle prices for real capital decisions.
|
|
622
|
-
|
|
623
|
-
### `aureon_refresh_watchdog`
|
|
624
|
-
|
|
625
|
-
**Purpose:** Refresh portfolio marks from live data and re-evaluate objectives.
|
|
626
|
-
|
|
627
|
-
**Typical args:** none.
|
|
628
|
-
|
|
629
|
-
**When to use:** Morning checks; after market events; before reading health for restore decisions.
|
|
630
|
-
|
|
631
|
-
**Caveats:** Refresh alone does not restore. Follow with health / plan / restore as needed.
|
|
632
|
-
|
|
633
|
-
---
|
|
634
|
-
|
|
635
|
-
## Vault
|
|
636
|
-
|
|
637
|
-
### `aureon_prepare_vault_deposit`
|
|
638
|
-
|
|
639
|
-
**Purpose:** Prepare **unsigned** vault deposit steps for a symbol and amount.
|
|
640
|
-
|
|
641
|
-
**Typical args:**
|
|
642
|
-
|
|
643
|
-
| Arg | Required | Notes |
|
|
644
|
-
| --- | --- | --- |
|
|
645
|
-
| `symbol` | yes | `ETH` or allowlisted ERC-20 |
|
|
646
|
-
| `amount` | yes | Human-readable amount string |
|
|
647
|
-
|
|
648
|
-
**When to use:** Fund the vault so Automatic restores can settle on-chain.
|
|
649
|
-
|
|
650
|
-
**Caveats:** Returns calldata / steps only. The **host** must sign and broadcast with a private key **outside** MCP. API key alone cannot move funds. After broadcast, sync and re-check vault status.
|
|
651
|
-
|
|
652
|
-
### `aureon_prepare_vault_withdraw`
|
|
653
|
-
|
|
654
|
-
**Purpose:** Prepare **unsigned** vault withdraw steps.
|
|
655
|
-
|
|
656
|
-
**Typical args:**
|
|
657
|
-
|
|
658
|
-
| Arg | Required | Notes |
|
|
659
|
-
| --- | --- | --- |
|
|
660
|
-
| `amount` | yes | Human-readable amount string |
|
|
661
|
-
| `symbol` | no | Default WETH (not ETH) |
|
|
662
|
-
|
|
663
|
-
**When to use:** Operator-directed withdrawals after confirming vault balances.
|
|
664
|
-
|
|
665
|
-
**Caveats:** Same non-custodial boundary as deposit — prepare ≠ completed withdrawal until the host broadcasts.
|
|
666
|
-
|
|
667
|
-
---
|
|
668
|
-
|
|
669
|
-
## Developer API keys
|
|
670
|
-
|
|
671
|
-
### `aureon_list_api_keys`
|
|
672
|
-
|
|
673
|
-
**Purpose:** List API key metadata for the authenticated wallet (no secrets).
|
|
674
|
-
|
|
675
|
-
**Typical args:** none.
|
|
676
|
-
|
|
677
|
-
**When to use:** Inventory keys; find IDs for toggle / revoke.
|
|
678
|
-
|
|
679
|
-
**Caveats:** Secrets are never re-listed after create. Metadata only.
|
|
680
|
-
|
|
681
|
-
### `aureon_create_api_key`
|
|
682
|
-
|
|
683
|
-
**Purpose:** Create a new issued SDK API key. The secret is returned **once**.
|
|
684
|
-
|
|
685
|
-
**Typical args:**
|
|
686
|
-
|
|
687
|
-
| Arg | Required | Notes |
|
|
688
|
-
| --- | --- | --- |
|
|
689
|
-
| `name` | yes | Display name (min length enforced) |
|
|
690
|
-
|
|
691
|
-
**When to use:** Rotate or provision a new agent key under an already-authenticated identity.
|
|
692
|
-
|
|
693
|
-
**Caveats:** Treat the returned secret like a password. Do not echo it into public chat logs. Store it in the MCP host env as `AUREON_API_KEY`.
|
|
694
|
-
|
|
695
|
-
### `aureon_revoke_api_key`
|
|
696
|
-
|
|
697
|
-
**Purpose:** Permanently revoke (delete) an issued API key.
|
|
698
|
-
|
|
699
|
-
**Typical args:** `keyId` (required).
|
|
700
|
-
|
|
701
|
-
**When to use:** Key compromise; decommissioning an agent.
|
|
702
|
-
|
|
703
|
-
**Caveats:** Irreversible for that key material. Confirm the ID from `aureon_list_api_keys`.
|
|
704
|
-
|
|
705
|
-
### `aureon_toggle_api_key`
|
|
706
|
-
|
|
707
|
-
**Purpose:** Pause or unpause an API key without revoking it.
|
|
708
|
-
|
|
709
|
-
**Typical args:** `keyId` (required).
|
|
710
|
-
|
|
711
|
-
**When to use:** Temporary freeze during investigation; soft disable without rotation.
|
|
712
|
-
|
|
713
|
-
**Caveats:** Toggled-off keys fail subsequent control-plane calls until re-enabled.
|
|
714
|
-
|
|
715
|
-
### `aureon_get_audit_trail`
|
|
716
|
-
|
|
717
|
-
**Purpose:** Export one objective’s financial audit trail — registry, receipts, settlements, timeline — in a single object.
|
|
718
|
-
|
|
719
|
-
**Typical args:** `objectiveId` (required).
|
|
720
|
-
|
|
721
|
-
**When to use:** “Did this restore actually happen?” / follow intent → receipt → settlement without stitching four tools.
|
|
722
|
-
|
|
723
|
-
**Caveats:** Missing proof is labeled as a gap. Staged receipts are never on-chain. Do not invent explorer links or `verifiedOnChain`. Testnet only.
|
|
724
|
-
|
|
725
|
-
---
|
|
726
|
-
|
|
727
|
-
## Prompt → tool mapping
|
|
728
|
-
|
|
729
|
-
| Operator ask | Tool(s) |
|
|
730
|
-
| --- | --- |
|
|
731
|
-
| “Is the API up?” | `aureon_ping` |
|
|
732
|
-
| “Which wallet am I?” | `aureon_me` |
|
|
733
|
-
| “Refresh balances from chain” | `aureon_sync_portfolio` |
|
|
734
|
-
| “Is the vault funded?” | `aureon_get_vault_status` |
|
|
735
|
-
| “Maintain 20% WETH automatic” | `aureon_create_objective` (`automationMode: auto`, `targetSymbol: WETH`) |
|
|
736
|
-
| “Why is health red?” | `aureon_get_health`, `aureon_list_timeline` |
|
|
737
|
-
| “Show the restore plan” | `aureon_get_restore_plan` |
|
|
738
|
-
| “Execute restore” | `aureon_restore_objective` |
|
|
739
|
-
| “Export the audit trail” | `aureon_get_audit_trail` |
|
|
740
|
-
| “Simulate −10% TSLA” | `aureon_apply_market_event` |
|
|
741
|
-
| “Prepare 0.1 ETH deposit” | `aureon_prepare_vault_deposit` then host signs |
|
|
742
|
-
| “Rotate my agent key” | `aureon_create_api_key` (+ secure store), optional `aureon_revoke_api_key` |
|
|
743
|
-
|
|
744
|
-
---
|
|
745
|
-
|
|
746
|
-
## Related reading
|
|
747
|
-
|
|
748
|
-
- [Agent guide](./agent-guide.md) — read → decide → act playbooks
|
|
749
|
-
- [Auth](./auth.md) — issued key, optional Bearer, private-key boundary
|
|
750
|
-
- [Setup](./setup.md) — host configuration for Cursor / Claude Desktop
|
|
751
|
-
- [Security](./security.md) — stdio trust boundary and key hygiene
|
|
752
|
-
- **@buildaureon/sdk documentation** — typed client methods, data contracts, error model
|
|
753
|
-
|
|
754
|
-
---
|
|
755
|
-
|
|
756
|
-
## Notes for implementers
|
|
757
|
-
|
|
758
|
-
- Tool names are stable strings beginning with `aureon_`.
|
|
759
|
-
- Argument validation is strict; omit unknown fields rather than inventing them.
|
|
760
|
-
- Prefer read tools before write tools in every agent turn that mutates state.
|
|
761
|
-
- Automatic mode is the agent default; Manual mode is a human Approve surface.
|
|
762
|
-
- Prepare tools are safe to call with an API key; broadcasting is a separate host step.
|
|
763
|
-
- When summarizing restores, always include settlement type when the receipt provides it.
|
|
764
|
-
|
|
765
|
-
This reference is the canonical MCP tool surface for live agents: **54 tools**, live API, issued key (optional Bearer), and private key only outside MCP for broadcast.
|
|
1
|
+
# AUREON MCP Tool Reference
|
|
2
|
+
|
|
3
|
+
Complete reference for every tool exposed by `@buildaureon/mcp`.
|
|
4
|
+
|
|
5
|
+
Each tool maps to one public method on the `@buildaureon/sdk` client. Handlers validate arguments, call the live AUREON API, and return pretty-printed JSON (or an agent-readable error envelope).
|
|
6
|
+
|
|
7
|
+
For request/response shapes, error codes, and HTTP contracts, see the **@buildaureon/sdk documentation**.
|
|
8
|
+
|
|
9
|
+
**Tool count:** 54.
|
|
10
|
+
|
|
11
|
+
**API:** default official API `https://api.aureonlabs.network` (testnet 46630). Optional `AUREON_NETWORK=mainnet` selects chain 4663 on the same host.
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## Conventions
|
|
16
|
+
|
|
17
|
+
These conventions apply to every tool below.
|
|
18
|
+
|
|
19
|
+
| Convention | Meaning |
|
|
20
|
+
| --- | --- |
|
|
21
|
+
| Issued API key | Set `AUREON_API_KEY` to an issued Developers key. That key is product access **and** wallet identity for control-plane calls. |
|
|
22
|
+
| Optional Bearer | You may also supply a wallet Bearer (`AUREON_AUTH_TOKEN` or `aureon_verify_wallet`). If both key and Bearer are present, Bearer wins. |
|
|
23
|
+
| Default network | Official API / testnet 46630. Optional `AUREON_NETWORK=mainnet` for chain 4663. |
|
|
24
|
+
| Private key outside MCP | Deposit and withdraw **prepare** tools return unsigned steps. Signing and broadcast happen in the host wallet — never inside the MCP process. |
|
|
25
|
+
| Default automation | `aureon_create_objective` defaults `automationMode` to `"auto"`. |
|
|
26
|
+
| Locked at create | `targetSymbol` and `automationMode` are immutable after create. Recreate the objective to change them. |
|
|
27
|
+
| Unsigned prepare | `aureon_prepare_vault_deposit` and `aureon_prepare_vault_withdraw` never broadcast. |
|
|
28
|
+
| Settlement honesty | Restore / execution receipts may show `settlement: "vault"` (on-chain) or `"staged"` (ledger-local). Label them honestly. |
|
|
29
|
+
|
|
30
|
+
The catalog includes `aureon_dev_login` for preview APIs only. On hosted APIs it fails by design — agents should use an issued key (or optional Bearer) instead. The public host is still testnet 46630, not 4663.
|
|
31
|
+
|
|
32
|
+
### Auth bootstrap (agents)
|
|
33
|
+
|
|
34
|
+
1. Create an issued key in the operator utility **Developers** console.
|
|
35
|
+
2. Configure the MCP host with `AUREON_API_KEY`. Omit `AUREON_API_URL` to use the official API. Set `AUREON_NETWORK=mainnet` only for chain 4663.
|
|
36
|
+
3. Call tools. Day-to-day agent work does **not** require a wallet handshake.
|
|
37
|
+
|
|
38
|
+
Optional wallet path: `aureon_get_auth_nonce` → host signs → `aureon_verify_wallet`. Prefer issued keys for always-on agents.
|
|
39
|
+
|
|
40
|
+
### Response shape
|
|
41
|
+
|
|
42
|
+
Successful calls return structured JSON (formatted for agents). Failures return an error object with a stable code and message — see the **@buildaureon/sdk documentation** error model.
|
|
43
|
+
|
|
44
|
+
### Quick index
|
|
45
|
+
|
|
46
|
+
| Group | Tools |
|
|
47
|
+
| --- | --- |
|
|
48
|
+
| Health | `aureon_ping` |
|
|
49
|
+
| Auth & identity | `aureon_get_auth_nonce`, `aureon_verify_wallet`, `aureon_dev_login`, `aureon_logout`, `aureon_me` |
|
|
50
|
+
| Dashboard & read | `aureon_get_overview`, `aureon_get_allocation_vs_target`, `aureon_get_objective_portfolio_flow`, `aureon_get_drift_restore_flow`, `aureon_get_receipt_verification_flow`, `aureon_get_portfolio_watch_flow`, `aureon_get_full_aureon_loop_flow`, `aureon_get_portfolio`, `aureon_list_objectives`, `aureon_get_objective`, `aureon_get_health`, `aureon_list_timeline`, `aureon_list_market_presets`, `aureon_get_restore_plan`, `aureon_list_executions`, `aureon_get_vault`, `aureon_get_vault_status` |
|
|
51
|
+
| Objectives | `aureon_create_objective`, `aureon_apply_financial_intent`, `aureon_run_drift_restore_demo`, `aureon_run_receipt_verification_demo`, `aureon_run_portfolio_watch_demo`, `aureon_run_full_aureon_loop_demo`, `aureon_update_objective`, `aureon_pause_objective`, `aureon_resume_objective` |
|
|
52
|
+
| Portfolio write | `aureon_set_portfolio`, `aureon_clear_portfolio`, `aureon_sync_portfolio` |
|
|
53
|
+
| Execution | `aureon_run_execution`, `aureon_restore_objective` |
|
|
54
|
+
| Market | `aureon_apply_market_event`, `aureon_refresh_watchdog` |
|
|
55
|
+
| Vault prepare | `aureon_prepare_vault_deposit`, `aureon_prepare_vault_withdraw` |
|
|
56
|
+
| Developer keys | `aureon_list_api_keys`, `aureon_create_api_key`, `aureon_revoke_api_key`, `aureon_toggle_api_key` |
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
|
|
60
|
+
## Health
|
|
61
|
+
|
|
62
|
+
### `aureon_ping`
|
|
63
|
+
|
|
64
|
+
**Purpose:** Confirm the live API is reachable and return a lightweight service / version smoke payload.
|
|
65
|
+
|
|
66
|
+
**Typical args:** none.
|
|
67
|
+
|
|
68
|
+
**When to use:** First call in a session; connectivity checks; before diagnosing auth or policy failures.
|
|
69
|
+
|
|
70
|
+
**Caveats:** A successful ping does not prove the issued key is valid for wallet-scoped tools — follow with `aureon_me` when identity matters.
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
## Auth & identity
|
|
75
|
+
|
|
76
|
+
### `aureon_get_auth_nonce`
|
|
77
|
+
|
|
78
|
+
**Purpose:** Fetch an EIP-191 challenge message for a wallet address so the host can sign a Bearer login.
|
|
79
|
+
|
|
80
|
+
**Typical args:**
|
|
81
|
+
|
|
82
|
+
| Arg | Required | Notes |
|
|
83
|
+
| --- | --- | --- |
|
|
84
|
+
| `address` | yes | Wallet `0x…` |
|
|
85
|
+
|
|
86
|
+
**When to use:** Optional wallet handshake only. Issued API keys usually skip this path.
|
|
87
|
+
|
|
88
|
+
**Caveats:** The message must be signed by the matching wallet. Early-access wallets may still need an invite on verify.
|
|
89
|
+
|
|
90
|
+
### `aureon_verify_wallet`
|
|
91
|
+
|
|
92
|
+
**Purpose:** Exchange a signed nonce for a Bearer session and store it in-process for later tools in this MCP session.
|
|
93
|
+
|
|
94
|
+
**Typical args:**
|
|
95
|
+
|
|
96
|
+
| Arg | Required | Notes |
|
|
97
|
+
| --- | --- | --- |
|
|
98
|
+
| `address` | yes | Same wallet as the nonce |
|
|
99
|
+
| `message` | yes | From `aureon_get_auth_nonce` |
|
|
100
|
+
| `signature` | yes | Wallet signature hex |
|
|
101
|
+
| `inviteCode` | no | First-login invite when required |
|
|
102
|
+
|
|
103
|
+
**When to use:** When you intentionally want a Bearer session instead of (or in addition to) an issued key.
|
|
104
|
+
|
|
105
|
+
**Caveats:** Bearer wins over the API key when both are present. Do not ask the user for a private key — only a signature over the challenge.
|
|
106
|
+
|
|
107
|
+
### `aureon_dev_login`
|
|
108
|
+
|
|
109
|
+
**Purpose:** Preview-API shortcut that returns a Bearer session without a wallet signature.
|
|
110
|
+
|
|
111
|
+
**Typical args:** none.
|
|
112
|
+
|
|
113
|
+
**When to use:** Only on a preview / staging API that explicitly enables `AUREON_ALLOW_DEV_LOGIN=1`.
|
|
114
|
+
|
|
115
|
+
**Caveats:** Fails on `https://api.aureonlabs.network`. Do not put this tool in production agent playbooks. Prefer issued keys.
|
|
116
|
+
|
|
117
|
+
### `aureon_logout`
|
|
118
|
+
|
|
119
|
+
**Purpose:** Revoke the current Bearer session and clear the in-process token.
|
|
120
|
+
|
|
121
|
+
**Typical args:** none.
|
|
122
|
+
|
|
123
|
+
**When to use:** End a wallet session; rotate away from a Bearer after debugging.
|
|
124
|
+
|
|
125
|
+
**Caveats:** Does not revoke the issued `AUREON_API_KEY`. Key-only agents may not need this tool.
|
|
126
|
+
|
|
127
|
+
### `aureon_me`
|
|
128
|
+
|
|
129
|
+
**Purpose:** Return the wallet bound to the issued API key or the current Bearer session.
|
|
130
|
+
|
|
131
|
+
**Typical args:** none.
|
|
132
|
+
|
|
133
|
+
**When to use:** Identity confirmation after connect; every morning check; before mutating portfolio or objectives.
|
|
134
|
+
|
|
135
|
+
**Caveats:** If you see an error about env keys that cannot identify a wallet, replace the key with an **issued** Developers key.
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
## Dashboard & portfolio (read)
|
|
140
|
+
|
|
141
|
+
### `aureon_get_overview`
|
|
142
|
+
|
|
143
|
+
**Purpose:** Dashboard rollup — AUM, objective counts, aggregate health posture.
|
|
144
|
+
|
|
145
|
+
**Typical args:** none.
|
|
146
|
+
|
|
147
|
+
**When to use:** Morning checks; high-level status before diving into a single objective.
|
|
148
|
+
|
|
149
|
+
**Caveats:** Overview is a summary. Drill into `aureon_get_health` / `aureon_get_objective` for policy decisions.
|
|
150
|
+
|
|
151
|
+
### `aureon_get_allocation_vs_target`
|
|
152
|
+
|
|
153
|
+
**Purpose:** Objective vs actual portfolio — current weight vs policy target per active objective, plus a green-book/off-plan paradox flag.
|
|
154
|
+
|
|
155
|
+
**Typical args:** none.
|
|
156
|
+
|
|
157
|
+
**When to use:** demos; explain when the book is up but objectives are in warning/violation; avoid stitching overview + health manually.
|
|
158
|
+
|
|
159
|
+
**Returns:** `{ rows, paradox, overview }` — see `@buildaureon/sdk` `getAllocationVsTarget()`.
|
|
160
|
+
|
|
161
|
+
**Caveats:** Paradox detection uses 24h book change when available. Pair with `aureon_apply_market_event` (`autoRestore: false`) for rehearsal demos.
|
|
162
|
+
|
|
163
|
+
### `aureon_get_objective_portfolio_flow`
|
|
164
|
+
|
|
165
|
+
**Purpose:** Read AI → objective → portfolio flow for active objectives (intent summary, objective, health, portfolio snapshot).
|
|
166
|
+
|
|
167
|
+
**Typical args:**
|
|
168
|
+
|
|
169
|
+
| Arg | Required | Notes |
|
|
170
|
+
| --- | --- | --- |
|
|
171
|
+
| `objectiveId` | no | Filter to one objective; omit for all active |
|
|
172
|
+
|
|
173
|
+
**When to use:** — confirm intent is linked to live portfolio after `aureon_apply_financial_intent`; read-only refresh without creating a new objective.
|
|
174
|
+
|
|
175
|
+
**Returns:** Array of flow objects — see `@buildaureon/sdk` `getObjectivePortfolioFlow()`.
|
|
176
|
+
|
|
177
|
+
**Caveats:** Only active objectives are included. Pair with `aureon_get_allocation_vs_target` for ongoing objective vs actual tracking.
|
|
178
|
+
|
|
179
|
+
### `aureon_run_drift_restore_demo`
|
|
180
|
+
|
|
181
|
+
**Purpose:** Run drift → detection → restore demo in one call (seed book, create stable objective, NVDA rally with `autoRestore: false`, manual restore).
|
|
182
|
+
|
|
183
|
+
**Typical args:** none.
|
|
184
|
+
|
|
185
|
+
**When to use:** Content Arc Day 4; teach the full loop without stitching portfolio, market, plan, and restore tools.
|
|
186
|
+
|
|
187
|
+
**Returns:** `DriftRestoreFlow` — see `@buildaureon/sdk` `runDriftRestoreDemo()`.
|
|
188
|
+
|
|
189
|
+
**Caveats:** Mutates portfolio and creates a new objective. Settlement may be `vault` or `staged`. Controlled rehearsal — not discretionary trading.
|
|
190
|
+
|
|
191
|
+
### `aureon_get_drift_restore_flow`
|
|
192
|
+
|
|
193
|
+
**Purpose:** Read drift → detection → restore flow for active objectives (health, allocation row, restore plan when off-plan, latest receipt).
|
|
194
|
+
|
|
195
|
+
**Typical args:**
|
|
196
|
+
|
|
197
|
+
| Arg | Required | Notes |
|
|
198
|
+
| --- | --- | --- |
|
|
199
|
+
| `objectiveId` | no | Filter to one objective; omit for all active |
|
|
200
|
+
|
|
201
|
+
**When to use:** Confirm three-beat arc after manual steps in workflow J; read-only monitoring.
|
|
202
|
+
|
|
203
|
+
**Returns:** Array of `DriftRestoreFlow` — see `@buildaureon/sdk` `getDriftRestoreFlow()`.
|
|
204
|
+
|
|
205
|
+
**Caveats:** Inferred phases when historical aligned/drift snapshots are not stored; pair with `aureon_list_timeline` for audit trail.
|
|
206
|
+
|
|
207
|
+
### `aureon_run_receipt_verification_demo`
|
|
208
|
+
|
|
209
|
+
**Purpose:** Run receipt → verification demo (drift-restore + validate receipt + settlement lookup + timeline).
|
|
210
|
+
|
|
211
|
+
**Typical args:** none.
|
|
212
|
+
|
|
213
|
+
**When to use:** Content Arc Day 5; teach claim vs validation vs chain proof without stitching restore, validate, and settlement tools.
|
|
214
|
+
|
|
215
|
+
**Returns:** `ReceiptVerificationFlow` — see `@buildaureon/sdk` `runReceiptVerificationDemo()`.
|
|
216
|
+
|
|
217
|
+
**Caveats:** Mutates portfolio via embedded drift-restore. Validator is local — does not re-query chain. Staged receipts validate but are not chain-verified.
|
|
218
|
+
|
|
219
|
+
### `aureon_get_receipt_verification_flow`
|
|
220
|
+
|
|
221
|
+
**Purpose:** Read receipt → verification flow for execution receipts (claim, validation result, settlement lookup, timeline).
|
|
222
|
+
|
|
223
|
+
**Typical args:**
|
|
224
|
+
|
|
225
|
+
| Arg | Required | Notes |
|
|
226
|
+
| --- | --- | --- |
|
|
227
|
+
| `executionId` | no | Filter to one execution; omit for five most recent |
|
|
228
|
+
|
|
229
|
+
**When to use:** Confirm verification tier after manual steps in workflow K.
|
|
230
|
+
|
|
231
|
+
**Returns:** Array of `ReceiptVerificationFlow` — see `@buildaureon/sdk` `getReceiptVerificationFlow()`.
|
|
232
|
+
|
|
233
|
+
**Caveats:** Pair with `aureon_validate_receipt` for local checks; use `aureon_get_execution_settlement` for vault chain proof.
|
|
234
|
+
|
|
235
|
+
### `aureon_run_portfolio_watch_demo`
|
|
236
|
+
|
|
237
|
+
**Purpose:** Run portfolio watch demo (brief → Automatic objective → while-away market event with auto restore → return briefing).
|
|
238
|
+
|
|
239
|
+
**Typical args:**
|
|
240
|
+
|
|
241
|
+
| Arg | Required | Notes |
|
|
242
|
+
| --- | --- | --- |
|
|
243
|
+
| `brief` | no | User wording; default watch-while-away brief |
|
|
244
|
+
| `host` | no | `cursor` \| `claude` \| `mcp` for briefing labels |
|
|
245
|
+
|
|
246
|
+
**When to use:** Content Arc Day 6; Claude/Cursor + AUREON agent-in-host teaching.
|
|
247
|
+
|
|
248
|
+
**Returns:** `PortfolioWatchFlow` — see `@buildaureon/sdk` `runPortfolioWatchDemo()`.
|
|
249
|
+
|
|
250
|
+
**Caveats:** Mutates portfolio and objectives. Uses `autoRestore: true`. Not unsupervised trading — registered Automatic policy only.
|
|
251
|
+
|
|
252
|
+
### `aureon_get_portfolio_watch_flow`
|
|
253
|
+
|
|
254
|
+
**Purpose:** Read portfolio watch briefing for Automatic objectives.
|
|
255
|
+
|
|
256
|
+
**Typical args:**
|
|
257
|
+
|
|
258
|
+
| Arg | Required | Notes |
|
|
259
|
+
| --- | --- | --- |
|
|
260
|
+
| `objectiveId` | no | Filter to one objective |
|
|
261
|
+
| `brief` | no | User brief for summary lines |
|
|
262
|
+
| `host` | no | Agent host label |
|
|
263
|
+
|
|
264
|
+
**When to use:** Confirm briefing after manual steps in workflow L.
|
|
265
|
+
|
|
266
|
+
**Returns:** Array of `PortfolioWatchFlow` — see `@buildaureon/sdk` `getPortfolioWatchFlow()`.
|
|
267
|
+
|
|
268
|
+
### `aureon_run_full_aureon_loop_demo`
|
|
269
|
+
|
|
270
|
+
**Purpose:** Run Content Arc full AUREON loop (intent → plan check with autoRestore false → restore → receipt verification).
|
|
271
|
+
|
|
272
|
+
**Typical args:**
|
|
273
|
+
|
|
274
|
+
| Arg | Required | Notes |
|
|
275
|
+
| --- | --- | --- |
|
|
276
|
+
| `brief` | no | User wording; default full-loop brief |
|
|
277
|
+
|
|
278
|
+
**When to use:** Content Arc Day 7; positioning demo — not a portfolio tracker.
|
|
279
|
+
|
|
280
|
+
**Returns:** `FullAureonLoopFlow` — see `@buildaureon/sdk` `runFullAureonLoopDemo()`.
|
|
281
|
+
|
|
282
|
+
**Caveats:** Mutates portfolio. Uses `autoRestore: false` then manual restore. Staged receipts validate but are not chain-verified.
|
|
283
|
+
|
|
284
|
+
### `aureon_get_full_aureon_loop_flow`
|
|
285
|
+
|
|
286
|
+
**Purpose:** Read full AUREON loop for active objectives that already have an execution receipt.
|
|
287
|
+
|
|
288
|
+
**Typical args:**
|
|
289
|
+
|
|
290
|
+
| Arg | Required | Notes |
|
|
291
|
+
| --- | --- | --- |
|
|
292
|
+
| `objectiveId` | no | Filter to one objective |
|
|
293
|
+
| `brief` | no | User brief for teaching shape |
|
|
294
|
+
|
|
295
|
+
**When to use:** Confirm closed loop after manual steps in workflow M.
|
|
296
|
+
|
|
297
|
+
**Returns:** Array of `FullAureonLoopFlow` — see `@buildaureon/sdk` `getFullAureonLoopFlow()`.
|
|
298
|
+
|
|
299
|
+
### `aureon_get_portfolio`
|
|
300
|
+
|
|
301
|
+
**Purpose:** Current Capital Book snapshot — positions, marks, and weights.
|
|
302
|
+
|
|
303
|
+
**Typical args:** none.
|
|
304
|
+
|
|
305
|
+
**When to use:** After sync; before creating objectives; when explaining current exposure.
|
|
306
|
+
|
|
307
|
+
**Caveats:** Stale books mislead restore logic. Prefer `aureon_sync_portfolio` when chain balances may have changed.
|
|
308
|
+
|
|
309
|
+
### `aureon_list_objectives`
|
|
310
|
+
|
|
311
|
+
**Purpose:** List all Financial Compass objectives for the authenticated wallet.
|
|
312
|
+
|
|
313
|
+
**Typical args:** none.
|
|
314
|
+
|
|
315
|
+
**When to use:** Discover IDs; inventory auto vs paused objectives; pick a target for restore.
|
|
316
|
+
|
|
317
|
+
**Caveats:** Empty list is normal for new wallets. Create with `automationMode: "auto"` for agent-driven restores.
|
|
318
|
+
|
|
319
|
+
### `aureon_get_objective`
|
|
320
|
+
|
|
321
|
+
**Purpose:** Fetch one objective by ID (policy fields, status, locked create-time fields).
|
|
322
|
+
|
|
323
|
+
**Typical args:**
|
|
324
|
+
|
|
325
|
+
| Arg | Required | Notes |
|
|
326
|
+
| --- | --- | --- |
|
|
327
|
+
| `objectiveId` | yes | From list or create |
|
|
328
|
+
|
|
329
|
+
**When to use:** Inspect before update / pause / restore; confirm `targetSymbol` and `automationMode`.
|
|
330
|
+
|
|
331
|
+
**Caveats:** Remember `targetSymbol` and `automationMode` cannot be patched later.
|
|
332
|
+
|
|
333
|
+
### `aureon_get_health`
|
|
334
|
+
|
|
335
|
+
**Purpose:** Health / drift / breach state for one objective or all objectives.
|
|
336
|
+
|
|
337
|
+
**Typical args:**
|
|
338
|
+
|
|
339
|
+
| Arg | Required | Notes |
|
|
340
|
+
| --- | --- | --- |
|
|
341
|
+
| `objectiveId` | no | Omit for all |
|
|
342
|
+
|
|
343
|
+
**When to use:** After watchdog refresh; before restore; when the operator asks why something looks red.
|
|
344
|
+
|
|
345
|
+
**Caveats:** Health can flap after marks update. Re-read after restore instead of spamming restores.
|
|
346
|
+
|
|
347
|
+
### `aureon_list_timeline`
|
|
348
|
+
|
|
349
|
+
**Purpose:** Event timeline — objective changes, executions, health transitions.
|
|
350
|
+
|
|
351
|
+
**Typical args:**
|
|
352
|
+
|
|
353
|
+
| Arg | Required | Notes |
|
|
354
|
+
| --- | --- | --- |
|
|
355
|
+
| `objectiveId` | no | Omit for all |
|
|
356
|
+
|
|
357
|
+
**When to use:** Post-restore confirmation; audit trail for the operator; debugging unexpected state.
|
|
358
|
+
|
|
359
|
+
**Caveats:** Timeline is historical context, not a substitute for the latest health snapshot.
|
|
360
|
+
|
|
361
|
+
### `aureon_list_market_presets`
|
|
362
|
+
|
|
363
|
+
**Purpose:** List available controlled market-event presets for rehearsal.
|
|
364
|
+
|
|
365
|
+
**Typical args:** none.
|
|
366
|
+
|
|
367
|
+
**When to use:** Before `aureon_apply_market_event` in integration / demo flows.
|
|
368
|
+
|
|
369
|
+
**Caveats:** Presets are for rehearsal, not live oracle prices.
|
|
370
|
+
|
|
371
|
+
### `aureon_get_restore_plan`
|
|
372
|
+
|
|
373
|
+
**Purpose:** Inspect the proposed restore plan for an objective (steps to return to policy).
|
|
374
|
+
|
|
375
|
+
**Typical args:**
|
|
376
|
+
|
|
377
|
+
| Arg | Required | Notes |
|
|
378
|
+
| --- | --- | --- |
|
|
379
|
+
| `objectiveId` | yes | Target objective |
|
|
380
|
+
|
|
381
|
+
**When to use:** Always prefer reading the plan before `aureon_restore_objective` when explaining risk to a human.
|
|
382
|
+
|
|
383
|
+
**Caveats:** Plans can change after marks or vault balances move. Refresh health / watchdog if the book is stale.
|
|
384
|
+
|
|
385
|
+
### `aureon_list_executions`
|
|
386
|
+
|
|
387
|
+
**Purpose:** Recent execution receipts for restorative actions.
|
|
388
|
+
|
|
389
|
+
**Typical args:**
|
|
390
|
+
|
|
391
|
+
| Arg | Required | Notes |
|
|
392
|
+
| --- | --- | --- |
|
|
393
|
+
| `objectiveId` | no | Omit for all |
|
|
394
|
+
|
|
395
|
+
**When to use:** Confirm last restore; check `settlement` field (`vault` vs `staged`).
|
|
396
|
+
|
|
397
|
+
**Caveats:** Never claim on-chain settlement unless the receipt says `settlement: "vault"`.
|
|
398
|
+
|
|
399
|
+
### `aureon_get_vault`
|
|
400
|
+
|
|
401
|
+
**Purpose:** Full vault overview — balances, tokens, deposit-related history.
|
|
402
|
+
|
|
403
|
+
**Typical args:** none.
|
|
404
|
+
|
|
405
|
+
**When to use:** Funding diagnosis; after a broadcasted deposit; capital readiness reviews.
|
|
406
|
+
|
|
407
|
+
**Caveats:** Vault overview can lag until chain txs confirm and portfolio sync runs.
|
|
408
|
+
|
|
409
|
+
### `aureon_get_vault_status`
|
|
410
|
+
|
|
411
|
+
**Purpose:** Compact funding / readiness status before Automatic restores.
|
|
412
|
+
|
|
413
|
+
**Typical args:** none.
|
|
414
|
+
|
|
415
|
+
**When to use:** Morning checks; gate before creating auto objectives; after prepare+broadcast deposits.
|
|
416
|
+
|
|
417
|
+
**Caveats:** Empty vault often blocks meaningful Automatic restores — prepare a deposit and have the host sign.
|
|
418
|
+
|
|
419
|
+
---
|
|
420
|
+
|
|
421
|
+
## Portfolio (write)
|
|
422
|
+
|
|
423
|
+
### `aureon_set_portfolio`
|
|
424
|
+
|
|
425
|
+
**Purpose:** Replace the Capital Book with an explicit position list.
|
|
426
|
+
|
|
427
|
+
**Typical args:**
|
|
428
|
+
|
|
429
|
+
| Arg | Required | Notes |
|
|
430
|
+
| --- | --- | --- |
|
|
431
|
+
| `positions` | yes | Array of rows: `symbol`, `name`, `category`, `quantity`, `markPriceUsd` |
|
|
432
|
+
| `positions[].category` | yes | `stable` \| `stock_token` \| `gas` \| `other` |
|
|
433
|
+
|
|
434
|
+
**When to use:** Controlled demos or explicit book overrides when the operator supplies positions.
|
|
435
|
+
|
|
436
|
+
**Caveats:** Overwrites the book. Prefer `aureon_sync_portfolio` for live chain marks in production agent loops.
|
|
437
|
+
|
|
438
|
+
### `aureon_clear_portfolio`
|
|
439
|
+
|
|
440
|
+
**Purpose:** Clear all Capital Book positions for the authenticated wallet.
|
|
441
|
+
|
|
442
|
+
**Typical args:** none.
|
|
443
|
+
|
|
444
|
+
**When to use:** Reset before a clean sync or demo restart.
|
|
445
|
+
|
|
446
|
+
**Caveats:** Destructive. Confirm with the operator before clearing a live book.
|
|
447
|
+
|
|
448
|
+
### `aureon_sync_portfolio`
|
|
449
|
+
|
|
450
|
+
**Purpose:** Replace the Capital Book with on-chain balances for the session wallet.
|
|
451
|
+
|
|
452
|
+
**Typical args:** none.
|
|
453
|
+
|
|
454
|
+
**When to use:** Default read-path refresh; after deposits/withdraws broadcast; before create / restore.
|
|
455
|
+
|
|
456
|
+
**Caveats:** Sync does not move vault funds by itself — it refreshes the book the policy engine reads.
|
|
457
|
+
|
|
458
|
+
---
|
|
459
|
+
|
|
460
|
+
## Objectives (write)
|
|
461
|
+
|
|
462
|
+
### `aureon_create_objective`
|
|
463
|
+
|
|
464
|
+
**Purpose:** Create a Financial Compass objective. Defaults `automationMode` to `"auto"`.
|
|
465
|
+
|
|
466
|
+
**Typical args:**
|
|
467
|
+
|
|
468
|
+
| Arg | Required | Notes |
|
|
469
|
+
| --- | --- | --- |
|
|
470
|
+
| `name` | yes | Display name |
|
|
471
|
+
| `kind` | yes | `stable_allocation` \| `balanced_portfolio` \| `risk_ceiling` \| `reward_reinvestment` |
|
|
472
|
+
| `targetWeight` | yes | 0–1 |
|
|
473
|
+
| `tolerance` | yes | Drift band 0–1 |
|
|
474
|
+
| `priority` | no | `low` \| `medium` \| `high` \| `critical` |
|
|
475
|
+
| `maxRiskScore` | no | For risk-ceiling kinds |
|
|
476
|
+
| `reinvestRatio` | no | For reward kinds |
|
|
477
|
+
| `targetSymbol` | no | Asset symbol (nullable); **locked after create** |
|
|
478
|
+
| `automationMode` | no | `auto` \| `manual`; default **`auto`**; **locked after create** |
|
|
479
|
+
|
|
480
|
+
**When to use:** New policy intent (e.g. maintain ~15% WETH automatically).
|
|
481
|
+
|
|
482
|
+
**Caveats:** Agents should use **Automatic** (`auto`) unless the human explicitly wants Manual Approve. To change symbol or mode later, create a new objective (pause or leave the old one).
|
|
483
|
+
|
|
484
|
+
### `aureon_apply_financial_intent`
|
|
485
|
+
|
|
486
|
+
**Purpose:** Register user/agent intent as an Automatic objective and return the full AI → objective → portfolio flow in one call.
|
|
487
|
+
|
|
488
|
+
**Typical args:**
|
|
489
|
+
|
|
490
|
+
| Arg | Required | Notes |
|
|
491
|
+
| --- | --- | --- |
|
|
492
|
+
| `brief` | yes | What the user wants their money to do — agent-extracted wording |
|
|
493
|
+
| `kind` | yes | `stable_allocation` \| `balanced_portfolio` \| `risk_ceiling` \| `reward_reinvestment` |
|
|
494
|
+
| `targetWeight` | yes | 0–1 |
|
|
495
|
+
| `tolerance` | yes | Drift band 0–1 |
|
|
496
|
+
| `targetSymbol` | no | Asset symbol for `balanced_portfolio` |
|
|
497
|
+
| `name` | no | Display name override |
|
|
498
|
+
| `priority` | no | `low` \| `medium` \| `high` \| `critical` |
|
|
499
|
+
|
|
500
|
+
**When to use:** turn structured agent intent into persistent policy without stitching create + health + portfolio calls.
|
|
501
|
+
|
|
502
|
+
**Returns:** `{ intent, objective, health, portfolio, message }` — see `@buildaureon/sdk` `applyFinancialIntent()`.
|
|
503
|
+
|
|
504
|
+
**Caveats:** Agent must supply structured fields; `brief` is for audit/teaching, not autonomous NLU. Creates a new objective each call.
|
|
505
|
+
|
|
506
|
+
### `aureon_update_objective`
|
|
507
|
+
|
|
508
|
+
**Purpose:** Partial update of mutable fields (name, weight, tolerance, priority, optional risk/reinvest fields).
|
|
509
|
+
|
|
510
|
+
**Typical args:**
|
|
511
|
+
|
|
512
|
+
| Arg | Required | Notes |
|
|
513
|
+
| --- | --- | --- |
|
|
514
|
+
| `objectiveId` | yes | Target |
|
|
515
|
+
| `name` | no | Display name |
|
|
516
|
+
| `priority` | no | Priority enum |
|
|
517
|
+
| `targetWeight` | no | 0–1 |
|
|
518
|
+
| `tolerance` | no | 0–1 |
|
|
519
|
+
| `maxRiskScore` | no | Optional |
|
|
520
|
+
| `reinvestRatio` | no | Optional |
|
|
521
|
+
|
|
522
|
+
**When to use:** Tighten tolerance; rename; adjust weight without changing token or automation mode.
|
|
523
|
+
|
|
524
|
+
**Caveats:** **Cannot** change `targetSymbol` or `automationMode`. If the API rejects those fields, recreate instead.
|
|
525
|
+
|
|
526
|
+
### `aureon_pause_objective`
|
|
527
|
+
|
|
528
|
+
**Purpose:** Pause continuous evaluation for an objective.
|
|
529
|
+
|
|
530
|
+
**Typical args:** `objectiveId` (required).
|
|
531
|
+
|
|
532
|
+
**When to use:** Temporary halt during funding, maintenance, or operator review.
|
|
533
|
+
|
|
534
|
+
**Caveats:** Paused objectives will not drive Automatic restores until resumed.
|
|
535
|
+
|
|
536
|
+
### `aureon_resume_objective`
|
|
537
|
+
|
|
538
|
+
**Purpose:** Resume evaluation for a paused objective.
|
|
539
|
+
|
|
540
|
+
**Typical args:** `objectiveId` (required).
|
|
541
|
+
|
|
542
|
+
**When to use:** After funding the vault or finishing a maintenance window.
|
|
543
|
+
|
|
544
|
+
**Caveats:** Re-check health after resume; a breach may already exist.
|
|
545
|
+
|
|
546
|
+
---
|
|
547
|
+
|
|
548
|
+
## Compass / execution
|
|
549
|
+
|
|
550
|
+
### `aureon_run_execution`
|
|
551
|
+
|
|
552
|
+
**Purpose:** Run restorative execution for an objective currently outside policy.
|
|
553
|
+
|
|
554
|
+
**Typical args:** `objectiveId` (required).
|
|
555
|
+
|
|
556
|
+
**When to use:** Explicit execution path when the product flow calls for `runExecution` rather than vault-backed restore.
|
|
557
|
+
|
|
558
|
+
**Caveats:** Prefer reading health / plan first. Report settlement type honestly from the receipt.
|
|
559
|
+
|
|
560
|
+
### `aureon_restore_objective`
|
|
561
|
+
|
|
562
|
+
**Purpose:** Run restorative execution for an objective outside policy. Not always vault-backed.
|
|
563
|
+
|
|
564
|
+
**Typical args:** `objectiveId` (required).
|
|
565
|
+
|
|
566
|
+
**When to use:** After a clear breach and a reviewed restore plan.
|
|
567
|
+
|
|
568
|
+
**Caveats:** Automatic + configured vault that cannot execute returns 409 — it does not record a vault restore. Manual may produce a staged (ledger-local) receipt. Empty vault blocks Automatic on-chain restore; return unsigned `aureon_prepare_vault_deposit` steps and wait for the user. Confirm with `aureon_list_timeline` / `aureon_list_executions`. Read `settlement`, `verifiedOnChain`, `explorerUrl`, and `registryRef` on every receipt.
|
|
569
|
+
|
|
570
|
+
### How to read a receipt (agents)
|
|
571
|
+
|
|
572
|
+
1. Call `aureon_list_executions` or use the receipt from restore/run.
|
|
573
|
+
2. Check **`settlement`**: `vault` vs `staged` — never claim on-chain for `staged`.
|
|
574
|
+
3. If **`explorerUrl`** is present, the vault tx can be verified on the explorer.
|
|
575
|
+
4. If **`registryRef`** is present, the objective was registered on ObjectiveRegistry.
|
|
576
|
+
5. Match **`aureon_list_timeline`** events via `payload.executionId === receipt.id`.
|
|
577
|
+
6. For vault receipts, check **`verifiedOnChain`**. When true, cite **`settlementRecord`** or call **`aureon_get_execution_settlement`**. Never invent chain proof when `verifiedOnChain` is false.
|
|
578
|
+
|
|
579
|
+
### `aureon_get_execution_settlement`
|
|
580
|
+
|
|
581
|
+
**Purpose:** Returns the durable on-chain settlement record for a vault execution when the API listener observed a `Rebalanced` event.
|
|
582
|
+
|
|
583
|
+
**When to use:** After a vault restore when you need independent chain proof (tx hash, block, token pair, amounts).
|
|
584
|
+
|
|
585
|
+
**Caveats:** Staged executions return `verifiedOnChain: false` with no settlement. Vault without listener confirmation is **not** chain-verified — say “vault submitted, not yet observed on-chain.”
|
|
586
|
+
|
|
587
|
+
### `aureon_list_settlements`
|
|
588
|
+
|
|
589
|
+
**Purpose:** Lists settlement records for the wallet (optional `objectiveId` filter). May include orphans — observed vault events not yet bound to an execution.
|
|
590
|
+
|
|
591
|
+
**When to use:** Audit trail review; cross-check multiple restores. Read `status` and `executionId` before claiming proof.
|
|
592
|
+
|
|
593
|
+
### `aureon_validate_receipt`
|
|
594
|
+
|
|
595
|
+
**Purpose:** Validates an execution receipt locally (no API call). Returns `{ valid, issues }`.
|
|
596
|
+
|
|
597
|
+
**When to use:** After `aureon_restore_objective` or `aureon_list_executions` — confirm the receipt is honest before reporting to the operator.
|
|
598
|
+
|
|
599
|
+
**Caveats:** Validation is schema + policy only; it does not re-fetch chain state. If `valid: false`, quote `issues` and do not claim on-chain settlement.
|
|
600
|
+
|
|
601
|
+
---
|
|
602
|
+
|
|
603
|
+
## Market
|
|
604
|
+
|
|
605
|
+
### `aureon_apply_market_event`
|
|
606
|
+
|
|
607
|
+
**Purpose:** Apply a controlled mark shock to a symbol for integration rehearsal; optionally trigger auto-restore.
|
|
608
|
+
|
|
609
|
+
**Typical args:**
|
|
610
|
+
|
|
611
|
+
| Arg | Required | Notes |
|
|
612
|
+
| --- | --- | --- |
|
|
613
|
+
| `symbol` | yes | e.g. `TSLA` |
|
|
614
|
+
| `priceChangeRatio` | yes | Fractional change (`-0.1` = −10%) |
|
|
615
|
+
| `name` | no | Event label |
|
|
616
|
+
| `description` | no | Human description |
|
|
617
|
+
| `autoRestore` | no | If true, may run restorative execution on breach |
|
|
618
|
+
|
|
619
|
+
**When to use:** Demo / rehearsal of drift → plan → restore. Not for production price discovery.
|
|
620
|
+
|
|
621
|
+
**Caveats:** Do not treat rehearsal shocks as live oracle prices for real capital decisions.
|
|
622
|
+
|
|
623
|
+
### `aureon_refresh_watchdog`
|
|
624
|
+
|
|
625
|
+
**Purpose:** Refresh portfolio marks from live data and re-evaluate objectives.
|
|
626
|
+
|
|
627
|
+
**Typical args:** none.
|
|
628
|
+
|
|
629
|
+
**When to use:** Morning checks; after market events; before reading health for restore decisions.
|
|
630
|
+
|
|
631
|
+
**Caveats:** Refresh alone does not restore. Follow with health / plan / restore as needed.
|
|
632
|
+
|
|
633
|
+
---
|
|
634
|
+
|
|
635
|
+
## Vault
|
|
636
|
+
|
|
637
|
+
### `aureon_prepare_vault_deposit`
|
|
638
|
+
|
|
639
|
+
**Purpose:** Prepare **unsigned** vault deposit steps for a symbol and amount.
|
|
640
|
+
|
|
641
|
+
**Typical args:**
|
|
642
|
+
|
|
643
|
+
| Arg | Required | Notes |
|
|
644
|
+
| --- | --- | --- |
|
|
645
|
+
| `symbol` | yes | `ETH` or allowlisted ERC-20 |
|
|
646
|
+
| `amount` | yes | Human-readable amount string |
|
|
647
|
+
|
|
648
|
+
**When to use:** Fund the vault so Automatic restores can settle on-chain.
|
|
649
|
+
|
|
650
|
+
**Caveats:** Returns calldata / steps only. The **host** must sign and broadcast with a private key **outside** MCP. API key alone cannot move funds. After broadcast, sync and re-check vault status.
|
|
651
|
+
|
|
652
|
+
### `aureon_prepare_vault_withdraw`
|
|
653
|
+
|
|
654
|
+
**Purpose:** Prepare **unsigned** vault withdraw steps.
|
|
655
|
+
|
|
656
|
+
**Typical args:**
|
|
657
|
+
|
|
658
|
+
| Arg | Required | Notes |
|
|
659
|
+
| --- | --- | --- |
|
|
660
|
+
| `amount` | yes | Human-readable amount string |
|
|
661
|
+
| `symbol` | no | Default WETH (not ETH) |
|
|
662
|
+
|
|
663
|
+
**When to use:** Operator-directed withdrawals after confirming vault balances.
|
|
664
|
+
|
|
665
|
+
**Caveats:** Same non-custodial boundary as deposit — prepare ≠ completed withdrawal until the host broadcasts.
|
|
666
|
+
|
|
667
|
+
---
|
|
668
|
+
|
|
669
|
+
## Developer API keys
|
|
670
|
+
|
|
671
|
+
### `aureon_list_api_keys`
|
|
672
|
+
|
|
673
|
+
**Purpose:** List API key metadata for the authenticated wallet (no secrets).
|
|
674
|
+
|
|
675
|
+
**Typical args:** none.
|
|
676
|
+
|
|
677
|
+
**When to use:** Inventory keys; find IDs for toggle / revoke.
|
|
678
|
+
|
|
679
|
+
**Caveats:** Secrets are never re-listed after create. Metadata only.
|
|
680
|
+
|
|
681
|
+
### `aureon_create_api_key`
|
|
682
|
+
|
|
683
|
+
**Purpose:** Create a new issued SDK API key. The secret is returned **once**.
|
|
684
|
+
|
|
685
|
+
**Typical args:**
|
|
686
|
+
|
|
687
|
+
| Arg | Required | Notes |
|
|
688
|
+
| --- | --- | --- |
|
|
689
|
+
| `name` | yes | Display name (min length enforced) |
|
|
690
|
+
|
|
691
|
+
**When to use:** Rotate or provision a new agent key under an already-authenticated identity.
|
|
692
|
+
|
|
693
|
+
**Caveats:** Treat the returned secret like a password. Do not echo it into public chat logs. Store it in the MCP host env as `AUREON_API_KEY`.
|
|
694
|
+
|
|
695
|
+
### `aureon_revoke_api_key`
|
|
696
|
+
|
|
697
|
+
**Purpose:** Permanently revoke (delete) an issued API key.
|
|
698
|
+
|
|
699
|
+
**Typical args:** `keyId` (required).
|
|
700
|
+
|
|
701
|
+
**When to use:** Key compromise; decommissioning an agent.
|
|
702
|
+
|
|
703
|
+
**Caveats:** Irreversible for that key material. Confirm the ID from `aureon_list_api_keys`.
|
|
704
|
+
|
|
705
|
+
### `aureon_toggle_api_key`
|
|
706
|
+
|
|
707
|
+
**Purpose:** Pause or unpause an API key without revoking it.
|
|
708
|
+
|
|
709
|
+
**Typical args:** `keyId` (required).
|
|
710
|
+
|
|
711
|
+
**When to use:** Temporary freeze during investigation; soft disable without rotation.
|
|
712
|
+
|
|
713
|
+
**Caveats:** Toggled-off keys fail subsequent control-plane calls until re-enabled.
|
|
714
|
+
|
|
715
|
+
### `aureon_get_audit_trail`
|
|
716
|
+
|
|
717
|
+
**Purpose:** Export one objective’s financial audit trail — registry, receipts, settlements, timeline — in a single object.
|
|
718
|
+
|
|
719
|
+
**Typical args:** `objectiveId` (required).
|
|
720
|
+
|
|
721
|
+
**When to use:** “Did this restore actually happen?” / follow intent → receipt → settlement without stitching four tools.
|
|
722
|
+
|
|
723
|
+
**Caveats:** Missing proof is labeled as a gap. Staged receipts are never on-chain. Do not invent explorer links or `verifiedOnChain`. Testnet only.
|
|
724
|
+
|
|
725
|
+
---
|
|
726
|
+
|
|
727
|
+
## Prompt → tool mapping
|
|
728
|
+
|
|
729
|
+
| Operator ask | Tool(s) |
|
|
730
|
+
| --- | --- |
|
|
731
|
+
| “Is the API up?” | `aureon_ping` |
|
|
732
|
+
| “Which wallet am I?” | `aureon_me` |
|
|
733
|
+
| “Refresh balances from chain” | `aureon_sync_portfolio` |
|
|
734
|
+
| “Is the vault funded?” | `aureon_get_vault_status` |
|
|
735
|
+
| “Maintain 20% WETH automatic” | `aureon_create_objective` (`automationMode: auto`, `targetSymbol: WETH`) |
|
|
736
|
+
| “Why is health red?” | `aureon_get_health`, `aureon_list_timeline` |
|
|
737
|
+
| “Show the restore plan” | `aureon_get_restore_plan` |
|
|
738
|
+
| “Execute restore” | `aureon_restore_objective` |
|
|
739
|
+
| “Export the audit trail” | `aureon_get_audit_trail` |
|
|
740
|
+
| “Simulate −10% TSLA” | `aureon_apply_market_event` |
|
|
741
|
+
| “Prepare 0.1 ETH deposit” | `aureon_prepare_vault_deposit` then host signs |
|
|
742
|
+
| “Rotate my agent key” | `aureon_create_api_key` (+ secure store), optional `aureon_revoke_api_key` |
|
|
743
|
+
|
|
744
|
+
---
|
|
745
|
+
|
|
746
|
+
## Related reading
|
|
747
|
+
|
|
748
|
+
- [Agent guide](./agent-guide.md) — read → decide → act playbooks
|
|
749
|
+
- [Auth](./auth.md) — issued key, optional Bearer, private-key boundary
|
|
750
|
+
- [Setup](./setup.md) — host configuration for Cursor / Claude Desktop
|
|
751
|
+
- [Security](./security.md) — stdio trust boundary and key hygiene
|
|
752
|
+
- **@buildaureon/sdk documentation** — typed client methods, data contracts, error model
|
|
753
|
+
|
|
754
|
+
---
|
|
755
|
+
|
|
756
|
+
## Notes for implementers
|
|
757
|
+
|
|
758
|
+
- Tool names are stable strings beginning with `aureon_`.
|
|
759
|
+
- Argument validation is strict; omit unknown fields rather than inventing them.
|
|
760
|
+
- Prefer read tools before write tools in every agent turn that mutates state.
|
|
761
|
+
- Automatic mode is the agent default; Manual mode is a human Approve surface.
|
|
762
|
+
- Prepare tools are safe to call with an API key; broadcasting is a separate host step.
|
|
763
|
+
- When summarizing restores, always include settlement type when the receipt provides it.
|
|
764
|
+
|
|
765
|
+
This reference is the canonical MCP tool surface for live agents: **54 tools**, live API, issued key (optional Bearer), and private key only outside MCP for broadcast.
|