使用说明
mssql-mcp服务器
简单的MCP服务器,带有对MSSQL数据库执行查询的工具。
需求
- Python 3.11+
- pymssql 和
python-dotenv(通过安装requirements.txt) - 对Microsoft SQL Server实例的网络访问
设置
- (可选但推荐)创建并激活虚拟环境。例子:
python -m venv .venv source .venv/bin/activate # Windows: .venv\Scripts\activate - 安装依赖项:
pip install -r requirements.txt - 复制
.env.example到.env并填写您的环境值(见下文)。
配置
服务器从环境变量或 .env 文件位于旁边 mssql_mcp_server.py.
| 变量 | 必填 | 描述 |
|---|---|---|
MSSQL_SERVER |
✅ | 主机名或 host,port SQL Server实例的 |
MSSQL_DB |
❌ | 数据库名称;默认为 master 当省略时 |
MSSQL_USER |
✅ | SQL Server登录 |
MSSQL_PASSWORD |
✅ | 登录密码 |
为了方便起见,从 .env.example:
cp .env.example .env
然后编辑 .env 在运行服务器之前,请使用正确的值。
运行服务器
使用以下命令启动FastMCP服务器:
python mssql_mcp_server.py
MCP服务器公开了两个工具:
run_query(sql: str)执行任何SQL语句并返回行或受影响的行数。describe_table(schema: str, table_name: str)使用以下命令返回列元数据INFORMATION_SCHEMA.describe_indexes_and_foreign_keys(schema: str, table_name: str)列出索引定义以及入站/出站外键。
将兼容MCP的客户端指向正在运行的进程,以通过这些工具发出SQL查询。
Codex示例配置
如果要将此服务器连接到Codex,请在Codex配置文件中添加以下部分(通常 .codex/config.toml).例子:
[mcp_servers.mssql-db]
command = "/path/to/project/.venv/bin/python"
args = ["/path/to/project/mssql_mcp_server.py"]