Singlestore MCP Server

🚀 SingleStore Database MCP Protocol Server

This is a single-process MCP (Multi-Protocol Communications Protocol) protocol server designed for the SingleStore database. The server supports communication via the standard MCP protocol or HTTP-based Server-Sent Events (SSE).

🚀 Quick Start

📦 Installation

Install using Node.js:

npm install mcp-server-singlestore

Start the server:

node src/index.ts

⚙️ Configuration

The environment variables required at runtime include:

✨ Features

• Database Connection: Supports establishing connections to the SingleStore database via the MCP protocol or HTTP.
• Query Execution: Can execute SQL queries and return results.
• SSE Support: Provides HTTP-based streaming data transfer functionality, suitable for real-time data push scenarios.

💻 Usage Examples

Basic Usage

# Install dependencies
npm install mcp-server-singlestore

# Start the server (assuming environment variables are configured)
node src/index.ts

Configuration File Example

const config = {
  singleStoreHost: 'localhost',
  singleStorePort: 3307,
  singleStoreUser: 'admin',
  singleStorePassword: 'password',
  // Optional configuration
  sslCaBundle: '/path/to/ca.pem',
  mcpServerPort: 4000,
  sseEnabled: true,
  ssePort: 4001
};

require('mcp-server-singlestore').start(config);

Integration

Usage in Claude

function useMCPTool(commands) {
  return {
    connectDatabase(options) {
      // Implement database connection logic
    },
    executeQuery(query, params) {
      // Execute the query and return the result
    }
  };
}

export default useMCPTool;

Configuration in Windsurf

const config = {
  type: 'singlestore',
  host: 'localhost',
  port: 3307,
  user: 'admin',
  password: 'password'
};

// Initialize the database connection
const db = new Database(config);

Usage in Cursor

const { Cursor } = require('cursor');

const cursor = new Cursor({
  databaseConfig: {
    type: 'singlestore',
    host: 'localhost',
    port: 3307,
    user: 'admin',
    password: 'password'
  }
});

// Query example
cursor.query('SELECT * FROM users LIMIT 10', (err, result) => {
  if (err) throw err;
  console.log(result);
});

⚠️ Important Note

• Credential Management: Never commit credentials to the version control system.
• Network Isolation: In a production environment, it is recommended to place the database and application services inside a controlled network.
• Permission Control: Strictly limit the permissions of database connection users.

📁 Project Structure

src/
├── index.ts                 # Entry file
├── server.ts                # MCP server implementation
└── sseServer.ts             # SSE server implementation

🛠️ Development

Install Dependencies

npm install express mysql2

Start the Development Environment

npm run dev

🚧 Troubleshooting

Connection Issues

• Check if the target database is running.
• Confirm that the network connection is normal.
• Verify that the provided credentials are correct.

Query Issues

• Ensure that the query syntax is correct.
• Check if you have permission to access the relevant data tables and columns.

🤝 Contribution Guidelines

If you find any issues, please submit an Issue or Pull Request via GitHub.

📄 License

This project is licensed under the MIT License. See the LICENSE file for specific terms.