README_ZH.md•3.43 kB



[](https://pypi.org/project/db-query-mcp/)
[](https://github.com/Shulin-Zhang/db-query-mcp/pulls)
\[ 中文 | [English](README.md) \]
# db-query-mcp
## 简介
db-query-mcp 是一个支持多种数据库查询和导出的 MCP 工具,具有以下核心特性:
- 多数据库支持:全面兼容主流关系型数据库(ElasticSearch、MySQL、PostgreSQL、Oracle、SQLite等);
- 安全访问:默认以只读模式连接数据库,保障数据安全;
- 智能查询:提供高效的查询语句生成与执行能力;
- 数据导出:支持查询结果导出功能;
- 未来版本规划将扩展对 MongoDB 以及 GraphDatabase 的支持,致力于成为全栈式数据库查询 MCP。
## 演示
https://github.com/user-attachments/assets/60771cda-8b52-41bd-90e3-523c836f6366
## 更新日志
- 2025-06-02: 支持ElasticSearch数据库查询
## 安装
关系数据库:
```bash
pip install db-query-mcp
```
ElasticSearch:
```bash
pip install "db-query-mcp[elasticsearch]"
```
源码安装:
```bash
pip install git+https://github.com/NewToolAI/db-query-mcp
```
mysql需要额外安装依赖:
```bash
pip install pymysql
```
postgredb需要额外安装依赖:
```bash
pip install psycopg2-binary
```
**对于其他数据库,需要额外安装相应的数据库连接包。**
| Database | Connection Package | Example Connection String |
|-------------|--------------------------|--------------------------|
| **SQLite** | (Python 内置) | `sqlite:///example.db` |
| **MySQL** | `pymysql` 或 `mysql-connector-python` | `mysql+pymysql://user:password@localhost/dbname` |
| **PostgreSQL** | `psycopg2、psycopg2-binary` | `postgresql://user:password@localhost:5432/dbname` |
| **Oracle** | `cx_Oracle` | `oracle+cx_oracle://user:password@hostname:1521/sidname` |
| **SQL Server** | `pyodbc` 或 `pymssql` | `mssql+pyodbc://user:password@hostname/dbname` |
## 配置
**对于某些客户端如cursor,每次只能开启一个db-query-mcp server**
### 使用uvx
```json
{
"mcpServers": {
"sqlite_db_mcp": {
"command": "uvx",
"args": [
"db-query-mcp",
"--db",
"sqlite",
"--uri",
"sqlite:///sqlite_company.db"
]
}
}
}
```
```json
{
"mcpServers": {
"es_db_mcp": {
"command": "uvx",
"args": [
"db-query-mcp",
"--db",
"elasticsearch",
"--uri",
"https://user:password@localhost:9200?index=test_data_index&ca_certs=/home/user/http_ca.crt"
]
}
}
}
```
### 直接使用命令
```json
{
"mcpServers": {
"sqlite_db_mcp": {
"command": "db-query-mcp",
"args": [
"--db",
"sqlite",
"--uri",
"sqlite:///sqlite_company.db"
]
}
}
}
```
```json
{
"mcpServers": {
"es_db_mcp": {
"command": "db-query-mcp",
"args": [
"--db",
"elasticsearch",
"--uri",
"https://user:password@localhost:9200?index=test_data_index&ca_certs=/home/user/http_ca.crt"
]
}
}
}
```