Skip to main content
Glama
Ghostfolio MCP Server

Ghostfolio MCP Server

by mhajder

Ghostfolio MCP Server

Let AI agents analyze and manage your Ghostfolio investment portfolio

PyPI Python License

Pre-commit Checks Docker MCP Registry

Installation · Tools · Configuration · Security

Ghostfolio MCP Server is a Python-based Model Context Protocol (MCP) server designed to provide advanced, programmable access to Ghostfolio portfolio management and financial data. It exposes a modern API for querying, analyzing, and managing your investment portfolio through Ghostfolio's comprehensive features. The server supports both read and write operations, robust security features, and is suitable for integration with automation tools, financial dashboards, and custom portfolio management applications.

✨ Features

Core Features

  • Query portfolio performance, holdings, and positions with flexible time ranges

  • Retrieve comprehensive investment data including dividends, returns, and allocations

  • Access detailed market data, asset profiles, and historical price information

  • Monitor portfolio metrics, benchmarks, and performance comparisons

  • Track orders, transactions, and account balances across multiple accounts

  • Search and lookup financial symbols, stocks, ETFs, and other assets

  • Get user information, settings, and account details

Management Operations

  • Create and manage investment accounts with different currencies and platforms

  • Create, delete, and manage individual transactions and activities

  • Import transactions and historical data from other platforms

  • Configure read-only mode to restrict all write operations for safe monitoring

  • Support for bulk transaction imports and portfolio data management

  • Monitor system health and platform availability

Advanced Capabilities

  • Rate limiting and API security features

  • Real-time portfolio monitoring and performance tracking

  • Comprehensive logging and audit trails

  • SSL/TLS support and configurable timeouts

  • Extensible with custom middlewares and tag-based tool filtering

  • Optional tool-search transform for large tool catalogs

  • Bearer token or OIDC/OAuth authentication for HTTP transports

Related MCP server: Wealthfolio MCP Server

🚀 Installation

Prerequisites

  • Python 3.11 to 3.15

  • Access to a Ghostfolio instance

  • Valid Ghostfolio API token

Quick Install from PyPI

The easiest way to get started is to install from PyPI:

# Using UV (recommended)
uvx ghostfolio-mcp

# Or using pip
pip install ghostfolio-mcp

Remember to configure the environment variables for your Ghostfolio instance before running the server:

# Create environment configuration
export GHOSTFOLIO_URL=https://domain.tld:3333
export GHOSTFOLIO_TOKEN=your-ghostfolio-token

For more details, visit: https://pypi.org/project/ghostfolio-mcp/

Install from Source

  1. Clone the repository:

git clone https://github.com/mhajder/ghostfolio-mcp.git
cd ghostfolio-mcp
  1. Install dependencies:

# Using UV (recommended)
uv sync

# Or using pip
pip install -e .
  1. Configure environment variables:

cp .env.example .env
# Edit .env with your Ghostfolio URL and token
  1. Run the server:

# Using UV (recommended)
uv run ghostfolio-mcp

# Or using the installed command directly
ghostfolio-mcp

Development Setup

For development with additional tools:

# Clone and install with development dependencies
git clone https://github.com/mhajder/ghostfolio-mcp.git
cd ghostfolio-mcp
uv sync --group dev

# Run tests
uv run pytest

# Run with coverage
uv run pytest --cov=src/

# Run linting and formatting
uv run ruff check .
uv run ruff format .

# Run type checking
uv run ty check .

# Setup prek hooks
uv run prek install

🔧 Configuration

Environment Variables

A blank or whitespace-only value counts as unset and uses the default. Boolean settings accept true/false, 1/0, yes/no and on/off (any case). Any other value stops the server at startup, so a typo cannot silently turn read-only mode or TLS verification off.

# Ghostfolio Connection Details
GHOSTFOLIO_URL=https://domain.tld:3333
GHOSTFOLIO_TOKEN=your-ghostfolio-token

# SSL Configuration
GHOSTFOLIO_VERIFY_SSL=true
GHOSTFOLIO_TIMEOUT=30

# Read-Only Mode
# Set READ_ONLY_MODE true to disable all write operations (put, post, delete)
READ_ONLY_MODE=false

# Disabled Tags
# Comma-separated list of tags to disable tools for (empty by default)
# Example: GHOSTFOLIO_DISABLED_TAGS=portfolio,symbol
GHOSTFOLIO_DISABLED_TAGS=

# Logging Configuration
LOG_LEVEL=INFO

