get_stream_url
Get the SSE stream URL for real-time optimization updates. Connect to this URL with EventSource for live progress.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| processId | Yes | The optimization process ID to stream |
Get the SSE stream URL for real-time optimization updates. Connect to this URL with EventSource for live progress.
| Name | Required | Description | Default |
|---|---|---|---|
| processId | Yes | The optimization process ID to stream |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and destructiveHint=false, so safety is covered; the description adds real value by disclosing that the return is a URL to be consumed via EventSource rather than data itself, which matters with no output schema. It omits URL lifetime/expiry and auth requirements, so not a 5.
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?
Two short sentences, zero filler, with the what (SSE stream URL) front-loaded before the how-to-consume instruction.
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 single-parameter read tool with no output schema, the description adequately explains what is returned (an SSE URL) and how to use it. Missing only minor operational details such as URL validity window or whether the stream terminates on process completion.
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?
Only one parameter with 100% schema description coverage ('The optimization process ID to stream'), so the schema already carries the semantics. The description adds no format, source, or constraint detail beyond what the schema states – baseline 3 is appropriate.
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?
States a specific verb+resource ('Get the SSE stream URL') and scopes it to real-time optimization updates, which distinguishes it from plain-read siblings like get_optimization_details and get_model_optimization_status. It does not name any sibling explicitly, so it falls just short of 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?
'Connect to this URL with EventSource for live progress' implies the usage context (live streaming rather than polling), but never states when to prefer this over the status/details siblings or any exclusions. Usage is implied rather than prescribed.
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.