Supports configuration through environment variables loaded from .env files, allowing customization of connection settings, security parameters, timeouts, and caching behavior.
Enables deployment of the MCP server using Docker containers, with configuration via environment variables and docker-compose for simplified setup and management.
Provides access to the repository for cloning and installation, with documentation and setup instructions accessible through GitHub.
Это сервер Model Context Protocol (MCP) для взаимодействия с SQL Server. Он позволяет моделям больших языков (LLM) выполнять запросы SQL, запускать хранимые процедуры и исследовать схемы баз данных с повышенной безопасностью и надежностью.
SELECT в базах данных SQL Server. Все запросы анализируются и проверяются, чтобы гарантировать выполнение только операторов SELECT .SELECT .SQL_ALLOWED_DATABASES для внесения в белый список доступных баз данных.pino для подробных и структурированных журналов приложений.Полные инструкции по настройке Docker см. в файле README Docker .
Сервер настроен с использованием переменных окружения. Создайте файл .env в корневом каталоге (можно скопировать .env.example ), чтобы задать эти значения.
Подробное руководство по всем параметрам конфигурации и их настройке см. в разделе CONFIG .
| Категория | Переменная | Описание | По умолчанию (из config.js) |
|---|---|---|---|
| Связь | SQL_SERVER | Имя хоста или IP-адрес SQL-сервера | localhost |
SQL_PORT | Порт SQL-сервера | 1433 | |
SQL_USER | Имя пользователя SQL-сервера | sa | |
SQL_PASSWORD | Пароль SQL-сервера | Необходимый | |
SQL_DATABASE | Имя базы данных по умолчанию для подключения | master | |
| Безопасность | SQL_ENCRYPT | Включить шифрование (установите значение false , чтобы отключить) | true |
SQL_TRUST_SERVER_CERT | Сертификат сервера доверия (установите значение false , чтобы отключить) | true | |
SQL_ALLOWED_DATABASES | Список баз данных, разделенных запятыми, к которым серверу разрешен доступ. Если пусто, доступ менее ограничен (зависит от разрешений пользователя БД). | [] (пустой список) | |
| Тайм-ауты и повторные попытки | SQL_CONNECTION_TIMEOUT | Время ожидания соединения (мс) | 30000 |
SQL_REQUEST_TIMEOUT | Время ожидания запроса (мс) | 30000 | |
SQL_MAX_RETRIES | Максимальное количество повторных попыток первоначального подключения | 3 | |
SQL_INITIAL_RETRY_DELAY | Начальная задержка (мс) перед повторной попыткой неудачного соединения | 1000 | |
SQL_MAX_RETRY_DELAY | Максимальная задержка (мс) для повторных попыток подключения (использует экспоненциальную задержку) | 30000 | |
| Пул соединений | SQL_POOL_MAX | Макс. количество подключений в пуле | 10 |
SQL_POOL_MIN | Мин. подключений в пуле | 0 | |
SQL_POOL_IDLE_TIMEOUT | Время ожидания простоя для соединений в пуле (мс) | 30000 | |
| Кэширование | SQL_SCHEMA_CACHE_TTL | Время жизни кэша схемы (мс) | 300000 (5 минут) |
| MCP-сервер | MCP_SERVER_NAME | Имя MCP-сервера | MSSQL Server |
MCP_SERVER_VERSION | Версия сервера MCP | 1.0.0 | |
| Ведение журнала | LOG_LEVEL | Уровень журнала для pino logger (например, fatal , error , warn , info , debug , trace , silent ). Это считывается напрямую из process.env в server.ts , а не является частью config.js . | info |
Чтобы добавить этот MCP-сервер в Claude CLI:
В разговоре с Клодом вы можете:
SELECT :database является необязательным, если используется SQL_DATABASE по умолчанию или если SQL_ALLOWED_DATABASES подразумевает единственный выбор.)YourDatabaseName не указано, по умолчанию используется SQL_DATABASE , указанная в переменных среды.)Этот сервер MCP использует глобальный, надежный пул соединений (встроенный пул библиотеки mssql ), управляемый DatabaseService .
execute_query ) из LLM будут использовать то же самое базовое соединение с базой данных. Поэтому специфичное для сеанса состояние, такое как временные таблицы или переменные сеанса, созданные в одном вызове, могут быть недоступны в другом. Каждый вызов следует считать атомарным с точки зрения состояния сеанса. Команда USE [database] выдается в каждой операции, если целевая база данных отличается от базы данных по умолчанию пула, обеспечивая контекст для этой конкретной операции.SELECT : сервер строго следит за тем, чтобы через инструмент execute_query можно было выполнять только запросы SELECT с использованием анализа SQL. Операторы DML (INSERT, UPDATE, DELETE) и DDL блокируются.SQL_ALLOWED_DATABASES , чтобы ограничить, с какими базами данных сервер может взаимодействовать. Подробное объяснение этой функции и того, как она взаимодействует с SQL_DATABASE , см. DATABASE_WHITELISTING.md .sp_ , xp_ ) и команд типа RECONFIGURE или WAITFOR DELAY через execute_query блокируется. Для законных системных взаимодействий следует использовать хранимые процедуры.mssql , которая обычно параметризует их для предотвращения SQL-инъекций.Если у вас возникли проблемы:
docker logs mssql-mcp (если используется Docker)..env установлены правильно, особенно SQL_PASSWORD , SQL_SERVER , SQL_USER и SQL_DATABASE .SQL_ALLOWED_DATABASES .test-mcp.sh , test-session-persistence.sh ) могут нуждаться в проверке/обновлении.Подробную информацию об устранении неполадок Docker см. в файле README Docker .
This server cannot be installed
hybrid server
The server is able to function both locally and remotely, depending on the configuration or use case.
Сервер Model Context Protocol, который позволяет крупным языковым моделям, таким как Claude, выполнять SQL-запросы, исследовать схемы баз данных и поддерживать постоянные соединения с базами данных SQL Server.