get_market_regimeMarket-wide breadth of unusual flow per trading day: breadth score 0-100, aggregate call/put ratio, regime label (bullish/bearish/mixed) and signal counts. Use for 'what's the overall tone of the unusual-flow tape?'
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| date_to | No | Range end, YYYY-MM-DD inclusive. | |
| date_from | No | Range start, YYYY-MM-DD inclusive. |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must carry the burden of disclosing behavioral traits. It mentions output metrics but does not indicate read-only status, default date ranges, meaning of limit, or how results are aggregated. This leaves significant ambiguity for an agent deciding whether to invoke the tool.
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 a single, focused sentence that front-loads the key output and ends with an explicit use case. Every word contributes value, with no repetition or filler.
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?
Given the absence of an output schema and annotations, the description should fully explain behavior, but it only lists a few output fields. It does not clarify what happens with optional parameters, the format of the returned data, or how the regime label is determined. This is incomplete for a tool with 3 optional parameters and no rich structured metadata.
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?
Schema description coverage is 67% (date params have descriptions) but the 'limit' parameter has no schema description and is not mentioned in the tool description. The description adds no parameter-specific meaning beyond what the schema already provides, leaving the agent to guess how limit affects the result.
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 description clearly states what the tool provides: market-wide breadth of unusual flow, breadth score, call/put ratio, and regime label. It distinguishes this tool from siblings like get_symbol_flow and get_sector_flow by focusing on the overall market tone. However, it uses a noun phrase rather than an explicit verb like 'get' or 'return', so it doesn't fully earn a 5.
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 explicitly includes a use case: "Use for 'what's the overall tone of the unusual-flow tape?'" This helps the agent know when to select this tool. It doesn't name alternatives or exclusions, which prevents a 5, but the guidance is clear and context-appropriate.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.
Each tool targets a distinct analytical view (contract scan, per-symbol detail, history, sentiment, etc.), with clear boundaries. The only minor overlap is between get_symbol_flow and get_unusual_activity when filtering by a single symbol, but descriptions clarify the difference (single-symbol detail vs. broad scanner).
All tool names follow a consistent get_<object> pattern (e.g., get_expiry_concentration, get_oi_changes), with ping as the standard exception for liveness checks. The naming is predictable and uniform.
13 tools is well within the ideal range for a specialized data analytics server. Each tool covers a distinct query type and earns its place without redundancy.
The tool surface comprehensively covers the domain of unusual options flow discovery and analysis: data discovery, contract-level scans, per-symbol views, time series, sentiment, and market-wide aggregations. No obvious gaps or dead ends.