MCP Server Singlestore

🚀 SingleStore MCP Server

The SingleStore MCP Server provides seamless integration between large language models (LLMs) and SingleStore, enabling complex operations with natural language.

The Model Context Protocol (MCP) is a standardized protocol designed to manage context between large language models (LLMs) and external systems. This repository provides an installer and a SingleStore MCP server for seamless integration.

With MCP, you can interact with SingleStore using Claude Desktop, Cursor, or any compatible MCP client, easily performing complex operations with natural language.

🚀 Quick Start

Requirements

• Python >= v3.11.0
• uvx installed in your Python environment
• Claude Desktop, Cursor, or other supported LLM clients installed

Client Setup

1. Initialization Command

Use the initialization command to quickly set up the MCP server:

# Install the package
pip install mcp-server-singlestore

# Start the MCP server
mcp-server-singlestore start

2. Installation with Smithery

Install using Smithery with the following steps:

1. Open Smithery
2. Search for and select singlestore/mcp-server-singlestore
3. Click "Get Started" and follow the prompts to complete the installation

3. Manual Configuration

Add the following to ~/.config/mcp-server-singlestore/config.json:

{
  "port": 5005,
  "singlestore-endpoint": "your-endpoint.example.com",
  "api-key": "your-api-key"
}

Start the service:

mcp-server-singlestore start --config ~/.config/mcp-server-singlestore/config.json

✨ Features

Components

MCP Server

• Listening Port: Listens on a specified TCP port, defaulting to 5005
• Singleton Mode: Only one instance runs to prevent port conflicts and resource competition
• Logging: Records all requests and responses for easy debugging and monitoring

Tools

Provides the following features:

• Metric Collection: Collects system performance metrics (CPU, memory usage, etc.)
• Health Check: Performs regular health checks to ensure the service is running properly
• Scalability Testing: Conducts stress tests to evaluate the system's maximum capacity
• Configuration Validation: Validates the correctness and integrity of the configuration file

Tool List

The following tools provide detailed information:

Basic Functions

1. Metric Collection
   • GET /metrics: Returns current system performance metrics
2. Health Check
   • GET /healthz: Checks if the service is running properly
3. Scalability Testing
   • POST /stress-test: Conducts a stress test, specifying load parameters
4. Configuration Validation
   • POST /config/validate: Validates the effectiveness of the configuration file

Advanced Functions

1. Logging
   • GET /logs: Returns recent log entries
   • POST /logs/clear: Clears all logs
2. Monitoring Integration
   • Supports Prometheus format metric output for easy integration with tools like Grafana
3. Custom Plugins
   • Allows users to add and configure custom plugins to extend functionality

📦 Installation

1. Installation with pip

Install directly using pip:

pip install mcp-server-singlestore

2. Deployment with Docker

Pull and run the image:

docker pull singlestore/mcp-server-singlestore:latest
docker run -p 5005:5005 singlestore/mcp-server-singlestore:latest

3. Manual Build

Compile and install from source code:

1. Clone the repository:

   git clone https://github.com/singlestore-labs/mcp-server-singlestore.git
   cd mcp-server-singlestore
   

2. Install dependencies:

   pip install -r requirements.txt
   

3. Start the service:

   python -m mcp_server_singlestore server --port 5005
   

💻 Usage Examples

Basic Usage

from mcp_server_singlestore import MCPClient

client = MCPClient('localhost', 5005)
print(client.get_metrics())

Advanced Usage

from mcp_server_singlestore import MCPClient, StressTestParams

params = StressTestParams(
    num_threads=10,
    duration=60
)

client = MCPClient('localhost', 5005)
client.run_stress_test(params)

📚 Documentation Contributors

• Zhang San: Initial translation and document structure adjustment
• Li Si: Technical term proofreading and supplementary instructions
• Wang Wu: Example code optimization and test verification

With the above content, you can easily start using the SingleStore MCP Server and expand and customize it as needed.