SingleStore MCP-Server

👁 MIT Licence
👁 PyPI
👁 Downloads

Das Model Context Protocol (MCP) ist ein standardisiertes Protokoll, das entwickelt wurde, um den Kontext zwischen großen Sprachmodellen (LLMs) und externen Systemen zu verwalten. Dieses Repository stellt einen Installer und einen MCP-Server für SingleStore bereit, um eine nahtlose Integration zu ermöglichen.

Mit MCP können Sie Claude Desktop, Claude Code, Cursor oder jeden anderen kompatiblen MCP-Client verwenden, um mit SingleStore in natürlicher Sprache zu interagieren, was die Durchführung komplexer Vorgänge mühelos erleichtert.

💡 Profi-Tipp: Sie sind sich nicht sicher, was der MCP-Server tun kann? Rufen Sie einfach den /help-Befehl in Ihrem Chat auf!

Anforderungen

• Python >= v3.10.0

• uvx in Ihrer Python-Umgebung installiert

• VS Code, Cursor, Windsurf, Claude Desktop, Claude Code, Goose oder ein anderer MCP-Client

Related MCP server: ExecuteAutomation Database Server

Erste Schritte

Erste Schritte

Installieren Sie zunächst den SingleStore MCP-Server mit Ihrem Client.

Die Standardkonfiguration funktioniert in den meisten Tools:

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

Keine API-Schlüssel, Token oder Umgebungsvariablen erforderlich! Der Server übernimmt die Authentifizierung beim Start automatisch über OAuth im Browser.

Automatische Einrichtung:

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

Manuelle Einrichtung: Folgen Sie der MCP-Installationsanleitung und verwenden Sie die oben genannte Standardkonfiguration.

Automatische Einrichtung:

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

Dies führt den Claude CLI-Befehl automatisch für Sie aus.

Manuelle Einrichtung:

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

Automatische Einrichtung:

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

Manuelle Einrichtung: Gehen Sie zu Cursor Settings -> MCP -> Add new MCP Server. Vergeben Sie einen Namen Ihrer Wahl und verwenden Sie den Typ command mit dem Befehl uvx singlestore-mcp-server start. Sie können die Konfiguration auch überprüfen oder Befehlszeilenargumente hinzufügen, indem Sie auf Edit klicken.

Automatische Einrichtung:

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

Manuelle Einrichtung: Folgen Sie der MCP-Installationsanleitung und verwenden Sie die oben genannte Standardkonfiguration. Sie können die Installation auch über die VS Code CLI vornehmen:

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

Nach der Installation steht der SingleStore MCP-Server für die Verwendung mit Ihrem GitHub Copilot-Agenten in VS Code zur Verfügung.

Automatische Einrichtung:

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

Manuelle Einrichtung: Folgen Sie der Windsurf MCP-Dokumentation. Verwenden Sie die oben genannte Standardkonfiguration.

Automatische Einrichtung:

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

Manuelle Einrichtung: Folgen Sie der MCP-Installationsanleitung und verwenden Sie die oben genannte Standardkonfiguration.

Automatische Einrichtung:

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

Manuelle Einrichtung: Gehen Sie in der rechten Seitenleiste zu Program -> Install -> Edit mcp.json. Verwenden Sie die oben genannte Standardkonfiguration.

Nur manuelle Einrichtung: Gehen Sie zu Advanced settings -> Extensions -> Add custom extension. Vergeben Sie einen Namen Ihrer Wahl, verwenden Sie den Typ STDIO und setzen Sie den command auf uvx singlestore-mcp-server start. Klicken Sie auf "Add Extension".

Nur manuelle Einrichtung: Öffnen Sie das Qodo Gen Chat-Panel in VSCode oder IntelliJ → Connect more tools → + Add new MCP → Fügen Sie die oben genannte Standardkonfiguration ein.

Klicken Sie auf Save.

Verwendung von Docker

HINWEIS: Bei der Verwendung von Docker ist ein API-Schlüssel erforderlich, da der OAuth-Flow für Server, die in Docker-Containern ausgeführt werden, nicht unterstützt wird.