# Rate Limiting (requests per minute)
# Set RATE_LIMIT_ENABLED true to enable rate limiting
RATE_LIMIT_ENABLED=false
RATE_LIMIT_MAX_REQUESTS=60
RATE_LIMIT_WINDOW_MINUTES=1

# Tool Search Transform (Optional)
# Set TOOL_SEARCH_ENABLED true to replace full tool listings with search_tools + call_tool
TOOL_SEARCH_ENABLED=false
# Search strategy: bm25 (natural language) or regex (pattern match)
TOOL_SEARCH_STRATEGY=bm25
# Maximum number of tools returned by search_tools
TOOL_SEARCH_MAX_RESULTS=5

# Sentry Error Tracking (Optional)
# Set SENTRY_DSN to enable error tracking and performance monitoring
# SENTRY_DSN=https://your-key@o12345.ingest.us.sentry.io/6789
# Optional Sentry configuration
# SENTRY_TRACES_SAMPLE_RATE=1.0
# SENTRY_SEND_DEFAULT_PII=false
# SENTRY_ENVIRONMENT=production
# SENTRY_RELEASE=1.2.3
# SENTRY_PROFILE_SESSION_SAMPLE_RATE=1.0
# SENTRY_PROFILE_LIFECYCLE=trace
# SENTRY_ENABLE_LOGS=true

# MCP Transport Configuration
# Transport type: 'stdio' (default), 'sse' (Server-Sent Events), or 'http' (HTTP Streamable)
# 'streamable-http' is accepted as an alias for 'http'. Any other value stops
# the server at startup.
MCP_TRANSPORT=stdio

# HTTP Transport Settings (used when MCP_TRANSPORT=sse or MCP_TRANSPORT=http)
# Host to bind the HTTP server (default: 127.0.0.1)
# MCP_HTTP_HOST=127.0.0.1
# Port to bind the HTTP server (default: 8000)
# MCP_HTTP_PORT=8000
# Optional bearer token for authentication (leave empty for no auth)
# MCP_HTTP_BEARER_TOKEN=

# OIDC / OAuth Authentication (optional, for remote hosting)
# Set all four to enable; takes precedence over MCP_HTTP_BEARER_TOKEN
# OIDC_CONFIG_URL=https://id.example.com/.well-known/openid-configuration
# OIDC_CLIENT_ID=
# OIDC_CLIENT_SECRET=
# OIDC_BASE_URL=https://ghostfolio-mcp.example.com
# Optional OIDC settings
# OIDC_REDIRECT_PATH=/auth/callback
# OIDC_REQUIRED_SCOPES=
# OIDC_ALLOWED_REDIRECT_URIS=
# OIDC_VERIFY_ID_TOKEN=false
# OIDC_FORWARD_RESOURCE=false

Sentry Error Tracking & Monitoring (Optional)

The server optionally supports Sentry for error tracking, performance monitoring, and debugging. Sentry integration is completely optional and only initialized if configured.

Installation

To enable Sentry monitoring, install the optional dependency:

# Using UV (recommended)
uv sync --extra sentry

Configuration

Enable Sentry by setting the SENTRY_DSN environment variable in your .env file:

# Required: Sentry DSN for your project
SENTRY_DSN=https://your-key@o12345.ingest.us.sentry.io/6789

# Optional: Performance monitoring sample rate (0.0-1.0, default: 1.0)
SENTRY_TRACES_SAMPLE_RATE=1.0

# Optional: Include personally identifiable information (default: false).
# When true, tool inputs and outputs (portfolio data) are sent to Sentry.
SENTRY_SEND_DEFAULT_PII=false

# Optional: Environment name (e.g., "production", "staging")
SENTRY_ENVIRONMENT=production

# Optional: Release version (auto-detected from package if not set)
SENTRY_RELEASE=1.2.2

# Optional: Profiling - continuous profiling sample rate (0.0-1.0, default: 1.0)
SENTRY_PROFILE_SESSION_SAMPLE_RATE=1.0

# Optional: Profiling - lifecycle mode for profiling (default: "trace")
# Options: "all", "continuation", "trace"
SENTRY_PROFILE_LIFECYCLE=trace

# Optional: Enable log capture as breadcrumbs and events (default: true)
SENTRY_ENABLE_LOGS=true

Features

When enabled, Sentry automatically captures:

  • Exceptions & Errors: All unhandled exceptions with full context

  • Performance Metrics: Request/response times and traces

  • MCP Integration: Detailed MCP server activity and interactions

  • Logs & Breadcrumbs: Application logs and event trails for debugging

  • Context Data: Environment, client info, and request parameters

