refresh_portfolio

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

With no annotations provided, the description carries the full behavioral disclosure burden and does so thoroughly: it reveals the exact HTTP method and request body, the literal success payload, the exception type and message, the expected failure case, and the non-destructive nature of the operation. This is far more transparency than an agent would get from the empty schema alone.

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

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

The description is front-loaded with the core action and then logically organized into request shape, success, failure, and confirmation status. It is somewhat wordy with implementation archaeology like 'confirmed against source', 'NFR-8', and 'ADR-0003', but those details still contribute behavioral clarity in the absence of annotations.

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

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

For a zero-parameter tool with no output schema and no annotations, this description is effectively complete: it covers the request shape, the exact success response, the failure exception, and the common false-alarm scenario of a simulated-only instance. An agent has everything needed to call it correctly and interpret the result.

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

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

The input schema has zero parameters, and the description still goes beyond the baseline by explicitly stating that the POST has no request body and that no confirm parameter exists. This removes any doubt that the tool must be invoked with an empty argument object.

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

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

The opening sentence names a specific action ('trigger an immediate refresh') and a precise resource ('every enabled real (non-simulated) trader's portfolio'), clearly distinguishing it from read-only or history siblings like get_positions and get_historical_portfolio_value. The endpoint mapping reinforces the operation without ambiguity.

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

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

The description clearly conveys the tool's scope and explicitly flags that a failure on simulated-only instances is expected, which provides useful context. However, it never states when to prefer this tool over alternatives such as get_historical_portfolio_value or get_positions, so the when-to-use guidance remains implied rather than explicit.

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