Ghostfolio MCP Server

by mhajder

Overview Schema Source Related Servers Discussions Admin

Python

Remote

Update Account

update_account

DestructiveIdempotent

Update settings or details of an existing account.

Instructions

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.

Input Schema

Name	Required	Description
`name`	No	Optional new name of the account
`balance`	No	Optional new balance for the account
`comment`	No	Optional new comment or note for the account
`currency`	No	Optional new currency code for the account (e.g., 'USD', 'EUR')
`account_id`	Yes	Account ID to update
`platform_id`	No	Optional new platform ID for the account

Output Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv1.6.2Sep 3, 2026

removedInput schema / properties / is_excluded

Removed value: -{
-  "anyOf": [
-    {
-      "type": "boolean"
-    },
-    {
-      "type": "null"
-    }
-  ],
-  "default": null,
-  "description": "Optional boolean to exclude/include in portfolio calculations"
-}

First observedv1.5.0Jul 17, 2026

TDQS

A4.6/5.0

Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Goes well beyond the annotations (which only declare non-read-only, idempotent, destructive) by explaining the PUT-replaces-whole-record semantics, the pre-PUT GET backfill, the failure mode when name/currency can't be backfilled, and where the balance lands in the history series. This directly de-fangs the destructiveHint=true concern.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loads the purpose, then layers mechanism and the balance/date distinction. Dense but every sentence carries operational value; slightly long for a single tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a destructive-replacing mutation with an output schema present, the description covers required-field quirks, backfill behavior, failure handling, and balance-history semantics — nothing an agent needs is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so baseline is 3; the description adds real meaning by clarifying that name/currency/platform_id are required server-side yet optional client-side due to backfill, and that balance means today's entry rather than a stale field.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Update settings or details of an existing account') and implicitly separates it from create_account, delete_account, and create_account_balance, which the description later names explicitly.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives clear routing guidance: 'Use create_account_balance to set the balance for a specific past date instead of today,' and reassures that unset fields are backfilled so callers need only pass changed fields. No explicit when-not-to-use for the whole tool, hence 4.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.