xp-mcp
<div align="center">
# portfolio-mcp
**Talk to your XP Investimentos portfolio through Claude β 100% local, read-only, zero scraping.**
[](https://www.typescriptlang.org/)
[](https://nodejs.org/)
[](https://modelcontextprotocol.io/)
[](./LICENSE)
[](https://www.npmjs.com/package/portfolio-mcp)
[](#roadmap)
</div>
---
## What is this?
`portfolio-mcp` is a [Model Context Protocol](https://modelcontextprotocol.io/) server that exposes your **XP Investimentos** portfolio to Claude Desktop (or any MCP-compatible client). You feed it the official PDF/CSV exports XP already gives you β the server parses them, normalizes everything into a local SQLite database, and answers questions through MCP tools.
- π **Local-first** β data lives in `~/.xp-mcp/data.db`. Core tools make zero outbound HTTP calls; advisor tools (v0.4+) are opt-in.
- π΅ **No credentials, no scraping** β you control what goes in (PDF/CSV exports).
- π **Read-only by design** β no tool can place orders or modify anything at XP.
- π§± **Stdio transport** β Claude spawns the process; nothing listens on a port.
> Built for personal use, but the architecture works for any custodian that lets you export reports (Rico, NuInvest, Inter, Avenue, ...). PRs welcome.
---
## Why does this exist?
Custodian apps are great at *"show me what I have"* but terrible at:
- *"Compare my current allocation against my target portfolio."*
- *"Which of my CDBs mature in the next 12 months?"*
- *"What's my real yield-to-maturity weighted by position size?"*
- *"How concentrated am I in a single issuer's FGC limit?"*
MCP lets you bolt that intelligence onto Claude **without** giving the LLM provider your credentials, sending your positions to a third-party SaaS, or trusting browser-scraping that breaks every quarter.
---
## Demo
After connecting the server, just chat with Claude:
```text
You: Liste minhas posiΓ§Γ΅es agrupadas por classe de ativo.
Claude (using portfolio-mcp.get_positions):
TESOURO (53.28%) R$ 16,644.31
β’ Tesouro Selic 2031 R$ 14,556.80
β’ Tesouro Selic 2028 R$ 2,087.51
RENDA_FIXA_PRIVADA (20.98%) R$ 6,554.32
β’ CDB BANCO XP - AGO/2026 - 15,00% R$ 2,203.85
β’ CDB BANCO XP - SET/2026 - 14,95% R$ 2,197.10
β’ CDB BANCO XP - OUT/2026 - 14,55% R$ 1,083.63
β’ CDB BANCO XP - NOV/2027 - 100,00% CDI R$ 1,069.74
FUNDO (10.48%) R$ 3,273.71
ACAO ( 7.44%) R$ 2,325.12 (BBAS3)
FII ( 7.81%) R$ 2,439.20 (MXRF11, GTWR11)
Total: R$ 31,236.66
You: Quais CDBs vencem em 2026?
Claude (filters by asset_class + maturity_date):
3 CDBs maturing in 2026:
β’ Aug/2026 β 15.00% pre-fixed R$ 2,203.85
β’ Sep/2026 β 14.95% pre-fixed R$ 2,197.10
β’ Oct/2026 β 14.55% pre-fixed R$ 1,083.63
All issued by BANCO XP S.A. (within single-issuer FGC limit β)
You: Estou bem alocado em relaΓ§Γ£o ao meu target?
Claude (using portfolio-mcp.calculate_allocation_drift):
Lendo ~/.xp-mcp/allocation.json (target: 40% Tesouro, 20% RF, 15% FII,
15% AΓ§Γ΅es, 5% ETF, 5% Fundos, tolerΓ’ncia Β±2pp).
Mais fora do alvo:
β’ TESOURO: 53.28% (target 40%) β vender ~R$ 4.148
β’ ACAO: 7.44% (target 15%) β comprar ~R$ 2.362
β’ FII: 7.81% (target 15%) β comprar ~R$ 2.247
Dentro da banda:
β’ RENDA_FIXA_PRIVADA: 20.98% (target 20%) β
Fora da banda, magnitude menor:
β’ FUNDO: 10.48% (target 5%) β vender ~R$ 1.712
β’ ETF: 0.00% (target 5%) β comprar ~R$ 1.562
Net rebalance: -R$ 152 (aporte pequeno sugerido pra fechar).
You: Me dΓ‘ um panorama do meu portfΓ³lio.
Claude (using portfolio-mcp.get_portfolio_summary):
Total: R$ 31.236,66 (12 posiΓ§Γ΅es, ref. 2026-05-21)
P&L: +R$ 2.736,66 (+9,60% sobre R$ 28.500 investidos Β· 8/12 com P&L computΓ‘vel)
Por classe:
TESOURO 53,28% R$ 16.644,31
RENDA_FIXA_PRIVADA 20,98% R$ 6.554,32 (+4,04%)
FUNDO 10,48% R$ 3.273,71
ACAO 7,44% R$ 2.325,12
FII 7,81% R$ 2.439,20
FGC: R$ 6.554,32 (20,98%) cobertos
Vencimentos: curto R$ 5.484 Β· mΓ©dio R$ 16.625 Β· longo R$ 1.070 Β· sem maturity R$ 8.038
ReconciliaΓ§Γ£o: declarado R$ 31.250,00 vs computado R$ 31.236,66
β gap βR$ 13,34 (β0,04%, dentro de tolerΓ’ncia)
```
---
## Architecture
```text
βββββββββββββββββββ
β Claude Desktop β
ββββββββββ¬βββββββββ
β stdio (JSON-RPC 2.0)
βΌ
βββββββββββββββββββββββ PDF / CSV ββββββββββββββββββββββββ
β portfolio-mcp βββββββββββββββββββββββββ XP exports β
β TypeScript + MCP β β (your machine) β
ββββββββββ¬βββββββββββββ ββββββββββββββββββββββββ
β SQL (better-sqlite3, WAL mode)
βΌ
βββββββββββββββββββββββ
β SQLite β
β ~/.xp-mcp/ β
βββββββββββββββββββββββ
No network. No credentials. Read-only at XP.
```
**Stack:** TypeScript Β· [`@modelcontextprotocol/sdk`](https://github.com/modelcontextprotocol/typescript-sdk) Β· `better-sqlite3` Β· `pdf-parse` Β· `papaparse` Β· `zod`
---
## Tools
| Tool | Purpose | Status |
| ----------------------------- | -------------------------------------------------------------------------------------- | :----: |
| `import_xperformance_pdf` | Parse XP's official portfolio PDF (XPerformance). Idempotent on re-import. | β
|
| `import_extract_csv` | Parse a PosiΓ§Γ£o Consolidada / Extrato CSV. Auto-detects delimiter and column aliases. | β
|
| `get_positions` | List positions with quantity, market value, indexer, maturity. Optional class filter. | β
|
| `get_portfolio_summary` | Aggregate stats + declared-vs-computed reconciliation gap. Output now includes a `cash_flow_summary` block (YTD + rolling 12m aporte/resgate aggregates) when cash flows have been imported. | β
|
| `get_transactions` | History of buys/sells | β³ |
| `get_dividends` | Income / proventos | β³ |
| `calculate_allocation_drift` | Compare current vs target allocation from `~/.xp-mcp/allocation.json`. Returns drift %, BRL delta, and BUY/SELL suggestions per class. | β
|
| `set_advisor_profile` | Save the advisor profile (risk, horizon, objective, exclusions, outbound gate, brapi token). | β
|
| `get_advisor_profile` | Read the saved profile. Returns `exists: false` if not configured. | β
|
| `get_market_data` | Quotes / fundamentals from brapi.dev for 1-50 tickers, SQLite-cached. Opt-in. | β
|
| `screen_assets` | Rank B3 FIIs / stocks / ETFs by DY, P/VP, P/L, ROE, market cap. Opt-in. | β
|
| `import_nota_corretagem` | Parse broker-note PDFs for transaction history | β³ |
| `import_bank_extract_pdf` | Import a PDF exported from XP's Conta Digital Extrato. Filters for investment-account transfers only (APORTE/RESGATE). Idempotent. | β
|
| `get_cash_flows` | List cash flows with optional date/kind filters; returns aggregate totals (aporte/resgate/net) over all matching rows. | β
|
| `suggest_buys` | Suggest BUYs per underweight class using profile objective Γ asset class matrix (FII/ACAO/ETF). Non-screenable classes (TESOURO/RF/FUNDO) reported in `skipped_classes`. Requires `outbound_enabled=true`. | β
|
| `calculate_twr` | Time-weighted return (TWR) over XPerformance imports. Modified Dietz chained β GIPS-compliant for portfolios without daily NAV. Requires β₯ 2 imports. | β
|
| `calculate_mwr` | Money-weighted return (MWR / IRR) via bisection over signed cash flows. Reports converged=false cleanly when no sign change. Requires β₯ 2 imports. | β
|
| `get_crypto_quote` | Spot crypto quotes in BRL via Mercado Bitcoin. Per-ticker partial failure, 15-min cache, outbound-gated. Quote-only (not yet a tracked asset_class). | β
|
| `set_crypto_position` | Manually track a crypto holding (`CRIPTO` asset_class). Fetches a live quote, stores a snapshot market value (quantity Γ price). `quantity: 0` removes it. No cost basis / P&L. Outbound-gated. | β
|
---
## Quick Start
Add this to your `claude_desktop_config.json`:
```json
{
"mcpServers": {
"portfolio": {
"command": "npx",
"args": ["-y", "portfolio-mcp"]
}
}
}
```
Config file location:
- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
- Linux: `~/.config/Claude/claude_desktop_config.json`
Restart Claude Desktop. Done.
See [Development](#development) below for clone + build instructions if you want to hack on the server.
---
## How to export from XP
XP has no single *"export everything"* button. Try in this order:
1. **XPerformance PDF** *(recommended)* β Investimentos β XPerformance β β¬ PDF. The richest single-file snapshot.
2. **Portal XP web** β Investimentos β PosiΓ§Γ£o Consolidada β Exportar CSV
3. **Hub XP / Assessor Digital** β Meus Investimentos β PosiΓ§Γ£o β Exportar
4. **Notas de corretagem (PDF)** β Conta β Documentos β Notas de Corretagem *(phase 2)*
5. **Extrato de movimentaΓ§Γ£o** β Conta β Extrato β filtrar perΓodo β Exportar
The CSV parser auto-detects `;`, `,`, `\t`, `|` delimiters and fuzzy-matches common XP column names (`Quantidade`, `Qtd`, `PreΓ§o mΓ©dio`, `Valor aplicado`, ...). If a column is missed, extend `HEADER_ALIASES` in `src/parsers/csv-extract.ts`.
### Configuring your target allocation
`calculate_allocation_drift` reads `~/.xp-mcp/allocation.json`. A starter file is included at [`examples/allocation.example.json`](./examples/allocation.example.json). Copy it once and edit the percentages:
```bash
mkdir -p ~/.xp-mcp
cp examples/allocation.example.json ~/.xp-mcp/allocation.json
```
The seven valid keys are `TESOURO`, `RENDA_FIXA_PRIVADA`, `FII`, `ETF`, `ACAO`, `FUNDO`, `CRIPTO`. Values must sum to `1.00` (Β±0.001). `tolerance_pp` is optional β when set, drifts within the band are reported as `"ok"` with no action.
---
## Try it without Claude
The server speaks JSON-RPC 2.0 over stdio. Smoke test from any terminal:
```bash
node dist/index.js <<'EOF'
{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2024-11-05","capabilities":{},"clientInfo":{"name":"smoke","version":"0.0.0"}}}
{"jsonrpc":"2.0","method":"notifications/initialized"}
{"jsonrpc":"2.0","id":2,"method":"tools/list"}
EOF
```
You should see the server announce itself and list the registered tools.
---
## Advisor (opt-in)
v0.4 adds four MCP tools that turn `portfolio-mcp` into an investment-analysis advisor. These tools are **opt-in**: they only make outbound HTTP calls when the user has set `outbound_enabled: true` in their profile and accepted the disclaimer.
### Configure your profile
The profile lives at `~/.xp-mcp/advisor-profile.json`. Create or update it with `set_advisor_profile`:
```jsonc
{
"risk_tolerance": 6,
"horizon_years": 15,
"objective": "balanced",
"monthly_income_target_brl": 3000,
"excluded_classes": ["FUNDO"],
"excluded_tickers": ["XYZW3"],
"notes": "evitar tabaco, prefiro logΓstica e shoppings",
"outbound_enabled": true,
"brapi_token": "..."
}
```
When you flip `outbound_enabled` to `true`, the tool requires `accept_disclaimer: true` in the same call and stamps `accepted_disclaimer_at` on the saved profile.
### Disclaimer
> **AnΓ‘lise educacional baseada em dados pΓΊblicos. NΓ£o constitui recomendaΓ§Γ£o de investimento. DecisΓ΅es financeiras sΓ£o de sua responsabilidade.**
The disclaimer is also returned in `warnings[0]` of every advisor tool that ranks or suggests assets.
### Source: brapi.dev
v0.4 uses [brapi.dev](https://brapi.dev) as the sole market-data source. Anonymous calls work for personal use; if you hit rate limits, set `brapi_token` in the profile. Quotes are cached for 60 minutes, fundamentals for 24 hours, universe lists for 7 days. Override per call via `cache_ttl_minutes`.
### Example flow
1. `set_advisor_profile` β saves the profile, enables outbound
2. `get_market_data { tickers: ["BBAS3","MXRF11"] }` β quotes
3. `screen_assets { asset_class: "FII", criteria: { sort_by: "dividend_yield", order: "desc", filters: { min_dividend_yield_pct: 8 }, limit: 10 } }`
---
## Project layout
```text
src/
βββ index.ts # MCP server entrypoint (stdio transport)
βββ tools/
β βββ import-xperformance-pdf.ts # XPerformance PDF β positions
β βββ import-extract-csv.ts # XP CSV β positions
β βββ get-positions.ts # SQL β positions list with P&L
βββ parsers/
β βββ pdf-xperformance.ts # PDF text β rows
β βββ csv-extract.ts # papaparse + fuzzy header matching
β βββ classify.ts # asset-class heuristics + name metadata
β βββ normalize.ts # BRL / date / quantity normalizers
βββ storage/
β βββ db.ts # better-sqlite3 singleton, WAL, env override
β βββ schema.ts # CREATE TABLE + AssetClass enum
β βββ positions-repo.ts # UPSERT, listPositions, import records
βββ util/
βββ zod-to-json-schema.ts # minimal zod β JSON Schema for MCP
```
---
## Data model
```text
imports every parse attempt with row counts, timestamps, source path
positions one row per (asset_class, external_id); upserted on re-import
transactions buys/sells from broker notes (phase 2)
dividends income / proventos (phase 2)
```
All monetary values are stored as **`INTEGER` cents**. Float math + currency is a well-known source of off-by-a-cent bugs; integers make every aggregation exact.
The `UNIQUE (asset_class, external_id)` constraint + `ON CONFLICT DO UPDATE` makes **re-importing the same file idempotent** β no duplicates, no manual deduping.
---
## Design decisions worth calling out
- **Wide `positions` table with nullable per-class columns.** A table-per-asset-class would be cleaner in theory but adds JOINs for every read, and the column set is small. The wide table fits the access pattern (Claude almost always wants "all positions, maybe filtered by class").
- **Stdio over HTTP.** Claude Desktop spawns the process directly. Zero ports listening, no auth surface, no CORS to misconfigure. Trade-off: no remote clients without a wrapper.
- **stderr-only logging.** stdout is the JSON-RPC wire. One stray `console.log` silently corrupts every response. All logs go to stderr, where Claude Desktop captures them into `~/Library/Logs/Claude/mcp-server-xp.log`.
- **No price fetching in MVP.** Adding it means a network dependency and a rate-limit problem. When it lands (phase 2), it'll be behind an opt-in env var with a clearly-documented data source.
---
## Privacy
- The SQLite file (`~/.xp-mcp/data.db`) is the only place your position data lives. `.gitignore` blocks `*.db`, `*.sqlite`, and `data/` from ever being committed.
- The server makes **no outbound HTTP calls** for the core import/inspection tools (`import_xperformance_pdf`, `import_extract_csv`, `get_positions`, `calculate_allocation_drift`). No telemetry. No analytics.
- The v0.4 advisor tools (`get_market_data`, `screen_assets`) call brapi.dev **only when `outbound_enabled: true`** in `~/.xp-mcp/advisor-profile.json` and the user has accepted the disclaimer. Disabled by default.
---
## Roadmap
- [x] PDF parser for XPerformance (XP's official portfolio report)
- [x] CSV parser for PosiΓ§Γ£o Consolidada / Extrato
- [x] `get_positions` with class filter, P&L when invested-value is known
- [ ] `import_nota_corretagem` (broker-note PDF β transactions)
- [ ] CSV parser for proventos export
- [x] `calculate_allocation_drift` against `~/.xp-mcp/allocation.json`
- [x] v0.3 β npm publish + Smithery + awesome-mcp PR
- [x] v0.4 β Investment advisor foundations: `set_advisor_profile`, `get_advisor_profile`, `get_market_data`, `screen_assets` (brapi.dev, SQLite cache)
- [x] v0.5 β Portfolio summary + reconciliation gap: `get_portfolio_summary` (aggregate stats, declared-vs-computed gap)
- [x] v0.6 β Bank extract import + cash flows: `import_bank_extract_pdf` (XP Conta Digital Extrato β `cash_flows` table, schema v3), `get_cash_flows` (filterable query with aggregate totals)
- [x] v0.7 β Suggest Buys: `suggest_buys` (composes profile + drift + screening into deterministic BUY suggestions per underweight class; non-screenable classes surface in `skipped_classes`)
- [x] v0.8 β `cash_flow_summary` in `get_portfolio_summary`: YTD + rolling 12m aporte/resgate aggregates in the panorama output (no new tool, additive field).
- [x] v0.9 β `calculate_twr` + `calculate_mwr`: time-weighted and money-weighted returns over XPerformance imports + cash_flows (Modified Dietz chained + bisection IRR; no schema change; tools MCP 12 β 14).
- [x] v0.10 β `get_crypto_quote`: spot crypto quotes in BRL via Mercado Bitcoin (`CryptoQuoteSource` interface + `MercadoBitcoinSource` impl; per-ticker partial failure; 15-min cache; outbound-gated; quote-only; tools MCP 14 β 15).
- [x] v0.11 β multi-source crypto: `get_crypto_quote` now falls back across Mercado Bitcoin β Foxbit β Binance (`MultiSourceCryptoQuoteSource` chain), with Binance USDT quotes converted to BRL via the MB USDT/BRL rate; widens altcoin coverage (internal only β still 15 tools).
- [x] v0.12 β crypto as a tracked asset_class: `set_crypto_position` (manual entry, `CRIPTO` added to `ASSET_CLASSES`, snapshot valuation via the v0.11 multi-source chain, no cost basis; flows into summary/drift/suggest_buys with no service change; tools MCP 15 β 16).
- [ ] Adapters for other Brazilian brokers (Rico, NuInvest, Inter, Avenue)
- [ ] Open Finance Brasil investment module when the standard matures
---
## Changelog
### v0.12.0 β crypto as a tracked asset_class (2026-05-25)
- New tool `set_crypto_position`: manual entry that makes crypto a
first-class tracked `asset_class` (`CRIPTO`). Fetches a live quote via
the v0.11 multi-source chain (Mercado Bitcoin β Foxbit β Binance) and
upserts a `positions` row with a **snapshot** market value
(quantity Γ current price). Outbound-gated.
- `quantity: 0` removes the holding (idempotent single tool). Re-running
the tool refreshes the snapshot in place.
- Snapshot valuation, **no cost basis / P&L**: manual entry records
quantity + current market value only (`avg_price_cents`/
`invested_cents` stay null), so crypto shows market value but no
profit/loss β mirroring how XP positions are snapshots from the last
import.
- Crypto flows into `get_portfolio_summary` and
`calculate_allocation_drift` automatically β both already aggregate by
`asset_class`, so no service change was needed. A crypto holding with
no target key shows as over-target vs 0% in drift; in `suggest_buys`
it lands in `skipped_classes` (CRIPTO is non-screenable).
- Additive: `"CRIPTO"` added to `ASSET_CLASSES`, no DDL change, no
`SCHEMA_VERSION` bump, no new dependency. Tools MCP: 15 β 16.
### v0.11.0 β multi-source crypto (2026-05-25)
- `get_crypto_quote` now defaults to a multi-source fallback chain
(`MultiSourceCryptoQuoteSource`): Mercado Bitcoin β Foxbit β Binance.
Tries each in order, falling through on `TickerNotFoundError` or a
recoverable error, returning the first successful quote.
- New `FoxbitSource` (BRL-native) widens Brazilian coverage; new
`BinanceSource` (USDT-native) covers the altcoin long tail, converting
every monetary field to BRL via a USDT/BRL rate from the
already-integrated Mercado Bitcoin `/USDT/ticker/` endpoint
(`MbUsdBrlRate`) β no new external FX dependency.
- `CryptoQuote` gains additive optional fields `price_usd` and
`fx_rate_brl_per_usd` for conversion transparency (BRL-native sources
leave them undefined).
- The cache row records the source that actually answered (e.g.
`binance`), not the strategy name `multi`; top-level result `source`
is `"multi"` while each `quote.source` keeps the real origin.
- Internal only β `get_crypto_quote` is still one tool. Tools MCP: 15.
### v0.10.0 β get_crypto_quote (2026-05-24)
- New tool `get_crypto_quote`: spot crypto quotes in BRL via Mercado
Bitcoin's public ticker API. 1-20 symbols per call, per-ticker
partial failure, 15-minute cache, outbound-gated.
- New `CryptoQuoteSource` interface + `MercadoBitcoinSource` impl β
slim interface (no equity fundamentals/universe), leaves the door
open for Binance/Foxbit later.
- `MarketDataCache.put` gains an optional `source` param (default
brapi.dev β no behaviour change).
- Crypto is NOT yet a tracked asset_class β quote-only foundation.
Scope B (positions, schema migration, summary/drift integration)
deferred to a future TODO.
- Tools MCP: 14 β 15.
### v0.9.0 β calculate_twr + calculate_mwr (2026-05-24)
- New tool `calculate_twr`: time-weighted return (Modified Dietz between consecutive XPerformance snapshots, geometric chain across sub-periods). GIPS-compliant for portfolios without daily NAV.
- New tool `calculate_mwr`: money-weighted return (IRR via bisection on signed cash flows + synthetic initial/terminal NAV). Reports `converged: false` cleanly when no sign change in `[-99%, 1000%]`.
- New repo function `listValuationSnapshots` reads XPerformance imports as the NAV history β no schema change.
- New pure service `services/returns.ts` with hand-computable test references (CFA Modified Dietz example + 1Y 10% MWR case).
- Quality warnings: sparse history, large cash flows, tiny period, MWR non-convergence, stale tail.
- Tools MCP: 12 β 14.
### v0.8.0 β cash_flow_summary in get_portfolio_summary (2026-05-24)
- Additive field on `get_portfolio_summary`: `cash_flow_summary` block with YTD + rolling 12-month aporte/resgate aggregates.
- New repo function `listCashFlowsSince` (unbounded date-bounded query) in `src/storage/cash-flows-repo.ts`.
- New pure service `computeCashFlowSummary` in `src/services/cash-flow-summary.ts` β YTD + rolling 12m aggregates over `CashFlowRow[]`, no DB access. Averages divide by `months_with_data` (not 12) so short histories are not penalised.
- `get_portfolio_summary` warns when no cash flows have been imported yet (`cash_flow_summary: null`).
- 12 tools total (unchanged). No schema migration. No new MCP tool β additive field on existing tool.
### v0.7.0 β Suggest Buys (2026-05-23)
- New tool: `suggest_buys` β composes advisor profile + allocation drift + asset screening into a deterministic list of BUY suggestions per underweight asset class.
- Encodes a fixed `objective Γ asset_class` screening matrix (`income`/`growth`/`balanced` Γ `FII`/`ACAO`/`ETF`).
- Non-screenable underweight classes (`TESOURO`, `RENDA_FIXA_PRIVADA`, `FUNDO`) surface in a dedicated `skipped_classes` field rather than being silently dropped.
- Each suggestion includes `amount_brl` (= class gap / actual_returned), `score`, `rationale`, and `already_owned`.
- 12 tools total (was 11). No schema migration.
---
## Development
For contributors or anyone who wants to run a local checkout instead of the published npm package:
```bash
git clone https://github.com/Satsuj1n/portfolio-mcp
cd portfolio-mcp
npm install
npm run build
npm run test
```
Then point `claude_desktop_config.json` at the local build:
```json
{
"mcpServers": {
"portfolio": {
"command": "node",
"args": ["/absolute/path/to/portfolio-mcp/dist/index.js"]
}
}
}
```
Run the type checker with `npm run typecheck`. Smoke-test the MCP server end-to-end with:
```bash
node dist/index.js <<'EOF'
{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2024-11-05","capabilities":{},"clientInfo":{"name":"local","version":"0.0.0"}}}
{"jsonrpc":"2.0","method":"notifications/initialized"}
{"jsonrpc":"2.0","id":2,"method":"tools/list"}
EOF
```
---
## Contributing
PRs welcome β especially:
- New parsers (other brokers, other export formats)
- Heuristics for `classifyAsset` covering edge cases your portfolio exposes
- Additional tools (`calculate_allocation_drift`, `get_dividends`, ...)
- Tests with anonymized fixtures (no real position values, no real account numbers)
Please **never** include real portfolio data, account numbers, or PDFs in your PR. Use the fixture pattern in `tests/fixtures/` (synthetic data only).
---
## License
MIT β see [LICENSE](./LICENSE).
Built by [Felipe Lima](https://github.com/Satsuj1n) Β· Powered by [Model Context Protocol](https://modelcontextprotocol.io/).
TDQS
Scored across 18 tools
Tools have mostly distinct purposes, but pairs like get_cash_flows vs get_transactions and get_dividends could overlap for financial data queries, though descriptors clarify them. calculate_twr and calculate_mwr are clearly differentiated by methodology.
Uses consistent verb_noun pattern (get_, import_, set_, calculate_) with clear domain terms. Minor inconsistency: 'calculate_twr' vs 'calculate_mwr' vs 'get_crypto_quote' where 'get' could be 'calculate' but overall pattern is coherent.
With 18 tools, the count is slightly high for a single server but reasonable given the breadth (portfolio, crypto, market data, performance). Some tools could be combined (e.g., get_transactions/get_dividends into one get_cash_flows), but still within acceptable scope.
Covers major portfolio management needs: data import, positions, performance, cash flow, and crypto. Missing features like trade execution or more advanced analytics, but for a read-only/advisory server it's complete. Minor gap: no way to manage allocation targets directly except via file overrides.