Singlestore

Deploy a notebook as a cloud function. The notebook must already exist in the Stage file system shared space. Use stage_upload_file to upload a notebook first, then deploy it as a cloud function. The notebook must define a FastAPI app, and initialize it using a singlestore tool. Base example: from fastapi import FastAPI import singlestoredb.apps as apps app = FastAPI() @app.get("/") async def root(): return {"message": "hello world"} await apps.run_function_app(app) Target_type is optional, but if it specifies a virtual workspace, it must also specify a database_name. Args: name: Name for the cloud function. notebook_path: Path to the notebook in Stage (e.g. "my_notebook.ipynb"). target_id: ID of the workspace, cluster, or virtual workspace to deploy to. target_type: Type of target - "Workspace", "Cluster", or "VirtualWorkspace". database_name: Optional database name to attach to the function. description: Optional description of the cloud function. idle_timeout_seconds: Optional idle timeout in seconds before scaling down.

Create a scheduled job to run a notebook (uploaded to shared space). Args: ctx: Context object name: Name of the job notebook_path: Remote path to the shared notebook file mode: Job mode (options: "Once", "Recurring") execution_interval_in_minutes: Optional interval in minutes for recurring jobs Returns: Dict with job creation result

Create a Jupyter notebook file in the correct singlestore format and saves it to a temporary location. This tool validates the provided content against the Jupyter notebook schema and creates a properly formatted .ipynb file in a temporary location. The content is converted from the simplified format to the full Jupyter notebook format. Each code cell MUST include a "language" field in its metadata for SingleStore to properly recognize the cell. If not provided or empty, it defaults to "python". Supported languages are "python" and "sql"; other values are rejected. Args: content: Notebook content in the format: { "cells": [ {"type": "markdown", "content": "Markdown content here"}, {"type": "code", "content": "Python code here", "language": "python"}, {"type": "code", "content": "SELECT * FROM t", "language": "sql"} ] } Returns: Dictionary with the temporary file path and validation status Example: content = { "cells": [ {"type": "markdown", "content": "# My Notebook This is a sample notebook"}, {"type": "code", "content": "import pandas as pd print('Hello World')", "language": "python"}, {"type": "code", "content": "SELECT 1", "language": "sql"} ] }

Create a new starter workspace using the SingleStore SDK. This tool provides a modern SDK-based approach to creating starter workspaces, offering improved reliability and better error handling compared to direct API calls. Args: name: Unique name for the new starter workspace database_name: Name of the database to create in the starter workspace provider: Cloud provider for the workspace (e.g., "AWS", "GCP", "Azure") region_name: Region where the workspace should be deployed (e.g., "us-west-2", "europe-west1") Returns: Dictionary with starter workspace creation details including: - workspace_id: Unique identifier for the created workspace - name: Display name of the workspace - endpoint: Connection endpoint URL - database_name: Name of the primary database Example Usage: ```python result = create_starter_workspace( ctx=ctx, name="my-test-workspace", database_name="analytics_db" ) workspace_id = result["workspace_id"] endpoint = result["endpoint"] ```

Delete a cloud function by its ID. Args: cloud_function_id: The unique identifier (UUID) of the cloud function to delete.

Delete a scheduled job by its ID. Args: ctx: Context object job_id: ID of the job to delete Returns: Dict with deletion result

Get detailed information about a specific cloud function including its status, endpoint, and configuration. Args: cloud_function_id: The unique identifier (UUID) of the cloud function.

Get an authentication token for invoking a cloud function. Returns a JWT token and its expiration time. Use this token in the Authorization header when making HTTP requests to the cloud function's endpoint. Args: cloud_function_id: The unique identifier (UUID) of the cloud function.

Retrieve details of a scheduled job by its ID. Args: ctx: Context object job_id: ID of the job to retrieve Returns: Dict with job details or error info

Retrieve all information about the current user. Returns: dict: User information including userID, email, firstName, lastName. Performance Tip: Cache the returned info when making multiple API calls.

List all cloud functions in the current organization. Returns name, status, endpoint, and description for each cloud function. Args: limit: Optional maximum number of cloud functions to return. offset_id: ID of the last cloud function from the previous page, used to continue pagination. Pass the serviceID of the last item returned when fetching the next page.

List all available deployment regions where SingleStore workspaces can be deployed by the user. Returns region information including: - regionID: Unique identifier for the region - provider: Cloud provider (AWS, GCP, or Azure) - name: Human-readable region name (e.g., Europe West 2 (London), US West 2 (Oregon)) Use this tool to: 1. Select optimal deployment regions based on: - Geographic proximity to users - Compliance requirements - Cost considerations - Available cloud providers 2. Plan multi-region deployments

List all regions where shared tier workspaces can be created. This tool provides information about available regions for creating starter workspaces, including region names and cloud providers. Args: ctx: Context for user interaction and logging Returns: Dictionary with region information including: - regionName: Name of the region (e.g., "us-west-2", "europe-west1") - provider: Cloud provider (AWS, GCP, or Azure) - name: Human-readable region name (e.g., Europe West 2 (London), US West 2 (Oregon)) Example Usage: ```python result = await list_shared_tier_regions(ctx) regions = result["data"]["result"] ```