Getting a Sentry DSN

  1. Create a free account at sentry.io

  2. Create a new Python project

  3. Copy your DSN from the project settings

  4. Set it in your .env file

Disabling Sentry

Sentry is completely optional. If you don't set SENTRY_DSN, the server will run normally without any Sentry integration, and no monitoring data will be collected.

🧰 Available Tools

Account Management Tools

  • get_accounts: Get all accounts in your portfolio including account types and balances

  • get_account_balances: Get account balances for a specific account

  • create_account: Create a new account in your portfolio

  • delete_account: Delete an existing account from your portfolio (destructive operation)

  • get_account_details: Get details for a specific account

  • update_account: Update settings or details of an existing account

  • transfer_account_balance: Transfer cash balances between two accounts

  • create_account_balance: Set an account's balance for a specific date in its balance history (defaults to today)

  • delete_account_balance: Delete a single entry from an account's balance history

Portfolio & Transaction Management Tools

  • get_portfolio_performance: Get portfolio performance data including returns, benchmarks, and performance metrics

  • get_portfolio_holdings: Get portfolio holdings and positions including allocations and asset breakdowns

  • get_portfolio_details: Get comprehensive portfolio details including accounts, positions, and summary

  • get_position: Get position details for a specific symbol from a data source

  • get_investments: Get investment data grouped by time period showing cash flows and contributions

  • get_dividends: Get dividend data grouped by time period showing dividend payments and yield

  • get_orders: Get all activities/orders from your portfolio, optionally filtered by account

  • create_activity: Create a single new transaction/activity in your portfolio (BUY, SELL, DIVIDEND, INTEREST, FEE, etc.), optionally with tags

  • update_activity: Update an existing activity/transaction, including its tags; fields you don't pass keep their current values

  • delete_activity: Delete a single activity/transaction by its ID (destructive operation)

Benchmark Tools

  • get_benchmarks: Get all configured benchmarks

  • get_benchmark_performance: Compare portfolio performance against a benchmark symbol starting from a specific date

Watchlist Tools

  • get_watchlist: Get all items in the user's watchlist

  • add_to_watchlist: Add a symbol to the user's watchlist

  • remove_from_watchlist: Remove a symbol from the user's watchlist

Exchange Rate Tools

  • get_exchange_rate: Get the exchange rate for a given currency symbol on a specific date

Data Export Tools

  • export_portfolio: Export portfolio activities/transactions data as JSON

