Skip to main content
Glama

run_forecast

Run a forecast now. Reserves AI credits up front, dispatches the backtest + projection + correlation pipeline, and returns either the completed result inline (wait_seconds > 0 and the run finishes in time) or a run_id you can poll with get_forecast_run.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
forecast_idYes
wait_secondsNoSeconds to wait for the run to finish before returning a poll handle. 0 = return immediately with the run_id.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultNoPresent when status reaches "completed".
run_idYes
statusYespending while queued, running mid-execution, completed/failed/refunded when terminal.
poll_toolNoTool to poll if the run is still running ("get_forecast_run").
credits_consumedNo
credits_refundedNo
credits_reservedNo

TDQS

A4.4/5.0
Behavior5/5

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

Annotations are all false, providing no safety hints, so the description carries the burden. It discloses meaningful side effects: "Reserves AI credits up front" and dispatches a multi-stage pipeline. It also clearly describes the asynchronous behavior and what determines the return path. This exceeds what the annotations or schema convey, offering high transparency.

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

Conciseness5/5

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

Two sentences, both dense and purposeful. The first identifies the action, the second details behavior and outcomes. No filler or repetition; the structure front-loads the core purpose. This is exemplary conciseness.

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?

The tool is complex (cost, async, pipeline), yet the description covers purpose, cost side-effect, pipeline components, and the two return paths. An output schema exists, so return values need not be explained. Missing are prerequisites (e.g., forecast must exist) and potential error conditions, but these are not critical given the description's breadth. Overall, it is largely complete for an execution tool.

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 50%: wait_seconds has a description, forecast_id does not. The description adds context about wait_seconds by linking it to the inline-vs-poll outcome, but it doesn't elaborate on forecast_id beyond what the name and format imply. Since coverage is not low, a baseline of 3 is appropriate, and the description adds moderate value without fully compensating for the undocumented forecast_id.

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 clearly states the tool's function with a specific verb and resource: "Run a forecast now." It distinguishes from siblings by naming the dispatched pipeline (backtest + projection + correlation) and the two return modes (inline result vs. pollable run_id). This makes it clear that run_forecast initiates a run, unlike create_forecast or get_forecast_run.

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?

The description provides concrete usage guidance: it explains how wait_seconds controls whether you get the result inline or a poll handle, and explicitly references get_forecast_run for polling. However, it does not explicitly state prerequisites (e.g., the forecast must already exist) or when not to use this tool in favor of alternatives like run_analysis, so it stops short of full when/when-not guidance.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A3.9/5.0
Disambiguation4/5

Tools are generally distinct by resource and action, but a few status polling tools (check_integration_status, get_analysis_status) could be confused without careful reading; descriptions clarify the difference.

Naming Consistency4/5

Most tools use a consistent verb_noun snake_case pattern, but there is minor variation (e.g., 'check' vs 'get' for status, and some compound nouns like 'request_oauth_integration_url').

Tool Count4/5

26 tools is slightly above the typical range but appropriate for a comprehensive BI platform covering data ingestion, analysis, forecasting, reports, dashboards, and account management; each tool has a clear purpose.

Completeness2/5

The tool surface is heavily read-oriented, lacking update and delete operations for most resources (data sources, dashboards, reports, forecasts). This leaves significant lifecycle management gaps for an agent.

Resources