List all starter (virtual) workspaces available to the user in SingleStore. Returns detailed information about each starter workspace: - virtualWorkspaceID: Unique identifier for the workspace - name: Display name of the workspace - endpoint: Connection endpoint URL - databaseName: Name of the primary database - mysqlDmlPort: Port for MySQL protocol connections - webSocketPort: Port for WebSocket connections - state: Current status of the workspace Use this tool to: 1. Get starter workspace IDs for other operations 2. Check starter workspace availability and status 3. Obtain connection details for database access

Retrieve information about the current user's organization in SingleStore. Returns organization details including: - orgID: Unique identifier for the organization - name: Organization display name

Resume a workspace within a specified workspace group in SingleStore. Args: workspace_group_id: Unique identifier of the workspace group workspace_id: Unique identifier of the workspace to resume Returns: Dictionary with status, message, and metadata about the resume operation

Use this tool to execute a single SQL statement against a SingleStore database. Generally you should *NOT* specify the username and password when calling this tool. You must only use those parameters if a previous attempt to call this method failed and indicated that the `username` and `password` must be specified. Credentials for a specific workspace and database combination will be cached. Returns: - Query results with column names and typed values - Row count and metadata - Execution status - Workspace type ("shared" for starter workspaces, "dedicated" for regular workspaces) - Workspace name Args: id: Workspace or starter workspace ID sql_query: The SQL query to execute database: (optional) Database name to use Returns: Standardized response with query results and metadata

Create a folder in Stage. Args: deployment_id: The workspace group ID or starter workspace ID. path: Folder path to create. Returns: Dictionary with creation status.

Delete a file or folder from Stage. For folders, ensure the path ends with '/'. For files, the path must not end with '/'. Args: deployment_id: The workspace group ID or starter workspace ID. path: Path of the file or folder to delete. Returns: Dictionary with deletion status.

Get a file from Stage by path. Returns metadata, a download URL, or text content. Recommended workflow: first call with return_type='metadata' to check file size and type, then decide whether to fetch the full content or just the URL. Args: deployment_id: The workspace group ID or starter workspace ID. path: Path to the file in Stage. return_type: What to return. One of: - 'metadata': File metadata as JSON (default). - 'url': A pre-signed download URL (does not download the file). - 'content': The file's text content (follows redirect and reads body). Returns: Dictionary with file metadata, download URL, or text content.

List files and folders in a Stage deployment's file system. Lists the contents of the root folder or a specific subfolder in the Stage file system attached to a SingleStore deployment (workspace group or starter workspace). Args: deployment_id: The workspace group ID or starter workspace ID. path: Optional folder path to list. Defaults to root. Must refer to a folder. Returns: Dictionary with folder contents including files and subfolders.

Move or rename a file or folder in Stage. For folders, ensure the path ends with '/'. For files, the path must not end with '/'. Works like the `mv` command - can rename and/or move into a different folder. Args: deployment_id: The workspace group ID or starter workspace ID. source_path: Current path of the file or folder. destination_path: New path for the file or folder. Returns: Dictionary with move status.

Upload a file to Stage from text content or a local file path. Provide exactly one of `content` or `local_path`: - content: Text content to upload as the file body. - local_path: Absolute path to a local file to upload. Args: deployment_id: The workspace group ID or starter workspace ID. path: Destination file path in Stage. content: Text content to upload as the file body. local_path: Absolute path to a local file to upload. Returns: Dictionary with upload status.

Permanently delete a starter workspace in SingleStore with safety confirmations. ⚠️ WARNING: This action CANNOT be undone. All workspace data will be permanently lost. Make sure to backup important data before proceeding. Safety Features: - Requires explicit user confirmation (if elicitation is supported) - Validates workspace existence - Provides warning messages - Includes error handling Args: ctx: Context for user interaction and logging workspace_id: Workspace identifier (format: "ws-" followed by alphanumeric chars) Returns: { "status": "success" | "error" | "cancelled", "message": str, # Human-readable result "workspace_id": str, "workspace_name": str, # If available "termination_time": str, # ISO 8601 (if successful) "error": str # If status="error" } Example: ```python result = await terminate_starter_workspace(ctx, "ws-abc123") if result["status"] == "success": print(f"Workspace {result['workspace_name']} terminated") ``` Related: - list_starter_workspaces() - create_starter_workspace()

Update a cloud function's configuration. Only provided fields are updated. Args: cloud_function_id: The unique identifier (UUID) of the cloud function. name: New name for the cloud function. notebook_path: New notebook path in Stage. target_id: New target workspace/cluster/virtual workspace ID. target_type: New target type - "Workspace", "Cluster", or "VirtualWorkspace". database_name: New database name to attach. description: New description. idle_timeout_seconds: New idle timeout in seconds. update_notebook_snapshot: Whether to update the notebook snapshot after updating.

Upload a notebook file from a local local_path to SingleStore shared or personal space. This tool validates the notebook schema before uploading. If upload_name or upload_location are not provided, the user will be prompted through elicitation. Args: local_path: Local file system path to the notebook file (.ipynb) upload_name: Optional. Name of the file after upload (with or without .ipynb extension). If not provided, user will be prompted. upload_location: Optional. Either "shared" or "personal". If not provided, user will be prompted. Returns: Dictionary with upload status and file information Example: local_path = "/path/to/my_notebook.ipynb" upload_name = "analysis_notebook" # Optional upload_location = "shared" # Optional

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

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