update_project
Modify project details in QuantConnect by updating the name or description to reflect changes in your trading strategy development.
Instructions
Update a project's name and/or description.
Args: project_id: ID of the project to update name: Optional new name for the project description: Optional new description for the project
Returns: Dictionary containing update result
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | ||
| name | No | ||
| description | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- The handler function that implements the 'update_project' tool logic. It updates a QuantConnect project's name and/or description by making an authenticated API request to the 'projects/update' endpoint.
@mcp.tool() async def update_project( project_id: int, name: Optional[str] = None, description: Optional[str] = None ) -> Dict[str, Any]: """ Update a project's name and/or description. Args: project_id: ID of the project to update name: Optional new name for the project description: Optional new description for the project Returns: Dictionary containing update result """ auth = get_auth_instance() if auth is None: return { "status": "error", "error": "QuantConnect authentication not configured. Use configure_auth() first.", } # Validate at least one field is provided if name is None and description is None: return { "status": "error", "error": "At least one of 'name' or 'description' must be provided for update", } try: # Prepare request data request_data: Dict[str, Any] = {"projectId": int(project_id)} if name is not None: request_data["name"] = name if description is not None: request_data["description"] = description # Make API request response = await auth.make_authenticated_request( endpoint="projects/update", method="POST", json=request_data ) # Parse response if response.status_code == 200: data = response.json() if data.get("success", False): update_fields = [] if name is not None: update_fields.append(f"name to '{name}'") if description is not None: update_fields.append(f"description") return { "status": "success", "project_id": project_id, "updated_fields": update_fields, "message": f"Successfully updated project {project_id}: {', '.join(update_fields)}", } else: # API returned success=false errors = data.get("errors", ["Unknown error"]) return { "status": "error", "error": "Project update failed", "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 update project: {str(e)}", "project_id": project_id, } - quantconnect_mcp/main.py:46-52 (registration)The registration of project tools (including 'update_project') by calling register_project_tools(mcp) in the main entry point.
safe_print("🔧 Registering QuantConnect tools...") register_auth_tools(mcp) register_project_tools(mcp) register_file_tools(mcp) register_backtest_tools(mcp) register_live_tools(mcp) register_optimization_tools(mcp) - quantconnect_mcp/src/tools/project_tools.py:8-316 (registration)The register_project_tools function defines and registers the 'update_project' tool using @mcp.tool() decorator.
def register_project_tools(mcp: FastMCP): """Register project management tools with the MCP server.""" @mcp.tool() async def create_project( name: str, language: str = "Py", organization_id: Optional[str] = None ) -> Dict[str, Any]: """ Create a new project in your QuantConnect organization. Args: name: Project name (must be unique within organization) language: Programming language - "C#" or "Py" (default: "Py") organization_id: Optional organization ID (uses default if not specified) Returns: Dictionary containing project creation result with project details """ auth = get_auth_instance() if auth is None: return { "status": "error", "error": "QuantConnect authentication not configured. Use configure_auth() first.", } # Validate language parameter valid_languages = ["C#", "Py"] if language not in valid_languages: return { "status": "error", "error": f"Invalid language '{language}'. Must be one of: {valid_languages}", } try: # Prepare request data request_data = {"name": name, "language": language} # Add organization ID if provided, otherwise use the auth instance's default if organization_id: request_data["organizationId"] = organization_id elif auth.organization_id: request_data["organizationId"] = auth.organization_id # Make API request response = await auth.make_authenticated_request( endpoint="projects/create", method="POST", json=request_data ) # Parse response if response.status_code == 200: data = response.json() if data.get("success", False): # Extract project info from the response projects = data.get("projects", []) if projects: # The newly created project should be in the list created_project = None for project in projects: if ( project.get("name") == name and project.get("language") == language ): created_project = project break if created_project: return { "status": "success", "project": created_project, "message": f"Successfully created project '{name}' with {language} language", } # Fallback response if project not found in list return { "status": "success", "project": { "name": name, "language": language, "organizationId": request_data.get("organizationId"), }, "message": f"Successfully created project '{name}' with {language} language", "note": "Full project details not available in response", } else: # API returned success=false errors = data.get("errors", ["Unknown error"]) return { "status": "error", "error": "Project creation failed", "details": errors, "api_response": data, } 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 create project: {str(e)}", "project_name": name, "language": language, } @mcp.tool() async def read_project(project_id: Optional[int] = None) -> Dict[str, Any]: """ Read project details by ID or list all projects if no ID provided. Args: project_id: Optional project ID to get specific project details. If not provided, returns list of all projects. Returns: Dictionary containing project details or list of all projects """ 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 = {} if project_id is not None: request_data["projectId"] = project_id # Make API request response = await auth.make_authenticated_request( endpoint="projects/read", method="POST", json=request_data ) # Parse response if response.status_code == 200: data = response.json() if data.get("success", False): projects = data.get("projects", []) versions = data.get("versions", []) # If specific project ID was requested if project_id is not None: if projects: return { "status": "success", "project": projects[0], "versions": versions, "message": f"Successfully retrieved project {project_id}", } else: return { "status": "error", "error": f"Project with ID {project_id} not found", } # If no project ID specified, return all projects else: return { "status": "success", "projects": projects, "total_projects": len(projects), "versions": versions, "message": f"Successfully retrieved {len(projects)} projects", } else: # API returned success=false errors = data.get("errors", ["Unknown error"]) return { "status": "error", "error": "Failed to read project(s)", "details": errors, "api_response": data, } 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 project(s): {str(e)}", "project_id": project_id, } @mcp.tool() async def update_project( project_id: int, name: Optional[str] = None, description: Optional[str] = None ) -> Dict[str, Any]: """ Update a project's name and/or description. Args: project_id: ID of the project to update name: Optional new name for the project description: Optional new description for the project Returns: Dictionary containing update result """ auth = get_auth_instance() if auth is None: return { "status": "error", "error": "QuantConnect authentication not configured. Use configure_auth() first.", } # Validate at least one field is provided if name is None and description is None: return { "status": "error", "error": "At least one of 'name' or 'description' must be provided for update", } try: # Prepare request data request_data: Dict[str, Any] = {"projectId": int(project_id)} if name is not None: request_data["name"] = name if description is not None: request_data["description"] = description # Make API request response = await auth.make_authenticated_request( endpoint="projects/update", method="POST", json=request_data ) # Parse response if response.status_code == 200: data = response.json() if data.get("success", False): update_fields = [] if name is not None: update_fields.append(f"name to '{name}'") if description is not None: update_fields.append(f"description") return { "status": "success", "project_id": project_id, "updated_fields": update_fields, "message": f"Successfully updated project {project_id}: {', '.join(update_fields)}", } else: # API returned success=false errors = data.get("errors", ["Unknown error"]) return { "status": "error", "error": "Project update failed", "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 update project: {str(e)}", "project_id": project_id, }