Market Data & Symbol Tools

  • get_market_data_for_asset: Get market data for a specific asset

  • add_market_data_points: Add one or more market data points for an asset (typically a MANUAL data source — Ghostfolio rejects writes for auto-fetched sources)

  • get_symbol_data: Get symbol data for a specific asset from a data source

  • get_historical_data: Get historical data for a specific symbol on a specific date

  • lookup_symbols: Search for symbols using a query string

  • get_asset_profile: Get asset profile information for a specific symbol

  • upsert_asset_profile: Create-or-update an asset profile, including optional countries and sectors allocations (idempotent; tolerates Ghostfolio's HTTP 500 on the create step and relies on the subsequent PATCH as the source of truth)

  • delete_asset_profile: Delete an asset profile (destructive operation; may delete associated activities and market data depending on backend rules)

Data Import Tools

  • import_transactions: Import transactions into your portfolio (bulk import operation)

  • get_dividends_for_import: Fetch historical dividend data formatted for import for a specific symbol

System & Platform Tools

  • get_health: Get system health status of the Ghostfolio backend service

  • get_platforms: Get list of available platforms (brokers, exchanges, etc.) for account tracking

User Management Tools

  • get_user_info: Get user information and settings

🔒 Security & Safety Features

Read-Only Mode

The server supports a read-only mode that disables all write operations for safe monitoring:

READ_ONLY_MODE=true

When enabled, this mode prevents any modifications to your portfolio data while still allowing full read access to all information.

Tag-Based Tool Filtering

You can disable specific categories of tools by setting disabled tags:

GHOSTFOLIO_DISABLED_TAGS=portfolio,symbol,import

Available tags include:

  • account - Account management tools (create, delete, update, get accounts)

  • portfolio - Portfolio analysis and performance tools

  • symbol - Symbol lookup and data tools

  • import - Data import tools

  • asset - Asset profile tools

  • user - User information tools

  • system - System health and platform information tools

  • activities - Activity/transaction management tools (create, update, delete activities)

  • watchlist - Watchlist management tools

  • exchange-rate - Currency exchange rate tools

  • export - Data export tools

  • benchmark - Benchmark tools

Rate Limiting

The server supports rate limiting to control API usage and prevent abuse. If enabled, requests are limited per client using a sliding window algorithm.

Enable rate limiting by setting the following environment variables in your .env file:

RATE_LIMIT_ENABLED=true
RATE_LIMIT_MAX_REQUESTS=60    # Maximum requests allowed per window
RATE_LIMIT_WINDOW_MINUTES=1   # Window size in minutes

If RATE_LIMIT_ENABLED is set to true, the server will apply rate limiting middleware. Adjust RATE_LIMIT_MAX_REQUESTS and RATE_LIMIT_WINDOW_MINUTES as needed for your environment. While rate limiting is on, both must be at least 1; while it is off, they are not read.

Tool Search for Large Toolsets

FastMCP tool search can reduce prompt size for servers with many tools. When enabled, list_tools returns two synthetic tools:

  • search_tools: Finds matching tools and returns their full schemas

  • call_tool: Executes any discovered tool by name

Enable it with:

TOOL_SEARCH_ENABLED=true
TOOL_SEARCH_STRATEGY=bm25      # bm25 or regex
TOOL_SEARCH_MAX_RESULTS=8      # optional, default is 5

bm25 supports natural language queries, while regex uses a regex pattern input for deterministic matching. While tool search is on, any other strategy, or a TOOL_SEARCH_MAX_RESULTS below 1, stops the server at startup; while it is off, these settings are not read.

Tool search respects existing visibility controls (read-only mode and disabled tags).

SSL/TLS Configuration

The server supports SSL certificate verification and custom timeout settings:

GHOSTFOLIO_VERIFY_SSL=true    # Enable SSL certificate verification
GHOSTFOLIO_TIMEOUT=30         # Connection timeout in seconds

Transport Configuration

The server supports multiple transport protocols for different deployment scenarios:

STDIO Transport (Default)

The default transport uses standard input/output for communication. This is ideal for local usage and integration with tools that communicate via stdin/stdout:

MCP_TRANSPORT=stdio

HTTP SSE Transport (Server-Sent Events)

For network-based deployments, you can use HTTP with Server-Sent Events. This allows the MCP server to be accessed over HTTP with real-time streaming:

MCP_TRANSPORT=sse
MCP_HTTP_HOST=127.0.0.1        # Localhost
MCP_HTTP_PORT=8000           # Port to listen on
MCP_HTTP_BEARER_TOKEN=your-secret-token  # Optional authentication token

When using SSE transport with a bearer token, clients must include the token in their requests:

curl -H "Authorization: Bearer your-secret-token" http://localhost:8000/sse

HTTP Streamable Transport

The HTTP Streamable transport provides HTTP-based communication with request/response streaming. This is ideal for web integrations and tools that need HTTP endpoints:

MCP_TRANSPORT=http
MCP_HTTP_HOST=127.0.0.1        # Localhost
MCP_HTTP_PORT=8000           # Port to listen on
MCP_HTTP_BEARER_TOKEN=your-secret-token  # Optional authentication token

When using streamable transport with a bearer token:

curl -H "Authorization: Bearer your-secret-token" \
     -H "Accept: application/json, text/event-stream" \
     -H "Content-Type: application/json" \
     -d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}' \
     http://localhost:8000/mcp

Note: The HTTP transport requires proper JSON-RPC formatting with jsonrpc and id fields. The server may also require session initialization for some operations.

Health Endpoint

Both HTTP transports (sse and http) serve GET /health, which answers 200 ok when the server is handling requests. It needs no bearer token or OIDC login and does not contact Ghostfolio, so a Ghostfolio outage does not mark the MCP server unhealthy. The Docker image's HEALTHCHECK uses it:

curl http://localhost:8000/health

OIDC / OAuth Authentication (Optional)

A static bearer token is enough for machine-to-machine clients, but many MCP clients can only authenticate over OAuth with Dynamic Client Registration. For those, the server can act as an OAuth interface in front of an existing OIDC identity provider (Authentik, Keycloak, PocketID, Auth0, Entra ID, ...) using FastMCP's OIDCProxy. Clients register and authenticate against this server; the server brokers the flow upstream. No Ghostfolio credential ever reaches the client.

This applies to the sse and http transports only.

Registering the client

Create a confidential client (client ID + secret) on your identity provider with the redirect URI set to OIDC_BASE_URL + OIDC_REDIRECT_PATH, for example https://ghostfolio-mcp.example.com/auth/callback.

