SingleStore MCP Server

Model Context Protocol (MCP) — это стандартизированный протокол, предназначенный для управления контекстом между большими языковыми моделями (LLM) и внешними системами. Этот репозиторий предоставляет установщик и MCP-сервер для SingleStore, обеспечивая бесшовную интеграцию.

С помощью MCP вы можете использовать Claude Desktop, Claude Code, Cursor или любой другой совместимый MCP-клиент для взаимодействия с SingleStore на естественном языке, что упрощает выполнение сложных операций.

💡 Совет: Не знаете, что может делать MCP-сервер? Просто вызовите команду /help в своем чате!

Требования

• Python >= v3.10.0

• uvx, установленный в вашей среде Python

• VS Code, Cursor, Windsurf, Claude Desktop, Claude Code, Goose или любой другой MCP-клиент

Related MCP server: ExecuteAutomation Database Server

Начало работы

Начало работы

Сначала установите MCP-сервер SingleStore с помощью вашего клиента.

Стандартная конфигурация работает в большинстве инструментов:

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

API-ключи, токены или переменные окружения не требуются! Сервер автоматически обрабатывает аутентификацию через OAuth в браузере при запуске.

Автоматическая настройка:

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

Ручная настройка: Следуйте руководству по установке MCP, используя стандартную конфигурацию выше.

Автоматическая настройка:

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

Это автоматически выполнит команду Claude CLI за вас.

Ручная настройка:

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

Автоматическая настройка:

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

Ручная настройка: Перейдите в Cursor Settings -> MCP -> Add new MCP Server. Назовите его по своему усмотрению, выберите тип command и используйте команду uvx singlestore-mcp-server start. Вы также можете проверить конфигурацию или добавить аргументы командной строки, нажав Edit.

Автоматическая настройка:

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

Ручная настройка: Следуйте руководству по установке MCP, используя стандартную конфигурацию выше. Вы также можете выполнить установку с помощью VS Code CLI:

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

После установки MCP-сервер SingleStore будет доступен для использования с вашим агентом GitHub Copilot в VS Code.

Автоматическая настройка:

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

Ручная настройка: Следуйте документации по MCP в Windsurf. Используйте стандартную конфигурацию выше.

Автоматическая настройка:

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

Ручная настройка: Следуйте руководству по установке MCP, используя стандартную конфигурацию выше.

Автоматическая настройка:

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

Ручная настройка: Перейдите в Program на правой боковой панели -> Install -> Edit mcp.json. Используйте стандартную конфигурацию выше.

Только ручная настройка: Перейдите в Advanced settings -> Extensions -> Add custom extension. Назовите его по своему усмотрению, выберите тип STDIO и установите command как uvx singlestore-mcp-server start. Нажмите "Add Extension".

Только ручная настройка: Откройте панель чата Qodo Gen в VSCode или IntelliJ → Connect more tools → + Add new MCP → Вставьте стандартную конфигурацию выше.

Нажмите Save.

Использование Docker

ПРИМЕЧАНИЕ: При использовании Docker требуется API-ключ, так как поток OAuth не поддерживается для серверов, работающих в контейнерах Docker.

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

Вы можете собрать Docker-образ самостоятельно:

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

Для повышения безопасности мы рекомендуем использовать Docker Desktop для настройки MCP-сервера SingleStore — подробности о новом каталоге MCP в Docker см. в этой записи блога.

Компоненты

Инструменты

Сервер реализует следующие инструменты:

• get_user_info: Получение сведений о текущем пользователе

  • Аргументы не требуются

  • Возвращает информацию о пользователе и детали

• organization_info: Получение сведений о текущей организации пользователя

  • Аргументы не требуются

  • Возвращает детали организации

• choose_organization: Выбор из доступных организаций (доступно только если не установлена переменная окружения API-ключа)

  • Аргументы не требуются

  • Возвращает список доступных организаций для выбора

• set_organization: Установка активной организации (доступно только если не установлена переменная окружения API-ключа)

  • Аргументы: organization_id (строка)

  • Устанавливает указанную организацию в качестве активной

• workspace_groups_info: Получение сведений о группах рабочих областей, доступных пользователю

  • Аргументы не требуются

  • Возвращает детали групп рабочих областей

