Skip to main content
Glama

read_live_insights

Retrieve real-time trading insights from active algorithms to monitor performance and analyze strategy execution.

Instructions

Read insights from a live algorithm.

Args: project_id: Project ID of the live algorithm start: Starting index of insights to fetch (default: 0) end: Last index of insights to fetch (default: 100, max range: 100)

Returns: Dictionary containing live algorithm insights data

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_idYes
startNo
endNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The core handler function for the 'read_live_insights' MCP tool. It validates input parameters (project_id, start, end indices), authenticates with QuantConnect, sends a POST request to the '/live/read/insights' API endpoint, and returns the insights data or error details. The function is decorated with @mcp.tool() for automatic registration.
    @mcp.tool()
    async def read_live_insights(
        project_id: int, start: int = 0, end: int = 100
    ) -> Dict[str, Any]:
        """
        Read insights from a live algorithm.
    
        Args:
            project_id: Project ID of the live algorithm
            start: Starting index of insights to fetch (default: 0)
            end: Last index of insights to fetch (default: 100, max range: 100)
    
        Returns:
            Dictionary containing live algorithm insights data
        """
        auth = get_auth_instance()
        if auth is None:
            return {
                "status": "error",
                "error": "QuantConnect authentication not configured. Use configure_auth() first.",
            }
    
        # Validate range
        if end - start > 100:
            return {
                "status": "error",
                "error": "Range too large: end - start must be less than or equal to 100",
            }
    
        if start < 0 or end < 0:
            return {
                "status": "error",
                "error": "Start and end indices must be non-negative",
            }
    
        if start >= end:
            return {
                "status": "error",
                "error": "Start index must be less than end index",
            }
    
        try:
            # Prepare request data
            request_data = {
                "projectId": project_id,
                "start": start,
                "end": end,
            }
    
            # Make API request
            response = await auth.make_authenticated_request(
                endpoint="live/read/insights", method="POST", json=request_data
            )
    
            # Parse response
            if response.status_code == 200:
                data = response.json()
    
                if data.get("success", False):
                    insights = data.get("insights", [])
                    length = data.get("length", 0)
    
                    return {
                        "status": "success",
                        "project_id": project_id,
                        "start": start,
                        "end": end,
                        "insights": insights,
                        "length": length,
                        "message": f"Successfully retrieved {length} insights from live algorithm {project_id} (range: {start}-{end})",
                    }
                else:
                    # API returned success=false
                    errors = data.get("errors", ["Unknown error"])
                    return {
                        "status": "error",
                        "error": "Failed to read live algorithm insights",
                        "details": errors,
                        "project_id": project_id,
                    }
    
            elif response.status_code == 401:
                return {
                    "status": "error",
                    "error": "Authentication failed. Check your credentials and ensure they haven't expired.",
                }
    
            else:
                return {
                    "status": "error",
                    "error": f"API request failed with status {response.status_code}",
                    "response_text": (
                        response.text[:500]
                        if hasattr(response, "text")
                        else "No response text"
                    ),
                }
    
        except Exception as e:
            return {
                "status": "error",
                "error": f"Failed to read live algorithm insights: {str(e)}",
                "project_id": project_id,
                "start": start,
                "end": end,
            }
  • Call to register_live_tools(mcp) which registers all live trading tools, including 'read_live_insights', onto the FastMCP server instance.
    register_live_tools(mcp)
    register_optimization_tools(mcp)
Behavior2/5

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

With no annotations provided, the description carries full burden but only minimally describes behavior. It mentions default values and a max range for parameters, but doesn't cover critical aspects like authentication needs, rate limits, error conditions, or what 'live algorithm insights data' entails beyond a dictionary.

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 well-structured with clear sections for Args and Returns, and each sentence adds value. It could be slightly more concise by integrating the max range note into the 'end' parameter description, but overall it's efficient 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 no annotations, 3 parameters with 0% schema coverage, and an output schema present, the description is adequate but has gaps. It covers parameters well and notes the return is a dictionary, but lacks details on authentication, error handling, or insights format, which are important for a live data tool.

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

Parameters4/5

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

Schema description coverage is 0%, so the description must compensate. It effectively explains all three parameters: 'project_id' as the project ID, 'start' as the starting index with default 0, and 'end' as the last index with default 100 and max range 100. This adds clear meaning beyond the bare schema.

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 verb 'Read' and resource 'insights from a live algorithm', making the purpose specific and understandable. However, it doesn't explicitly differentiate from sibling tools like 'read_backtest_insights' or 'read_live_logs', which would require a 5.

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 like 'read_backtest_insights' or other live algorithm reading tools. It lacks context about prerequisites or typical use cases, offering only basic parameter defaults.

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/taylorwilsdon/quantconnect-mcp'

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