Configuration

MCP_TRANSPORT=http
MCP_HTTP_HOST=0.0.0.0
MCP_HTTP_PORT=8000

# All four are required to enable OIDC
OIDC_CONFIG_URL=https://id.example.com/.well-known/openid-configuration
OIDC_CLIENT_ID=your-client-id
OIDC_CLIENT_SECRET=your-client-secret
# Public URL where this server is reachable, used to build its OAuth endpoints.
# Must be HTTPS (except on localhost), as required for an OAuth issuer.
OIDC_BASE_URL=https://ghostfolio-mcp.example.com

OIDC is entirely optional. Leaving these unset keeps the existing behaviour, and a partially configured setup is ignored with a warning rather than half-enabled. When OIDC is configured it takes precedence over MCP_HTTP_BEARER_TOKEN.

Optional settings:

# Callback path registered on the identity provider (default: /auth/callback)
OIDC_REDIRECT_PATH=/auth/callback

# Comma-separated scopes required on presented tokens
OIDC_REQUIRED_SCOPES=openid,profile

# Comma-separated allowed client redirect URI patterns (wildcards accepted)
OIDC_ALLOWED_REDIRECT_URIS=https://example.com/*

# Verify the id_token instead of the access token (default: false)
OIDC_VERIFY_ID_TOKEN=false

# Forward the RFC 8707 'resource' indicator upstream (default: false)
OIDC_FORWARD_RESOURCE=false

OIDC_ALLOWED_REDIRECT_URIS restricts which clients may complete the flow. Leaving it unset accepts any redirect URI a client registers, so set it to the hosts you expect, for example https://example.com/*.

Set OIDC_VERIFY_ID_TOKEN=true if your identity provider issues opaque (non-JWT) access tokens; the id_token is then verified instead.

OIDC_FORWARD_RESOURCE is off by default because identity providers that do not implement RFC 8707 resource indicators reject the authorization request with invalid_request, which breaks login immediately after consent. Turn it on only if your provider supports resource indicators. Token audience binding is unaffected either way.

Persisting OAuth state

Client registrations and encrypted tokens are stored on disk, under FastMCP's data directory. If that directory is not persistent, every restart forces all clients to register and authenticate again. The Docker image sets FASTMCP_HOME=/data, so mount a volume there:

docker run -v ghostfolio-mcp-data:/data --env-file .env ghcr.io/mhajder/ghostfolio-mcp:latest

Running behind a reverse proxy

OIDC_BASE_URL must be the externally reachable HTTPS URL, and the proxy must forward the Host header unchanged, otherwise the OAuth metadata this server advertises will point at the wrong host.

📊 Data Sources

Ghostfolio supports multiple data sources for market data and symbols:

  • YAHOO - Yahoo Finance data source

  • COINGECKO - CoinGecko for cryptocurrency data

  • MANUAL - Manually entered data

  • And other configured data sources in your Ghostfolio instance

When using tools that require a data source parameter, specify the appropriate source for your asset type.

🐳 Using Docker

A Docker image is available on GitHub Packages for easy deployment. It runs the HTTP Streamable transport on port 8000 (/mcp).

docker pull ghcr.io/mhajder/ghostfolio-mcp:latest

When OIDC authentication is enabled, mount a volume on /data so OAuth client registrations survive container recreation.

Open WebUI

Open WebUI 0.6.31 and later connect to the image directly; the separate MCPO image (ghcr.io/mhajder/ghostfolio-mcpo) is no longer published. In Open WebUI, go to Admin Settings > Integrations > External Tool Servers, add a connection of type MCP (Streamable HTTP) with the URL http://<host>:8000/mcp, and set Bearer authentication to your MCP_HTTP_BEARER_TOKEN.

If OIDC authentication is enabled, it takes precedence and the bearer token is not accepted. Use the URL OIDC_BASE_URL + /mcp and choose OAuth 2.1 authentication instead; Open WebUI registers itself as a client, so if you set OIDC_ALLOWED_REDIRECT_URIS, include your Open WebUI URL in it.

🤝 Contributing

Contributions are welcome. See CONTRIBUTING.md for the dev setup, checks and commit message format, and use the issue templates for bugs and feature requests.

Found a security problem? Please report it privately as described in SECURITY.md.

📜 License

GNU Affero General Public License v3.0 or later - see LICENSE for details.

Available Tools

39 tools
add_market_data_pointsAdd Market Data PointsA
Idempotent

