QuantConnect MCP Server

Instructions

Implementation Reference

• quantconnect_mcp/src/tools/backtest_tools.py:130-223 (handler)

  The handler function implementing the 'read_backtest' tool logic. It authenticates with QuantConnect, makes an API request to fetch backtest data, and returns formatted results or errors.

  @mcp.tool()
  async def read_backtest(
      project_id: int, backtest_id: str, chart: Optional[str] = None
  ) -> Dict[str, Any]:
      """
      Read backtest results and statistics from a project.
  
      Args:
          project_id: ID of the project containing the backtest
          backtest_id: ID of the specific backtest to read
          chart: Optional chart name to include chart data in response
  
      Returns:
          Dictionary containing backtest results, statistics, and optional chart data
      """
      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 = {"projectId": project_id, "backtestId": backtest_id}
  
          # Add chart parameter if provided
          if chart is not None:
              request_data["chart"] = chart
  
          # Make API request
          response = await auth.make_authenticated_request(
              endpoint="backtests/read", method="POST", json=request_data
          )
  
          # Parse response
          if response.status_code == 200:
              data = response.json()
  
              if data.get("success", False):
                  backtest_results = data.get("backtest", [])
                  debugging = data.get("debugging", False)
  
                  if backtest_results:
                      backtest = backtest_results[0]
                      return {
                          "status": "success",
                          "project_id": project_id,
                          "backtest_id": backtest_id,
                          "backtest": backtest,
                          "debugging": debugging,
                          "chart_included": chart is not None,
                          "message": f"Successfully read backtest {backtest_id} from project {project_id}",
                      }
                  else:
                      return {
                          "status": "error",
                          "error": f"Backtest {backtest_id} not found in project {project_id}",
                      }
              else:
                  # API returned success=false
                  errors = data.get("errors", ["Unknown error"])
                  return {
                      "status": "error",
                      "error": "Failed to read backtest",
                      "details": errors,
                      "project_id": project_id,
                      "backtest_id": backtest_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 backtest: {str(e)}",
              "project_id": project_id,
              "backtest_id": backtest_id,
          }