Why Use MCP?

MCP enables you to:

• Define context programmatically which enables the model to accurately interpret your goals and available tools.

• Eliminate the need for writing custom prompts for each integration scenario.

• Expose your system’s capabilities and usage conditions for scalable and collaborative AI agent design.

Prerequisites

Ensure the following tools are installed:

• Python 3.11+

• uvx

• uv

• Preferred MCP client

Supported MCP Clients

The SingleStore MCP server supports the following clients:

• Claude Desktop

• Claude Code

• Cursor

• Visual Studio Code

• Windsurf

• Gemini CLI

• LM Studio

• Goose

• Qodo Gen

Following MCP clients are available through Docker Desktop:

• Continue.dev

• Gordon

MCP Client Setup

You can set up a supported MCP client using any of the following approaches:

1. Using the initialization command: The initialization command automatically locates the appropriate configuration file for your client platform and adds or updates it to include the SingleStore MCP server. Additionally, it sets up browser-based OAuth authentication and displays instructions for starting the server.

   

   Use the following command to initiate the server:

   Shell

   Copy

   uvx singlestore-mcp-server init 

   Use the following command to specify a client:

   Shell

   Copy

   uvx singlestore-mcp-server init --client=<client>

   Replace <client> with a supported MCP client. Following are the example syntax for the supported MCP client.

   • Claude Desktop

     Shell

     Copy

     uvx singlestore-mcp-server init --client=claude-desktop

   • Claude Code

     Shell

     Copy

     uvx singlestore-mcp-server init --client=claude-code

   • Cursor

     Shell

     Copy

     uvx singlestore-mcp-server init --client=cursor

   • Visual Studio Code

     Shell

     Copy

     uvx singlestore-mcp-server init --client=vscode

   • Windsurf

     Shell

     Copy

     uvx singlestore-mcp-server init --client=windsurf

   • Gemini CLI

     Shell

     Copy

     uvx singlestore-mcp-server init --client=gemini

   • LM Studio

     Shell

     Copy

     uvx singlestore-mcp-server init --client=lm-studio

2. Installing via Smithery: Use the following command to install singlestore-mcp-server via Smithery:

   Shell

   Copy

   npx -y @smithery/cli install @singlestore-labs/mcp-server-singlestore --client=<client>

   Replace <client> with a supported MCP client.

3. Manual Configuration: You can configure the following supported MCP clients manually. Add the following standard configuration to your MCP client’s configuration file:

   Shell

   Copy

   {
     "mcpServers": {
      "singlestore-mcp-server": {
       "command": "uvx",
       "args": [
         "singlestore-mcp-server",
         "start"
       ]
      }
     }
   }

   Use the configuration file of the MCP client as mentioned in the following client's documentation:

   1. Claude Desktop: Refer to the MCP install guide for the related information.

   2. Claude Code: Run the following command to manually setup the MCP client:

      Shell

      Copy

      claude mcp add singlestore-mcp-server uvx singlestore-mcp-server start

   3. Cursor: Navigate to Cursor Settings > MCP > Add new MCP Server. Enter the name of the MCP server. Select command type, and enter the command uvx singlestore-mcp-server start. Select Edit to verify configuration or add command line arguments.

   4. Visual Studio Code: Refer to the MCP install guide for the related information. You can also install using the VS Code CLI:

      Shell

      Copy

      code --add-mcp '{"name":"singlestore-mcp-server","command":"uvx","args":["singlestore-mcp-server","start"]}'

      After installation, the SingleStore MCP server is available for use with your GitHub Copilot agent in VS Code.

   5. Windsurf: Refer to the Windsurf documentation for the related information.

   6. Gemini CLI: Refer to the MCP install guide for the related information.

   7. LM Studio: Navigate to Program in the right sidebar, then select Install > Edit mcp.json.

   8. Goose: Navigate to Advanced settings > Extensions > Add custom extension. Enter the name of your custom extension. Select type STDIO, and enter the command uvx singlestore-mcp-server start. Select Add Extension to add your custom extension.

   9. Qodo Gen: Open Qodo Gen chat panel in VSCode or IntelliJ. Select Connect more tools > + Add new MCP, and paste the standard configuration.

   Note

   This approach does not require any API keys, tokens, or environment variables. When the server starts, authentication is automatically handled via browser-based OAuth.

4. Using Docker:

   1. Run the following command to build the docker image of the SingleStore MCP server:

      Shell

      Copy

      docker build -t singlestore/mcp-server-singlestore .

   2. Use the following configuration:

      Shell

      Copy

      {
        "mcpServers": {
          "singlestore-mcp-server": {
            "command": "docker",
            "args": [
              "run", "-i", "--rm", "--init", "--pull=always",
              "-e", "MCP_API_KEY=your_api_key_here",
              "singlestore/mcp-server-singlestore"
            ]
          }
        }
      }

   3. Update the configuration of your MCP configuration file, and then restart your MCP client.

      Note

      When running the server in a Docker container, an API key is required. Browser-based OAuth is not supported for locally hosted containers. For improved security, SingleStore recommends using Docker Desktop to configure the SingleStore MCP server. Refer to The Docker MCP Catalog: the Secure way to Discover and Run MCP Servers for more information.