Add one or more market data points for a specific asset.

Posts to the market-data endpoint for the given data source and symbol. Same (symbol, date) overwrites the existing point; passing the same input twice yields the same end state.

Inputs: symbol (required), data_source (required), market_data (required). Returns: object

add_to_watchlistAdd To WatchlistA
Idempotent

Add a symbol to the user's watchlist.

Inputs: symbol (required), data_source (required). Returns: object

create_accountCreate AccountA

Create a new account in your portfolio.

Creates a new account with the specified name, currency, and optional balance. This is useful for organizing your investments across different account types or platforms.

Note: current Ghostfolio versions have no boolean "excluded" flag on an account - exclusion from analysis is done by tagging the account, which is outside this tool's scope.

Inputs: name (required), currency (required), balance, comment, +1 more. Returns: object

create_account_balanceCreate Account BalanceA
Idempotent

Set an account's balance for a specific date in its balance history.

This writes directly to the balance-history series that get_account_balances returns and that get_portfolio_holdings derives its cash figure from - it is not the same as the account's summary balance field. Calling this again for the same account and date updates that entry instead of duplicating it, so setting today's balance is just this call with date omitted.

The balance is recorded in the account's own currency; Ghostfolio's API does not accept a separate currency for this endpoint.

Inputs: balance (required), account_id (required), date. Returns: object

create_activityCreate ActivityC

Create a single new transaction/activity.

Inputs: date (required), type (required), symbol (required), currency (required), +7 more. Returns: object

delete_accountDelete AccountA
Destructive

Delete an existing account from your portfolio.

Deletes an account specified by its ID. Be careful, this might delete associated transactions depending on backend rules!

Inputs: account_id (required). Returns: object

delete_account_balanceDelete Account BalanceA
Destructive

Delete a single entry from an account's balance history.

Inputs: balance_id (required). Returns: object

delete_activityDelete ActivityA
Destructive

Delete a single activity/transaction by its ID.

Inputs: activity_id (required). Returns: object

delete_asset_profileDelete Asset ProfileA
Destructive

Delete an asset profile.

Removes the profile-data record for the given data source and symbol. Be careful, this might delete associated activities and market data depending on backend rules!

Inputs: symbol (required), data_source (required). Returns: object

export_portfolioExport PortfolioA
Read-onlyIdempotent

Export portfolio activities/transactions data as JSON.

Retrieves portfolio transactions with optional query filters.

Inputs: tags, symbol, accounts, data_source, +3 more. Returns: object

get_account_balancesGet Account BalancesB
Read-onlyIdempotent

Get account balances for a specific account.

Retrieves balance information for a specific account including current balance, currency, and balance history.

Inputs: account_id (required). Returns: object

get_account_detailsGet Account DetailsB
Read-onlyIdempotent

Get details for a specific account.

Inputs: account_id (required). Returns: object

get_accountsGet AccountsB
Read-onlyIdempotent

Get all accounts in your portfolio including account types and balances.

Retrieves a list of all accounts in your portfolio including account types, balances, and account-specific information.

Inputs: no named parameters. Returns: object

get_asset_profileGet Asset ProfileA
Read-onlyIdempotent

Get asset profile information for a specific symbol.

Retrieves detailed profile information about an asset including company information, sector, industry, and other metadata.

Inputs: symbol (required), data_source (required). Returns: object

get_benchmark_performanceGet Benchmark PerformanceB
Read-onlyIdempotent

Compare portfolio performance against a benchmark symbol starting from a specific date.

Inputs: symbol (required), start_date (required), data_source (required), tags, +6 more. Returns: object

get_benchmarksGet BenchmarksA
Read-onlyIdempotent

Get all configured benchmarks.

Inputs: no named parameters. Returns: object

get_dividendsGet DividendsC
Read-onlyIdempotent

Get dividend data grouped by time period showing dividend payments and yield.

Retrieves dividend income data grouped by the specified time period, showing dividend payments, yield, and income patterns over time.

Inputs: group_by, date_range. Returns: object

get_dividends_for_importGet Dividends For ImportA
Read-onlyIdempotent

Fetch historical dividend data formatted for import for a specific symbol.

Inputs: symbol (required), data_source (required). Returns: object

get_exchange_rateGet Exchange RateA
Read-onlyIdempotent

Get the exchange rate for a given currency symbol on a specific date.

Inputs: date (required), symbol (required). Returns: object

get_healthGet HealthA
Read-onlyIdempotent

Get system health status.

