@retiregolden/mcp
v0.7.1
Published
Model Context Protocol server for the RetireGolden retirement-planning engine: headless, in-memory sessions over stdio (and optional HTTP).
Downloads
2,235
Maintainers
Readme
RetireGolden MCP
Headless Model Context Protocol server for the
@retiregolden/engine
retirement-planning calculator.
Run it locally over stdio, connect your AI client (Claude Desktop, Cursor, etc.), and call typed tools: build/validate a plan, run projections, Monte Carlo, batch policy evaluation, and optimization — with session state held in memory (no disk required).
npm: @retiregolden/mcp
License: AGPL-3.0-only (server); MIT (skills under skills/)
RetireGolden Pro ships this same package pre-wired in the desktop app for out-of-the-box convenience. Anyone can install and run the public package.
Disclaimer
Educational / decision-support only — not tax, legal, or financial advice. See DISCLAIMER.md.
Quick start
npx @retiregolden/mcp
# or
npm install -g @retiregolden/mcp
retiregolden-mcpConfigure your MCP client to launch retiregolden-mcp (or
npx @retiregolden/mcp) over stdio.
Example Claude Desktop / Cursor snippet
{
"mcpServers": {
"retiregolden": {
"command": "npx",
"args": ["-y", "@retiregolden/mcp"]
}
}
}Connect your AI client
Per-client, copy-paste setup for Claude Desktop, Claude Code, Cursor, and Codex
(MCP config + agent skill / rules) is in docs/clients.md.
Tools (v1)
Read-only with respect to your finances and disk: no trades, no persistence.
Session state (e.g. build_plan, clear_session) is held in memory only.
| Tool | Purpose |
|---|---|
| build_plan | Build an in-memory plan from typed household/policy params or full plan JSON |
| validate_plan | Validate the current session plan (or supplied JSON) |
| run_projection | Deterministic year-by-year projection |
| run_monte_carlo | Stochastic success rate and required-floor success rate |
| batch_evaluate | Evaluate many policies against one household (search-friendly) |
| run_optimizer | Engine optimizer / conversion schedule search |
| solve_max_spending | Sustainable-spending bisection |
| compare_scenarios | Diff two projection summaries |
| explain_modeled_result | Compact evidence / assumptions / limitations payload |
| export_plan | Return the session plan as full plan JSON (round-trips via build_plan) |
| describe_plan_schema | Return the engine's versioned Plan JSON Schema (full or a path subtree); also served as the plan-schema MCP resource |
| update_plan | Incrementally merge account/income/assumption/expense fragments into the session plan (validate-before-commit) |
| get_session / clear_session | Inspect or reset in-memory session |
Agent skill
See skills/retiregolden/SKILL.md (MIT). Bench
and product runners should pin the skill file digest used for scored runs.
npm publish
Releases are tag-driven: pushing a mcp-v<version> tag triggers the publish
workflow (see .github/workflows/publish-mcp.yml).
To run locally after npm run build:
node bin/retiregolden-mcp.jsRelated
- Engine: https://github.com/RetireGolden/RetireGolden/tree/main/packages/engine
- Benchmark harness: https://github.com/RetireGolden/RetireBench
- Free planner (no MCP — browser only): https://retiregolden.app/
Trademark
See TRADEMARKS.md. Forks must rename.