{
 "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"
 ]
 }
 }
}

Sie können das Docker-Image selbst erstellen:

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

Für eine bessere Sicherheit empfehlen wir die Verwendung von Docker Desktop zur Konfiguration des SingleStore MCP-Servers – weitere Informationen finden Sie in diesem Blogbeitrag zum neuen MCP-Katalog von Docker.

Komponenten

Tools

Der Server implementiert die folgenden Tools:

• get_user_info: Details über den aktuellen Benutzer abrufen

  • Keine Argumente erforderlich

  • Gibt Benutzerinformationen und Details zurück

• organization_info: Details über die aktuelle Organisation des Benutzers abrufen

  • Keine Argumente erforderlich

  • Gibt Details der Organisation zurück

• choose_organization: Aus verfügbaren Organisationen wählen (nur verfügbar, wenn die Umgebungsvariable für den API-Schlüssel nicht gesetzt ist)

  • Keine Argumente erforderlich

  • Gibt eine Liste der verfügbaren Organisationen zur Auswahl zurück

• set_organization: Die aktive Organisation festlegen (nur verfügbar, wenn die Umgebungsvariable für den API-Schlüssel nicht gesetzt ist)

  • Argumente: organization_id (Zeichenfolge)

  • Legt die angegebene Organisation als aktiv fest

• workspace_groups_info: Details über die für den Benutzer zugänglichen Arbeitsbereichsgruppen abrufen

  • Keine Argumente erforderlich

  • Gibt Details der Arbeitsbereichsgruppen zurück

• workspaces_info: Details über die Arbeitsbereiche in einer bestimmten Arbeitsbereichsgruppe abrufen

  • Argumente: workspace_group_id (Zeichenfolge)

  • Gibt Details der Arbeitsbereiche zurück

• resume_workspace: Einen angehaltenen Arbeitsbereich fortsetzen

  • Argumente: workspace_id (Zeichenfolge)

  • Setzt den angegebenen Arbeitsbereich fort

• list_starter_workspaces: Alle für den Benutzer zugänglichen Starter-Arbeitsbereiche auflisten

  • Keine Argumente erforderlich

  • Gibt Details der verfügbaren Starter-Arbeitsbereiche zurück

• create_starter_workspace: Einen neuen Starter-Arbeitsbereich erstellen

  • Argumente: Konfigurationsparameter für den Arbeitsbereich

  • Gibt Details des erstellten Starter-Arbeitsbereichs zurück

• terminate_starter_workspace: Einen bestehenden Starter-Arbeitsbereich beenden

  • Argumente: workspace_id (Zeichenfolge)

  • Beendet den angegebenen Starter-Arbeitsbereich

• list_regions: Eine Liste aller Regionen abrufen, die Arbeitsbereiche unterstützen

  • Keine Argumente erforderlich

  • Gibt eine Liste der verfügbaren Regionen zurück

• list_sharedtier_regions: Eine Liste der Shared-Tier-Regionen abrufen

  • Keine Argumente erforderlich

  • Gibt eine Liste der Shared-Tier-Regionen zurück

• run_sql: SQL-Operationen auf einem verbundenen Arbeitsbereich ausführen

  • Argumente: workspace_id, database, sql_query und Verbindungsparameter

  • Gibt die Ergebnisse der SQL-Abfrage in einem strukturierten Format zurück

• create_notebook_file: Eine neue Notebook-Datei in SingleStore Spaces erstellen

  • Argumente: notebook_name, content (optional)

  • Gibt Details des erstellten Notebooks zurück

• upload_notebook_file: Eine Notebook-Datei in SingleStore Spaces hochladen

  • Argumente: file_path, notebook_name

  • Gibt Details des hochgeladenen Notebooks zurück

• create_job_from_notebook: Einen geplanten Job aus einem Notebook erstellen

  • Argumente: Job-Konfiguration einschließlich notebook_path, schedule_mode usw.

  • Gibt Details des erstellten Jobs zurück