Retrieves the health status of the Ghostfolio backend service. This is useful to verify if the server is up and running correctly.

Inputs: no named parameters. Returns: object

get_historical_dataGet Historical DataB
Read-onlyIdempotent

Get historical data for a specific symbol on a specific date.

Retrieves historical market data for a symbol on a specific date, including price and volume information.

Inputs: date (required), symbol (required), data_source (required). Returns: object

get_investmentsGet InvestmentsB
Read-onlyIdempotent

Get investment data grouped by time period showing cash flows and contributions.

Retrieves investment activity data grouped by the specified time period, showing cash flows, contributions, and investment patterns over time.

Inputs: group_by, date_range. Returns: object

get_market_data_for_assetGet Market Data For AssetB
Read-onlyIdempotent

Get market data for a specific asset.

Retrieves current market data for a specific symbol including price, volume, market cap, and other relevant market information.

Inputs: symbol (required), data_source (required). Returns: object

get_ordersGet OrdersA
Read-onlyIdempotent

Get all activities/orders from your portfolio, optionally filtered by account.

Retrieves a list of all buy/sell orders in your portfolio, optionally filtered by a specific account.

Inputs: account_id. Returns: object

get_platformsGet PlatformsA
Read-onlyIdempotent

Get available platforms.

Retrieves a list of all available platforms (brokers, exchanges, etc.) that can be used when tracking accounts or transactions.

Inputs: no named parameters. Returns: object

get_portfolio_detailsGet Portfolio DetailsB
Read-onlyIdempotent

Get comprehensive portfolio details including accounts, positions, and summary.

Retrieves a complete overview of your portfolio including account information, current positions, performance summary, and portfolio metrics.

Inputs: no named parameters. Returns: object

get_portfolio_holdingsGet Portfolio HoldingsB
Read-onlyIdempotent

Get portfolio holdings and positions including allocations and asset breakdowns.

Retrieves current portfolio holdings including positions, allocations, and asset breakdowns for the specified time period.

Inputs: date_range. Returns: object

get_portfolio_performanceGet Portfolio PerformanceB
Read-onlyIdempotent

Get portfolio performance data including returns, benchmarks, and performance metrics.

Retrieves comprehensive performance metrics for your portfolio including returns, benchmarks, and performance comparisons over the specified time period.

Inputs: date_range. Returns: object

get_positionGet PositionA
Read-onlyIdempotent

Get position details for a specific symbol from a data source.

Retrieves detailed information about a specific position including current value, quantity, performance, and market data.

Inputs: symbol (required), data_source (required). Returns: object

get_symbol_dataGet Symbol DataB
Read-onlyIdempotent

Get symbol data for a specific asset from a data source.

Retrieves detailed information about a specific symbol including current price, market data, and asset information.

Inputs: symbol (required), data_source (required). Returns: object

get_user_infoGet User InfoB
Read-onlyIdempotent

Get user information and settings.

Retrieves information about the current user including settings, preferences, and account details.

Inputs: no named parameters. Returns: object

get_watchlistGet WatchlistB
Read-onlyIdempotent

Get all items in the user's watchlist.

Retrieves list of all watchlisted symbols.

Inputs: no named parameters. Returns: object

import_transactionsImport TransactionsA

Import transactions into your portfolio. This is a write operation.

Imports a batch of transactions (buy/sell orders) into your Ghostfolio portfolio. This is useful for bulk importing historical data or transactions from other platforms.

Inputs: data (required). Returns: object

lookup_symbolsLookup SymbolsA
Read-onlyIdempotent

Search for symbols using a query string.

Search for financial symbols, stocks, ETFs, and other assets using a text query. Optionally include market indices in the results.

Inputs: query (required), include_indices. Returns: object

remove_from_watchlistRemove From WatchlistA
DestructiveIdempotent

Remove a symbol from the user's watchlist.

Inputs: symbol (required), data_source (required). Returns: object

transfer_account_balanceTransfer Account BalanceA

Transfer cash balances between two accounts.

Inputs: balance (required), account_id_to (required), account_id_from (required). Returns: object

update_accountUpdate AccountA
DestructiveIdempotent

Update settings or details of an existing account.

Ghostfolio's update endpoint replaces the whole account record, so name, currency and platform_id are required on every request even when they are not changing. Any left unset here are backfilled from the account's current state with a GET before the PUT, so you only need to pass the fields you actually want to change. If name or currency can't be backfilled (e.g. the account doesn't exist), the update stops before the PUT and names them.

