MCP 数据库服务器

一个模型上下文协议 (MCP) 服务器的实现，允许大型语言模型 (LLM) 通过自然语言与各种数据库进行交互。目前支持 MongoDB，并计划支持：

• PostgreSQL
• CockroachDB
• Redis
• 以及更多...

特性

• 通过自然语言进行数据库操作
• 目前支持 MongoDB，具有以下特性：
  • 列出所有集合
  • 使用过滤和投影查询文档
  • 插入文档
  • 删除文档
  • 聚合管道操作
• 未来支持其他数据库：
  • PostgreSQL：SQL 查询，表操作
  • CockroachDB：分布式 SQL 操作
  • Redis：键值操作，缓存

前提条件

• Node.js v20.12.2 或更高版本
• 数据库（目前为 MongoDB，其他数据库即将推出）
• Claude 桌面应用程序

安装

1. 克隆存储库：

git clone https://github.com/manpreet2000/mcp-database-server.git
cd mcp-database-server

2. 安装依赖项：

npm install

3. 构建 TypeScript 代码：

npm run build

配置

要开始使用，您需要在 Claude 桌面配置文件中配置数据库连接：

MacOS

~/Library/Application\ Support/Claude/claude_desktop_config.json

Windows

%APPDATA%/Claude/claude_desktop_config.json

将以下配置添加到您的 claude_desktop_config.json：

{
  "mcpServers": {
    "database": {
      "command": "/path/to/node",
      "args": ["/path/to/mcp-database/dist/index.js"],
      "env": {
        "MONGODB_URI": "your-mongodb-connection-string"
      }
    }
  }
}

替换：

• /path/to/node 为您的 Node.js 可执行文件路径，或者直接使用 node
• /path/to/mcp-database 为此存储库的绝对路径
• your-mongodb-connection-string 为您的 MongoDB 连接 URL

使用示例

MongoDB 示例

1. 列出数据库中的所有集合：

Can you show me all the collections in my database?

2. 从集合中获取特定记录：

Give me 2 records from the chargers collection

3. 使用过滤器查询：

Show me all documents in the users collection where status is active

4. 插入一个文档：

Add a new user to the users collection with name John and email john@example.com

5. 删除一个文档：

Remove the user with email john@example.com from the users collection

6. 聚合数据：

Show me the total count of users by status in the users collection

可用工具

1. getCollections

列出连接的数据库中的所有集合。

2. getCollection

从集合中检索文档，带有可选的查询参数：

• collectionName：集合的名称
• limit：要返回的最大文档数（默认值：10，最大值：1000）
• query：MongoDB 查询对象
• projection：要包含/排除的字段

3. insertOne

将单个文档插入到集合中：

• collectionName：集合的名称
• document：要插入的文档对象

4. deleteOne

从集合中删除单个文档：

• collectionName：集合的名称
• query：用于匹配要删除的文档的查询

5. aggregate

执行聚合管道：

• collectionName：集合的名称
• pipeline：聚合阶段的数组
• options：可选的聚合选项

未来数据库支持

PostgreSQL

• SQL 查询执行
• 表操作
• 模式管理
• 事务支持

CockroachDB

• 分布式 SQL 操作
• 多区域支持
• 事务管理
• 模式操作

Redis

• 键值操作
• 缓存机制
• 发布/订阅操作
• 数据结构操作

安全

• 永远不要将您的数据库连接字符串提交到版本控制
• 使用环境变量存储敏感信息
• 遵循特定于数据库的安全最佳实践

贡献

欢迎贡献！请随时提交 Pull Request。对于重大更改，请先打开一个 issue 讨论您想要更改的内容。

许可证

MIT 许可证 - 有关详细信息，请参阅 LICENSE