SingleStore MCP Server

Instructions

Implementation Reference

• src/api/tools/workspaces/workspaces.py:16-102 (handler)

  The core handler function for the 'workspaces_info' tool. It validates the workspace_group_id, fetches workspace data using the SDK, formats it into a structured dictionary, tracks analytics, and returns success/error responses with metadata.
  def workspaces_info(workspace_group_id: str) -> dict: """ List all workspaces within a specified workspace group in SingleStore. Returns detailed information for each workspace: - createdAt: Timestamp of workspace creation - deploymentType: Type of deployment (e.g., 'PRODUCTION') - endpoint: Connection URL for database access - name: Display name of the workspace - size: Compute and storage configuration - state: Current status (e.g., 'ACTIVE', 'PAUSED') - terminatedAt: End timestamp if applicable - workspaceGroupID: Workspacegroup identifier - workspaceID: Unique workspace identifier Args: workspace_group_id: Unique identifier of the workspace group Returns: List of workspace information dictionaries """ # Validate workspace group ID format validated_group_id = validate_uuid_string(workspace_group_id) start_time = time.time() settings = config.get_settings() user_id = config.get_user_id() settings.analytics_manager.track_event( user_id, "tool_calling", {"name": "workspaces_info", "workspace_group_id": validated_group_id}, ) # Use the SDK to get workspaces for the group workspace_manager = utils.get_workspace_manager() try: group = workspace_manager.get_workspace_group(validated_group_id) except Exception as e: logger.error(f"Failed to fetch workspaces for group {validated_group_id}: {e}") return { "status": "error", "message": f"Failed to fetch workspaces for group {validated_group_id}: {str(e)}", "errorCode": "WORKSPACES_FETCH_FAILED", } workspaces = [] for ws in group.workspaces: wdict = { "workspaceID": ws.id, "name": ws.name, "workspaceGroupID": getattr(ws, "group_id", None), "size": ws.size, "state": ws.state, "endpoint": ws.endpoint, "auto_suspend": ws.auto_suspend, "cache_config": ws.cache_config, "deployment_type": ws.deployment_type, "resume_attachments": ws.resume_attachments, "scaling_progress": ws.scaling_progress, "last_resumed_at": ( ws.last_resumed_at.isoformat() if getattr(ws, "last_resumed_at", None) else None ), "created_at": ( ws.created_at.isoformat() if getattr(ws, "created_at", None) else None ), "terminated_at": ( ws.terminated_at.isoformat() if getattr(ws, "terminated_at", None) else None ), } workspaces.append(wdict) execution_time = (time.time() - start_time) * 1000 return { "status": "success", "message": f"Retrieved {len(workspaces)} workspaces from group {workspace_group_id}", "data": workspaces, "metadata": { "execution_time_ms": round(execution_time, 2), "count": len(workspaces), "timestamp": datetime.now(timezone.utc).isoformat(), }, }
• src/api/tools/tools.py:31-50 (registration)

  The 'workspaces_info' tool is registered in the central tools_definition list at index with {"func": workspaces_info}. This list is converted into Tool objects used by the MCP server.
  tools_definition = [ {"func": get_user_info}, {"func": organization_info}, {"func": choose_organization}, {"func": set_organization}, {"func": workspace_groups_info}, {"func": workspaces_info}, {"func": resume_workspace}, {"func": list_starter_workspaces}, {"func": create_starter_workspace}, {"func": terminate_starter_workspace}, {"func": list_regions}, {"func": list_sharedtier_regions}, {"func": run_sql}, {"func": create_notebook_file}, {"func": upload_notebook_file}, {"func": create_job_from_notebook}, {"func": get_job}, {"func": delete_job}, ]