QuantConnect MCP Server

Instructions

Implementation Reference

• quantconnect_mcp/src/tools/optimization_tools.py:206-280 (handler)

  The handler function for the 'read_optimization' tool. It authenticates with QuantConnect, makes a POST request to the /optimizations/read endpoint, and returns the optimization details or error information.

  @mcp.tool()
  async def read_optimization(
      optimization_id: str
  ) -> Dict[str, Any]:
      """
      Read an optimization by its ID.
  
      Args:
          optimization_id: ID of the optimization to read
  
      Returns:
          Dictionary containing optimization details and results
      """
      auth = get_auth_instance()
      if auth is None:
          return {
              "status": "error",
              "error": "QuantConnect authentication not configured. Use configure_auth() first.",
          }
  
      try:
          # Prepare request data
          request_data = {"optimizationId": optimization_id}
  
          # Make API request
          response = await auth.make_authenticated_request(
              endpoint="optimizations/read", method="POST", json=request_data
          )
  
          # Parse response
          if response.status_code == 200:
              data = response.json()
  
              if data.get("success", False):
                  optimization = data.get("optimization", {})
                  
                  return {
                      "status": "success",
                      "optimization_id": optimization_id,
                      "optimization": optimization,
                      "message": f"Successfully read optimization {optimization_id}",
                  }
              else:
                  # API returned success=false
                  errors = data.get("errors", ["Unknown error"])
                  return {
                      "status": "error",
                      "error": "Failed to read optimization",
                      "details": errors,
                      "optimization_id": optimization_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 optimization: {str(e)}",
              "optimization_id": optimization_id,
          }

• quantconnect_mcp/main.py:52-52 (registration)

  Call to register_optimization_tools(mcp) which defines and registers the read_optimization tool among others.

  register_optimization_tools(mcp)

• quantconnect_mcp/src/server.py:79-79 (registration)

  Call to register_optimization_tools(mcp) which defines and registers the read_optimization tool among others.

  register_optimization_tools(mcp)