Skip to main content
Glama
QuantConnect

QuantConnect

Official
by QuantConnect

read_optimization

Read-only

Retrieve an optimization's configuration and results by providing its unique ID.

Instructions

Read an optimization.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
modelYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
optimizationNoOptimization object requested to read.
successNoIndicate if the API request was successful.
errorsNoList of errors with the API call.
Behavior2/5

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

The description merely repeats 'Read' with no additional behavioral context beyond the annotation readOnlyHint=true. It adds no insight into permissions, side effects, or response format.

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?

Extremely concise at one sentence. It is not verbose, but the conciseness comes at the cost of missing useful information. Still, it is well-structured and front-loaded.

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

Completeness3/5

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

Given the simplicity of a read operation and the presence of an output schema, the description is minimally adequate. However, it could mention the required optimizationId or hint at the tool's purpose relative to siblings.

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

Parameters1/5

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

Description does not mention the single required parameter (optimizationId) and provides no parameter guidance. Schema coverage is 0%, so the description fails to compensate for missing parameter semantics.

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

Purpose4/5

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

Description states 'Read an optimization' which is a clear verb-resource pair. However, it does not differentiate itself from sibling tools like read_backtest or read_project, which have similar structure.

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

Usage Guidelines2/5

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

No guidance on when to use this tool versus alternatives such as list_optimizations or update_optimization. The description fails to provide any usage context or exclusions.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/QuantConnect/mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server