• workspaces_info: Получение сведений о рабочих областях в конкретной группе

  • Аргументы: workspace_group_id (строка)

  • Возвращает детали рабочих областей

• resume_workspace: Возобновление работы приостановленной рабочей области

  • Аргументы: workspace_id (строка)

  • Возобновляет указанную рабочую область

• list_starter_workspaces: Список всех стартовых рабочих областей, доступных пользователю

  • Аргументы не требуются

  • Возвращает детали доступных стартовых рабочих областей

• create_starter_workspace: Создание новой стартовой рабочей области

  • Аргументы: параметры конфигурации рабочей области

  • Возвращает детали созданной стартовой рабочей области

• terminate_starter_workspace: Завершение работы существующей стартовой рабочей области

  • Аргументы: workspace_id (строка)

  • Завершает работу указанной стартовой рабочей области

• list_regions: Получение списка всех регионов, поддерживающих рабочие области

  • Аргументы не требуются

  • Возвращает список доступных регионов

• list_sharedtier_regions: Получение списка регионов общего уровня (shared tier)

  • Аргументы не требуются

  • Возвращает список регионов общего уровня

• run_sql: Выполнение SQL-операций в подключенной рабочей области

  • Аргументы: workspace_id, database, sql_query и параметры подключения

  • Возвращает результаты SQL-запроса в структурированном формате

• create_notebook_file: Создание нового файла блокнота в SingleStore Spaces

  • Аргументы: notebook_name, content (необязательно)

  • Возвращает детали созданного блокнота

• upload_notebook_file: Загрузка файла блокнота в SingleStore Spaces

  • Аргументы: file_path, notebook_name

  • Возвращает детали загруженного блокнота

• create_job_from_notebook: Создание запланированного задания из блокнота

  • Аргументы: конфигурация задания, включая notebook_path, schedule_mode и т.д.

  • Возвращает детали созданного задания

• get_job: Получение сведений о существующем задании

  • Аргументы: job_id (строка)

  • Возвращает детали указанного задания

• delete_job: Удаление существующего задания

  • Аргументы: job_id (строка)

  • Удаляет указанное задание

• stage_list_files: Список файлов и папок в файловой системе развертывания Stage

  • Аргументы: deployment_id (строка), path (строка, необязательно)

  • Возвращает содержимое папки, включая файлы и подпапки

• stage_get_file: Получение файла из Stage по пути

  • Аргументы: deployment_id (строка), path (строка), return_type (строка: 'metadata', 'url' или 'content')

  • Возвращает метаданные файла, URL для скачивания или текстовое содержимое

• stage_create_folder: Создание папки в Stage

  • Аргументы: deployment_id (строка), path (строка)

  • Возвращает статус создания

• stage_upload_file: Загрузка файла в Stage с текстовым содержимым

  • Аргументы: deployment_id (строка), path (строка), content (строка), local_path (строка)

  • Возвращает статус загрузки

• stage_move: Перемещение или переименование файла или папки в Stage

  • Аргументы: deployment_id (строка), source_path (строка), destination_path (строка)

  • Возвращает статус перемещения

• stage_delete: Удаление файла или папки из Stage

  • Аргументы: deployment_id (строка), path (строка)

  • Возвращает статус удаления

Примечание: Инструменты управления организацией (choose_organization и set_organization) доступны только тогда, когда переменная окружения API-ключа не установлена, что позволяет интерактивно выбирать организацию во время аутентификации OAuth.

Разработка

Предварительные требования

• Python >= 3.11

• uv для управления зависимостями

Настройка

1. Клонируйте репозиторий:

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

1. Установите зависимости:

uv sync --dev

1. Настройте pre-commit хуки (необязательно, но рекомендуется):

uv run pre-commit install

Рабочий процесс разработки

# 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

Запуск тестов

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

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

Качество кода

Мы используем Ruff как для линтинга, так и для форматирования:

# 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/

Процесс выпуска

Выпуски управляются через git-теги и автоматическую публикацию в PyPI:

1. Создание выпуска: ./scripts/release.sh (интерактивный инструмент)

2. Автоматическая публикация: Запускается при отправке тегов версий

3. Никаких ручных загрузок в PyPI — полностью автоматизированный конвейер

Подробную документацию по рабочему процессу см. в scripts/dev-workflow.md.