Setting balance here applies it as today's entry in the account's balance history (the same series get_account_balances returns and get_portfolio_holdings derives its cash figure from) - it is not a separate stale field. Use create_account_balance to set the balance for a specific past date instead of today.

Inputs: account_id (required), name, balance, comment, +2 more. Returns: object

update_activityUpdate ActivityA
DestructiveIdempotent

Update an existing activity/transaction.

Ghostfolio's update endpoint replaces the whole activity record, so type, symbol, date, quantity, unitPrice, currency, dataSource and fee are required on every request even when they are not changing. Any left unset here (including tags, account_id and comment) are backfilled from the activity's current state with a GET before the PUT, so you only need to pass the fields you actually want to change. If a required field can't be backfilled (Ghostfolio redacts quantity and fee in restricted views), pass it explicitly. A restricted view also redacts comment, and Ghostfolio clears the comment whenever the update carries none, so in that case comment is required too (pass an empty string to clear it).

Ghostfolio identifies the asset by dataSource and symbol together, and the current currency belongs to that asset. So changing either symbol or data_source requires passing symbol, data_source and currency together; backfilling the rest from the old asset would attach the activity to the wrong asset profile or price it in the wrong currency. Ghostfolio ignores an asset change (without an error) when the resulting activity is a FEE, INTEREST or LIABILITY, or a BUY on the MANUAL data source; delete and re-create the activity instead.

The GET and PUT are separate requests, so an edit made to the same activity in between (e.g. in the Ghostfolio UI) is overwritten for every field not passed here.

Inputs: activity_id (required), fee, date, tags, +8 more. Returns: object

upsert_asset_profileUpsert Asset ProfileA
Idempotent

Create-or-update an asset profile.

POSTs an empty profile-data record (idempotent — Ghostfolio answers HTTP 400 "already exists" when the profile is already there, and HTTP 500 on some first-time-create paths while still persisting the record, so this tolerates both). Then PATCHes metadata (name, currency, asset class, optional sub-class, optional country and sector allocations). PATCH is the source of truth — if the profile doesn't exist after the POST, PATCH will surface the error. Calling twice with the same input yields the same end state.

Inputs: name (required), symbol (required), currency (required), asset_class (required), +4 more. Returns: object

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    B3.3/5.0

    Scored across 39 tools

    Disambiguation3/5

    Several tool clusters overlap: get_symbol_data, get_market_data_for_asset, get_historical_data, get_position, and get_asset_profile all retrieve symbol/asset-level data, and get_portfolio_details, get_portfolio_holdings, get_portfolio_performance, get_investments, and get_dividends all return time-grouped portfolio breakdowns. Descriptions do differentiate them (e.g. current price vs. historical date vs. position quantity vs. company metadata), which keeps selection mostly possible, but an agent must read carefully to pick correctly.

    Naming Consistency4/5

    Nearly all tools are snake_case with a leading verb, but the verb set is broad (get/create/update/delete/add/upsert/remove/lookup/transfer/export/import) and there are minor inconsistencies like lookup_symbols vs get_*, upsert_asset_profile vs update_activity, and remove_from_watchlist vs delete_*. Still, the pattern is largely predictable and readable.

    Tool Count2/5

    39 tools is heavy even for a full portfolio-management API, spanning accounts, activities, balances, asset profiles, market data, watchlist, benchmarks, import/export, and health. It exceeds the 25+ 'too many' threshold and could be consolidated (e.g. merging the asset-data getters).

    Completeness4/5

    Coverage is broad: CRUD for accounts and activities, balance history, asset profiles, market data, watchlist add/remove, benchmarks, portfolio reporting, import/export, and health. Minor gaps exist (no create/update benchmark, no get-single-activity by ID), but most workflows are fully covered.

    Maintenance

    ActivityActive
    ResponsivenessLimited data

    Related MCP Connectors

    Related MCP Servers

    • F
      license
      Not graded
      quality
      F
      maintenance
      Integrates with Wealthfolio to provide real-time portfolio data, valuations, account management, and historical performance analytics through a Model Context Protocol interface compatible with OpenWebUI and automation tools.
      1
      -
    • A
      license
      Not graded
      quality
      D
      maintenance
      FastMCP server exposing brokerage and market tools (Angel One, Coinbase, News) via the Model Context Protocol, enabling portfolio queries and trade execution through natural language.
      1
      MIT
    • A
      license
      Not graded
      quality
      D
      maintenance
      A read-only Model Context Protocol server that connects your Schwab brokerage account to LLM applications for portfolio monitoring and market data retrieval.
      MIT