Skip to main content
Glama
QuantConnect

QuantConnect

Official
by QuantConnect

read_compile

Read-only

Retrieve the result of a previously submitted compile job by providing the project ID and compile ID.

Instructions

Read a compile packet job result.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
modelYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
compileIdNoCompile Id for a successful build.
stateNoThe current state of the compile job.
logsNoLogs of the compilation request.
successNoIndicate if the API request was successful.
errorsNoList of errors with the API call.
Behavior3/5

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

Annotations provide readOnlyHint=true, and the description explicitly uses 'Read', which is consistent. However, the description adds no additional behavioral traits beyond what annotations already convey, such as whether the operation is fast or error-prone.

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 a single sentence with no filler. It is appropriately concise, though it could include a bit more context without becoming verbose.

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 tool's simplicity and the presence of an output schema, the description is minimally adequate but lacks contextual completeness regarding prerequisites (e.g., needing create_compile first) and relationship to sibling tools.

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

Parameters2/5

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

Schema description coverage is 0% for the top-level parameter, but nested properties have descriptions. The tool description does not add semantic meaning to parameters; it only states the overall purpose. The schema descriptions for projectId and compileId are more informative than the tool description.

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?

The description clearly states the tool reads a compile packet job result, using a specific verb and resource. It distinguishes from sibling tools like create_compile (write) and other read tools by focusing on compile results.

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?

The description provides no guidance on when to use this tool versus alternatives. It does not mention that a compile must have been created first or that compileId comes from create_compile. The schema provides some hints, but the description itself lacks usage context.

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