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....
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....
Retrieve information about the current user's organization in SingleStore. Returns organization details including: - orgID: Unique identifier for the organization - name: Organization display name
List all available deployment regions where SingleStore workspaces can be deployed for 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....
Execute SQL operations on a database attached to workspace within a workspace group and receive formatted results. Returns: - Query results with column names and typed values - Row count and metadata - Execution status ⚠️ CRITICAL SECURITY WARNINGS: - Never display or log credentials in responses - Use only READ-ONLY queries (SELECT, SHOW, DESCRIBE) - DO NOT USE data modification statements: × No INSERT/UPDATE/DELETE × No DROP/CREATE/ALTER - Ensure queries are properly sanitized Required parameters: - workspace_group_identifier: ID/name of the workspace group - workspace_identifier: ID/name of the specific workspace within the workspace group - database: Name of the database to query - sql_query: The SQL query to execute Optional parameters: - username: Username for database access (defaults to SINGLESTORE_DB_USERNAME) - password: Password for database access (defaults to SINGLESTORE_DB_PASSWORD) Allowed query examples: - SELECT * FROM table_name - SELECT COUNT(*) FROM table_name - SHOW TABLES - DESCRIBE table_name Note: For data modifications, please use appropriate admin tools or APIs.
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 virtual workspace IDs for other operations 2....
Create a new starter (virtual) workspace in SingleStore and set up user access. Process: 1. Creates a virtual workspace with specified name and database 2. Creates a user account for accessing the workspace 3. Returns both workspace details and access credentials Required parameters: - name: Unique name for the starter workspace - database_name: Name for the database to create - username: Username for accessing the starter workspace - password: Password for accessing the starter workspace Usage notes: - Workspace names must be unique - Passwords should meet security requirements - Use execute_sql_on_virtual_workspace to interact with the created starter workspace
Execute SQL operations on a virtual (starter) workspace and receive formatted results. Returns: - Query results with column names and typed values - Row count - Column metadata - Execution status ⚠️ CRITICAL SECURITY WARNING: - Never display or log credentials in responses - Ensure SQL queries are properly sanitized - ONLY USE SELECT statements or queries that don't modify data - DO NOT USE INSERT, UPDATE, DELETE, DROP, CREATE, or ALTER statements Required input parameters: - virtual_workspace_id: Unique identifier of the starter workspace - sql_query: The SQL query to execute (READ-ONLY queries only) Optional input parameters: - username: For accessing the starter workspace (defaults to SINGLESTORE_DB_USERNAME) - password: For accessing the starter workspace (defaults to SINGLESTORE_DB_PASSWORD) Allowed query examples: - SELECT * FROM table_name - SELECT COUNT(*) FROM table_name - SHOW TABLES - DESCRIBE table_name Note: This tool is specifically designed for read-only operations on starter workspaces.
Retrieve detailed billing and usage metrics for your organization over a specified time period. Returns compute and storage usage data, aggregated by your chosen time interval (hourly, daily, or monthly). This tool is essential for: 1....
Retrieve a catalog of pre-built notebook templates available in SingleStore Spaces. Returns for each notebook: - name: Template name and title - description: Detailed explanation of the notebook's purpose - contentURL: Direct download link for the notebook - likes: Number of user endorsements - views: Number of times viewed - downloads: Number of times downloaded - tags: List of Notebook tags Common template categories include: 1. Getting Started guides 2....
Create a new Jupyter notebook in your personal space. Only supports python and markdown. Do not try to use any other languange Parameters: - notebook_name (required): Name for the new notebook - Can include or omit ....
List all files and notebooks in your personal SingleStore space. Returns file object meta data for each file: - name: Name of the file (e.g....
Create an automated job to execute a SingleStore notebook on a schedule. Parameters: 1. Required Parameters: - name: Name of the job (unique identifier within organization) - notebook_path: Complete path to the notebook - schedule_mode: 'Once' for single execution or 'Recurring' for repeated runs 2....
Retrieve comprehensive information about a scheduled notebook job. Parameter required: job_id: UUID of the scheduled job to retrieve details for Returns: - jobID: Unique identifier (UUID format) - name: Display name of the job - description: Human-readable job description - createdAt: Creation timestamp (ISO 8601) - terminatedAt: End timestamp if completed - completedExecutionsCount: Number of successful runs - enqueuedBy: User ID who created the job - executionConfig: Notebook path and runtime settings - schedule: Mode, interval, and start time - targetConfig: Database and workspace settings - jobMetadata: Execution statistics and status Related Operations: - create_scheduled_job: Create new jobs - list_job_executions: View run history
Retrieve execution history and performance metrics for a scheduled notebook job. Parameters: - job_id: UUID of the scheduled job - start: First execution number to retrieve (default: 1) - end: Last execution number to retrieve (default: 10) Returns: - executions: Array of execution records containing: - executionID: Unique identifier for the execution - executionNumber: Sequential number of the run - jobID: Parent job identifier - status: Current state (Scheduled, Running, Completed, Failed) - startedAt: Execution start time (ISO 8601) - finishedAt: Execution end time (ISO 8601) - scheduledStartTime: Planned start time - snapshotNotebookPath: Backup notebook path if enabled Use this tool to: 1. Monitor each job execution status 2. Track execution times and performance 3. Investigate failed runs Related Operations: - get_job_details: View job configuration - create_scheduled_job: Create new jobs
Find the complete path of a notebook by its name and generate the properly formatted path for API operations. Parameters: - notebook_name: Name of the notebook to locate (with or without .ipynb extension) - location: Where to search ('personal' or 'shared', defaults to 'personal') Returns the properly formatted path including project ID and user ID where needed. Required for: - Creating scheduled jobs (use returned path as notebook_path parameter)
Retrieve the organization's unique identifier (project ID). Returns: - orgID (string): The organization's unique identifier Required for: - Constructing paths or references to shared resources Performance Tip: Cache the returned ID when making multiple API calls.
Retrieve the current user's unique identifier. Returns: - userID (string): UUID format identifier for the current user Required for: - Constructing paths or references to personal resources 1. Constructing personal space paths Performance Tip: Cache the returned ID when making multiple making multiple API calls.
SingleStore's API key required for authentication
