一个用于连接和操作各种数据库系统的模型上下文协议(MCP)实现。
npm install -g mcp-dbs
MCP 数据库服务器可以在两种模式下使用:
默认情况下,服务器在端口 3001 上以 SSE(服务器发送事件)模式运行:
npx mcp-dbs
这将启动一个 HTTP 服务器,并在 http://localhost:3001/mcp
处提供一个 SSE 端点。
你可以使用 --port
选项指定自定义端口:
npx mcp-dbs --port 8080
对于通过标准输入/输出进行通信的工具,你可以使用 --stdio
选项:
npx mcp-dbs --stdio
你可以通过将 mcp-dbs 添加到你的 Claude 配置文件来集成它。
mcpServers
部分:{
"mcpServers": {
"mcp-dbs": {
"command": "node",
"args": [
"/path/to/your/mcp-dbs/dist/cli.js",
"--stdio"
],
"env": {
"MCP_MONGODB_URI": "mongodb://localhost:27017",
"MCP_MONGODB_DATABASE": "your-database-name"
}
}
}
}

将环境变量替换为你自己的数据库连接详细信息。
command
应为 node
args
中,提供 mcp-dbs 安装中 cli.js 文件的绝对路径配置完成后,Claude 将能够使用下面描述的 MCP 工具访问你的数据库。你可以让 Claude:
你可以使用环境变量配置数据库连接:
# 在连接之前设置这些环境变量
export MCP_SQLITE_FILENAME="path/to/database.db"
export MCP_SQLITE_CREATE_IF_NOT_EXISTS="true"

# 在连接之前设置这些环境变量
export MCP_POSTGRES_HOST="your-postgres-host"
export MCP_POSTGRES_PORT="5432"
export MCP_POSTGRES_DATABASE="your-database-name"
export MCP_POSTGRES_USER="your-username"
export MCP_POSTGRES_PASSWORD="your-password"
export MCP_POSTGRES_SSL="false"

# 在连接之前设置这些环境变量
export MCP_MSSQL_SERVER="your-server-address"
export MCP_MSSQL_PORT="1433"
export MCP_MSSQL_DATABASE="your-database-name"
export MCP_MSSQL_USER="your-username"
export MCP_MSSQL_PASSWORD="your-password"
export MCP_MSSQL_ENCRYPT="true"
export MCP_MSSQL_TRUST_SERVER_CERTIFICATE="true"

# 在连接之前设置这些环境变量
export MCP_MONGODB_URI="mongodb://localhost:27017"
export MCP_MONGODB_DATABASE="your-database-name"
export MCP_MONGODB_MAX_POOL_SIZE="10"
export MCP_MONGODB_USE_UNIFIED_TOPOLOGY="true"

这些环境变量将优先于传递给 connect-database 工具的任何配置。
服务器暴露了以下 MCP 工具:
连接到数据库。
参数:
connectionId
: 连接的唯一标识符type
: 数据库类型(sqlite
、postgres
、mssql
或 mongodb
)SQLite 示例:
{
"connectionId": "my-sqlite-db",
"type": "sqlite"
}

PostgreSQL 示例:
{
"connectionId": "my-postgres-db",
"type": "postgres"
}

SQL Server 示例:
{
"connectionId": "my-mssql-db",
"type": "mssql"
}

MongoDB 示例:
{
"connectionId": "my-mongodb-db",
"type": "mongodb"
}

断开与数据库的连接。
参数:
connectionId
: 要断开的连接 ID执行返回结果的查询。
参数:
connectionId
: 连接 IDquery
: SQL 查询或 MongoDB 聚合管道(作为 JSON 字符串)params
: (可选)查询参数数组。对于 MongoDB,第一个参数是集合名称。SQL 示例:
{
"connectionId": "my-postgres-db",
"query": "SELECT * FROM users WHERE age > $1",
"params": [21]
}

MongoDB 示例:
{
"connectionId": "my-mongodb-db",
"query": "[{\"$match\": {\"age\": {\"$gt\": 21}}}, {\"$sort\": {\"name\": 1}}]",
"params": ["users"]
}

MongoDB 示例(新格式,嵌入集合):
{
"connectionId": "my-mongodb-db",
"query": "{\"collection\": \"users\", \"pipeline\": [{\"$match\": {\"age\": {\"$gt\": 21}}}, {\"$sort\": {\"name\": 1}}]}"
}

MongoDB 示例(shell 语法):
{
"connectionId": "my-mongodb-db",
"query": "db.getCollection('users').find({\"age\": {\"$gt\": 21}})"
}

MongoDB 示例(直接集合引用 shell 语法):
{
"connectionId": "my-mongodb-db",
"query": "db.users.find({\"age\": {\"$gt\": 21}})"
}

MongoDB 示例(原始命令):
{
"connectionId": "my-mongodb-db",
"query": "{\"find\": \"users\", \"filter\": {\"age\": {\"$gt\": 21}}}"
}

执行不返回结果的查询(INSERT、UPDATE、DELETE)。
参数:
connectionId
: 连接 IDquery
: SQL 查询或 MongoDB 命令(作为 JSON 字符串)params
: (可选)查询参数数组。对于 MongoDB,第一个参数是集合名称。SQL 示例:
{
"connectionId": "my-postgres-db",
"query": "INSERT INTO users (name, age) VALUES ($1, $2)",
"params": ["John Doe", 30]
}

MongoDB 示例:
{
"connectionId": "my-mongodb-db",
"query": "{\"insertOne\": {\"name\": \"John Doe\", \"age\": 30}}",
"params": ["users"]
}

MongoDB 示例(新格式,嵌入集合):
{
"connectionId": "my-mongodb-db",
"query": "{\"collection\": \"users\", \"operation\": {\"insertOne\": {\"name\": \"John Doe\", \"age\": 30}}}"
}

MongoDB 示例(shell 语法):
{
"connectionId": "my-mongodb-db",
"query": "db.getCollection('users').insertOne({\"name\": \"John Doe\", \"age\": 30})"
}

MongoDB 示例(直接集合引用 shell 语法):
{
"connectionId": "my-mongodb-db",
"query": "db.users.insertOne({\"name\": \"John Doe\", \"age\": 30})"
}

MongoDB 示例(原始命令):
{
"connectionId": "my-mongodb-db",
"query": "{\"insert\": \"users\", \"documents\": [{\"name\": \"John Doe\", \"age\": 30}]}"
}

服务器暴露了以下 MCP 资源:
URI: database://{connectionId}/schema
返回数据库的模式信息,包括所有表及其列。
URI: database://{connectionId}/tables/{tableName}
返回特定表的模式信息,包括其列。
URI: database://{connectionId}/tables
返回数据库中所有表的列表。
运行测试:
npm test

如果你觉得这个项目有帮助,可以考虑请我喝杯咖啡!
扫描上面的二维码或点击这里支持这个项目的开发。
MIT