Skip to main content
Glama
roman-zaglauer

OctoBot MCP Server

get_historical_portfolio_value

Retrieve historical portfolio value samples with optional filters for currency, exchange, time frame, and timestamp range to analyze past portfolio performance.

Instructions

Fetch historical portfolio value samples, optionally filtered.

Maps to GET /api/historical_portfolio_value -- query parameters confirmed against OctoBot source (api/trading.py::historical_portfolio_value(), master branch, [V] this session): currency (OctoBot defaults this to "USDT" server-side if omitted), time_frame, from_timestamp, to_timestamp, and exchange are all optional query-string filters. Read-only, not confirm-gated. Returns OctoBot's own JSON body unchanged (NFR-8).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
currencyNo
exchangeNo
time_frameNo
to_timestampNo
from_timestampNo

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observedv0.1.0

TDQS

A3.9/5.0
Behavior4/5

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

With no annotations, the description carries the full behavioral burden. It explicitly discloses that the operation is read-only, is not confirm-gated, returns OctoBot's JSON body unchanged, and that currency defaults to USDT server-side. This is strong transparency for a simple fetch tool.

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?

The description is front-loaded with the core purpose and stays reasonably compact. The source-confirmation detail is useful but makes the second sentence dense; still, every sentence contributes relevant information.

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

Completeness4/5

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

For a read-only GET-like tool with five optional parameters and no output schema, the description covers endpoint, parameter optionality, default behavior, and response identity. It could be more complete about return value structure and parameter formats, but it is sufficient for correct invocation in most cases.

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

Parameters3/5

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

Schema description coverage is 0%, so the description must compensate. It names all five query parameters and states they are optional filters, and it adds the useful currency default behavior. However, it does not explain timestamp formats, time_frame units, or valid exchange values, leaving meaningful semantic gaps.

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?

The description starts with a specific verb and resource: 'Fetch historical portfolio value samples, optionally filtered.' It also names the exact endpoint, making the tool's scope unambiguous and distinct from sibling tools like get_pnl_history or get_orders.

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

Usage Guidelines3/5

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

The description gives useful invocation context: all query parameters are optional, and the call is read-only. However, it does not explicitly say when to prefer this tool over sibling tools or when not to use it, leaving some selection reasoning to the agent.

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