• get_job: Details eines bestehenden Jobs abrufen

  • Argumente: job_id (Zeichenfolge)

  • Gibt Details des angegebenen Jobs zurück

• delete_job: Einen bestehenden Job löschen

  • Argumente: job_id (Zeichenfolge)

  • Löscht den angegebenen Job

• stage_list_files: Dateien und Ordner im Dateisystem einer Stage-Bereitstellung auflisten

  • Argumente: deployment_id (Zeichenfolge), path (Zeichenfolge, optional)

  • Gibt Ordnerinhalte einschließlich Dateien und Unterordnern zurück

• stage_get_file: Eine Datei aus Stage über den Pfad abrufen

  • Argumente: deployment_id (Zeichenfolge), path (Zeichenfolge), return_type (Zeichenfolge: 'metadata', 'url' oder 'content')

  • Gibt Dateimetadaten, eine Download-URL oder Textinhalt zurück

• stage_create_folder: Einen Ordner in Stage erstellen

  • Argumente: deployment_id (Zeichenfolge), path (Zeichenfolge)

  • Gibt den Erstellungsstatus zurück

• stage_upload_file: Eine Datei mit Textinhalt in Stage hochladen

  • Argumente: deployment_id (Zeichenfolge), path (Zeichenfolge), content (Zeichenfolge), local_path (Zeichenfolge)

  • Gibt den Upload-Status zurück

• stage_move: Eine Datei oder einen Ordner in Stage verschieben oder umbenennen

  • Argumente: deployment_id (Zeichenfolge), source_path (Zeichenfolge), destination_path (Zeichenfolge)

  • Gibt den Verschiebungsstatus zurück

• stage_delete: Eine Datei oder einen Ordner aus Stage löschen

  • Argumente: deployment_id (Zeichenfolge), path (Zeichenfolge)

  • Gibt den Löschstatus zurück

Hinweis: Tools zur Organisationsverwaltung (choose_organization und set_organization) sind nur verfügbar, wenn die Umgebungsvariable für den API-Schlüssel nicht gesetzt ist, was eine interaktive Auswahl der Organisation während der OAuth-Authentifizierung ermöglicht.

Entwicklung

Voraussetzungen

• Python >= 3.11

• uv für das Abhängigkeitsmanagement

Einrichtung

1. Repository klonen:

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

1. Abhängigkeiten installieren:

uv sync --dev

1. Pre-commit-Hooks einrichten (optional, aber empfohlen):

uv run pre-commit install

Entwicklungs-Workflow

# Quick quality checks (fast feedback)
./scripts/check.sh

# Run tests independently
./scripts/test.sh

# Comprehensive validation (before PRs)
./scripts/check-all.sh

# Create and publish releases
./scripts/release.sh

Tests ausführen

# Run test suite with coverage
./scripts/test.sh

# Or use pytest directly
uv run pytest
uv run pytest --cov=src --cov-report=html

Code-Qualität

Wir verwenden Ruff sowohl für das Linting als auch für die Formatierung:

# Format code
uv run ruff format src/ tests/

# Lint code
uv run ruff check src/ tests/

# Lint and fix issues automatically
uv run ruff check --fix src/ tests/

Release-Prozess

Releases werden über Git-Tags und automatisierte PyPI-Veröffentlichung verwaltet:

1. Release erstellen: ./scripts/release.sh (interaktives Tool)

2. Automatische Veröffentlichung: Wird durch das Pushen von Versions-Tags ausgelöst

3. Keine manuellen PyPI-Uploads - vollständig automatisierte Pipeline

Siehe scripts/dev-workflow.md für eine detaillierte Dokumentation des Workflows.

Maintenance

Resources

• GitHub Repository
Need Help?
• Reddit Discussion
Related Servers

Tools

• check_if_file_existsA
• create_notebookA
• create_scheduled_jobA
• create_virtual_workspaceA
• execute_sqlA
• execute_sql_on_virtual_workspaceA
• get_job_detailsA
• get_notebook_pathA