workspace_groups_info
Retrieve detailed information about all accessible workspace groups in SingleStore, including IDs, deployment types, states, IP ranges, and maintenance windows, to plan operations and manage resources effectively.
Instructions
List all workspace groups accessible to the user in SingleStore.
Returns detailed information for each group:
- name: Display name of the workspace group
- deploymentType: Type of deployment (e.g., 'PRODUCTION')
- state: Current status (e.g., 'ACTIVE', 'PAUSED')
- workspaceGroupID: Unique identifier for the group
- firewallRanges: Array of allowed IP ranges for access control
- createdAt: Timestamp of group creation
- regionID: Identifier for deployment region
- updateWindow: Maintenance window configuration
Use this tool to:
1. Get workspace group IDs for other operations
2. Plan maintenance windows
Related operations:
- Use workspaces_info to list workspaces within a group
- Use execute_sql to run queries on workspaces in a group
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ctx | No |
Implementation Reference
- Main handler function for the 'workspace_groups_info' tool. Fetches workspace groups using the workspace manager, formats them into a structured dictionary, tracks analytics, and returns the data with metadata.def workspace_groups_info() -> dict: """ List all workspace groups accessible to the user in SingleStore. Returns detailed information for each group: - workspaceGroupID: Unique identifier for the group - name: Display name of the workspace group - region: Region information (name, provider) - firewallRanges: List of allowed IP ranges for the group - allowAllTraffic: Whether all traffic is allowed to the group - createdAt: Timestamp of group creation - terminatedAt: Timestamp when the group was terminated (if applicable) Use this tool to: 1. Get workspace group IDs for other operations 2. Plan maintenance windows Related operations: - Use workspaces_info to list workspaces within a group - Use execute_sql to run queries on workspaces in a group """ start_time = time.time() settings = config.get_settings() user_id = config.get_user_id() settings.analytics_manager.track_event( user_id, "tool_calling", {"name": "workspace_groups_info"} ) # Use workspace manager to get workspace groups workspace_manager = utils.get_workspace_manager() workspace_groups = workspace_manager.workspace_groups groups = [ { "workspaceGroupID": group.id, "name": group.name, "region": { "regionName": group.region.name, "provider": group.region.provider, }, "firewallRanges": group.firewall_ranges, "allowAllTraffic": group.allow_all_traffic, "createdAt": group.created_at.isoformat() if group.created_at else None, "terminatedAt": ( group.terminated_at.isoformat() if group.terminated_at else None ), } for group in workspace_groups ] execution_time = (time.time() - start_time) * 1000 return { "status": "success", "message": f"Retrieved {len(groups)} workspace groups", "data": groups, "metadata": { "execution_time_ms": round(execution_time, 2), "count": len(groups), "timestamp": datetime.now(timezone.utc).isoformat(), }, }
- src/api/tools/tools.py:6-10 (registration)Imports the workspace_groups_info function as part of the workspaces tools module for central tool registration.from src.api.tools.workspaces import ( workspaces_info, resume_workspace, workspace_groups_info, )
- src/api/tools/tools.py:36-36 (registration)Registers the workspace_groups_info tool function in the central tools_definition list, which is used to create Tool instances.{"func": workspace_groups_info},
- src/api/tools/workspaces/__init__.py:4-4 (registration)Re-exports the workspace_groups_info function from the workspace_groups submodule for convenient import from the workspaces package.from .workspace_groups import workspace_groups_info