singlestore

This MCP server provides a set of tools to interact with a SingleStore database via the MCP protocol and, optionally, via Server-Sent Events (SSE). Core functionality includes listing tables, executing custom SQL, describing tables and schemas, generating Mermaid ER diagrams of the database, and creating synthetic data. It also offers advanced capabilities like running read-only queries safely and optimizing SQL with performance insights. You can access these tools through standard MCP calls or, if you enable SSE, through HTTP endpoints for real-time streaming. The usage is designed to be compatible with Claude Desktop, Windsurf, Cursor, and web clients that support MCP or SSE.

Available tools include: list_tables to enumerate all tables; query_table for arbitrary SQL; describe_table to fetch schema, types, and sample data; generate_er_diagram to produce a Mermaid ER diagram; run_read_query for safe read-only queries; create_table to define new tables with columns and constraints; generate_synthetic_data to populate tables with generated rows; and optimize_sql to analyze and optimize queries with a detailed report. When SSE is enabled, you can also interact with these tools via HTTP/SSE endpoints, making it convenient for web apps and live dashboards.

To run with MCP only, start the server and connect using the MCP protocol. To enable real-time capabilities, start with SSE enabled so clients can subscribe to updates and access endpoints like /tools and /sse while using the same underlying toolset.

Prerequisites:

• Node.js 16 or higher
• npm (or yarn)
• Access to a running SingleStore deployment and CA bundle handling as described

Installation steps:

# 1) Install the MCP package via Smithery (optional, for automatic client integration)
# Example (from the README):
# npx -y @smithery/cli install @madhukarkumar/singlestore-mcp-server --client claude

# 2) Clone the repository (if you are adding this server locally)
# git clone <repository-url>
# cd mcp-server-singlestore

# 3) Install dependencies
npm install

# 4) Build the server
npm run build

# 5) Run the server (MCP protocol only by default)
node build/index.js

# 6) Run with SSE enabled (optional)
SSE_ENABLED=true SSE_PORT=3333 node build/index.js

Environment setup (as needed):

• Create and export the required SingleStore connection variables before starting the server, for example:
  • export SINGLESTORE_HOST=your-host.singlestore.com
  • export SINGLESTORE_PORT=3306
  • export SINGLESTORE_USER=your-username
  • export SINGLESTORE_PASSWORD=your-password
  • export SINGLESTORE_DATABASE=your-database
• If you plan to use SSE, export SSE_ENABLED and optionally SSE_PORT.

Once installed and configured, you can use the MCP tools by issuing the appropriate tool calls through your MCP client or via the SSE HTTP endpoints when enabled.

Tips and considerations:

• Ensure all SINGLESTORE_* environment variables are set correctly before starting the server; the SSL/TLS stack will fetch the CA bundle automatically from the portal.
• Enabling SSE opens HTTP endpoints for status, tools, and a live SSE stream; this is useful for web apps and dashboards that need real-time updates.
• If you encounter connection issues, verify network access to the SingleStore host and ensure the port (default 3306) is reachable from the server environment.
• For authentication failures, double-check that the user has the necessary privileges on the target database and that SSL requirements are satisfied by the client/driver.
• When generating ER diagrams or large schemas, be mindful of the potential size of the diagram; consider filtering or focusing on specific schemas during development.
• The toolset includes both MCP and SSE access patterns; pick the one that best fits your integration (CLI-like MCP calls vs. HTTP streaming).
• If you customize or extend the server, maintain consistent environment variable handling and document any new configuration keys for clients.