@buildaureon/mcp 0.1.1 → 0.1.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +399 -399
- package/dist/index.js +330 -8
- package/dist/index.js.map +1 -1
- package/docs/agent-guide.md +186 -2
- package/docs/auth.md +2 -2
- package/docs/setup.md +3 -3
- package/docs/tools.md +219 -7
- package/package.json +3 -2
package/docs/tools.md
CHANGED
|
@@ -6,7 +6,7 @@ Each tool maps to one public method on the `@buildaureon/sdk` client. Handlers v
|
|
|
6
6
|
|
|
7
7
|
For request/response shapes, error codes, and HTTP contracts, see the **@buildaureon/sdk documentation**.
|
|
8
8
|
|
|
9
|
-
**Tool count:**
|
|
9
|
+
**Tool count:** 52.
|
|
10
10
|
|
|
11
11
|
**API:** `https://api.aureonlabs.network` (Robinhood Chain L2, early access).
|
|
12
12
|
|
|
@@ -47,8 +47,8 @@ Successful calls return structured JSON (formatted for agents). Failures return
|
|
|
47
47
|
| --- | --- |
|
|
48
48
|
| Health | `aureon_ping` |
|
|
49
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_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_update_objective`, `aureon_pause_objective`, `aureon_resume_objective` |
|
|
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
52
|
| Portfolio write | `aureon_set_portfolio`, `aureon_clear_portfolio`, `aureon_sync_portfolio` |
|
|
53
53
|
| Execution | `aureon_run_execution`, `aureon_restore_objective` |
|
|
54
54
|
| Market | `aureon_apply_market_event`, `aureon_refresh_watchdog` |
|
|
@@ -148,6 +148,154 @@ Successful calls return structured JSON (formatted for agents). Failures return
|
|
|
148
148
|
|
|
149
149
|
**Caveats:** Overview is a summary. Drill into `aureon_get_health` / `aureon_get_objective` for policy decisions.
|
|
150
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
|
+
|
|
151
299
|
### `aureon_get_portfolio`
|
|
152
300
|
|
|
153
301
|
**Purpose:** Current Capital Book snapshot — positions, marks, and weights.
|
|
@@ -333,6 +481,28 @@ Successful calls return structured JSON (formatted for agents). Failures return
|
|
|
333
481
|
|
|
334
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).
|
|
335
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
|
+
|
|
336
506
|
### `aureon_update_objective`
|
|
337
507
|
|
|
338
508
|
**Purpose:** Partial update of mutable fields (name, weight, tolerance, priority, optional risk/reinvest fields).
|
|
@@ -389,13 +559,44 @@ Successful calls return structured JSON (formatted for agents). Failures return
|
|
|
389
559
|
|
|
390
560
|
### `aureon_restore_objective`
|
|
391
561
|
|
|
392
|
-
**Purpose:** Run
|
|
562
|
+
**Purpose:** Run restorative execution for an objective outside policy. Not always vault-backed.
|
|
393
563
|
|
|
394
564
|
**Typical args:** `objectiveId` (required).
|
|
395
565
|
|
|
396
|
-
**When to use:** After a clear breach and a reviewed restore plan
|
|
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 stage a fake restore. Manual may stage. Empty vault blocks Automatic on-chain restore. 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`
|
|
397
580
|
|
|
398
|
-
**
|
|
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.
|
|
399
600
|
|
|
400
601
|
---
|
|
401
602
|
|
|
@@ -511,6 +712,16 @@ Successful calls return structured JSON (formatted for agents). Failures return
|
|
|
511
712
|
|
|
512
713
|
**Caveats:** Toggled-off keys fail subsequent control-plane calls until re-enabled.
|
|
513
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
|
+
|
|
514
725
|
---
|
|
515
726
|
|
|
516
727
|
## Prompt → tool mapping
|
|
@@ -525,6 +736,7 @@ Successful calls return structured JSON (formatted for agents). Failures return
|
|
|
525
736
|
| “Why is health red?” | `aureon_get_health`, `aureon_list_timeline` |
|
|
526
737
|
| “Show the restore plan” | `aureon_get_restore_plan` |
|
|
527
738
|
| “Execute restore” | `aureon_restore_objective` |
|
|
739
|
+
| “Export the audit trail” | `aureon_get_audit_trail` |
|
|
528
740
|
| “Simulate −10% TSLA” | `aureon_apply_market_event` |
|
|
529
741
|
| “Prepare 0.1 ETH deposit” | `aureon_prepare_vault_deposit` then host signs |
|
|
530
742
|
| “Rotate my agent key” | `aureon_create_api_key` (+ secure store), optional `aureon_revoke_api_key` |
|
|
@@ -550,4 +762,4 @@ Successful calls return structured JSON (formatted for agents). Failures return
|
|
|
550
762
|
- Prepare tools are safe to call with an API key; broadcasting is a separate host step.
|
|
551
763
|
- When summarizing restores, always include settlement type when the receipt provides it.
|
|
552
764
|
|
|
553
|
-
This reference is the canonical MCP tool surface for live agents: **
|
|
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.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@buildaureon/mcp",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.7",
|
|
4
4
|
"description": "MCP server for AUREON Financial Compass: Financial Compass capital context for AI agents",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -28,6 +28,7 @@
|
|
|
28
28
|
"typecheck": "tsc -p tsconfig.json --noEmit",
|
|
29
29
|
"test": "tsx --test tests/**/*.test.ts",
|
|
30
30
|
"test:e2e": "tsx tests/e2e-full.mjs",
|
|
31
|
+
"test:phase2": "tsx tests/verify-phase2-session.mjs",
|
|
31
32
|
"test:live-agent": "tsx tests/live-agent-exercise.mjs",
|
|
32
33
|
"verify": "tsx tests/verify-agent.ts"
|
|
33
34
|
},
|
|
@@ -48,7 +49,7 @@
|
|
|
48
49
|
"node": ">=20"
|
|
49
50
|
},
|
|
50
51
|
"dependencies": {
|
|
51
|
-
"@buildaureon/sdk": "
|
|
52
|
+
"@buildaureon/sdk": "0.1.7",
|
|
52
53
|
"@modelcontextprotocol/sdk": "^1.12.1",
|
|
53
54
|
"zod": "^3.25.67"
|
|
54
55
|
},
|