universal-db-mcp 0.3.1 → 0.5.0

package/EXAMPLES.md

@@ -8,6 +8,9 @@
 - [PostgreSQL 使用示例](#postgresql-使用示例)
 - [Redis 使用示例](#redis-使用示例)
 - [Oracle 使用示例](#oracle-使用示例)
+- [达梦 使用示例](#达梦-使用示例)
+- [SQL Server 使用示例](#sql-server-使用示例)
+- [MongoDB 使用示例](#mongodb-使用示例)
 - [Claude Desktop 配置示例](#claude-desktop-配置示例)
 - [常见使用场景](#常见使用场景)
 
@@ -351,6 +354,299 @@ npm install -g dmdb
 
 ---
 
+## SQL Server 使用示例
+
+### 基础配置（只读模式）
+
+```json
+{
+  "mcpServers": {
+    "sqlserver-db": {
+      "command": "npx",
+      "args": [
+        "universal-db-mcp",
+        "--type", "sqlserver",
+        "--host", "localhost",
+        "--port", "1433",
+        "--user", "sa",
+        "--password", "YourPassword123",
+        "--database", "master"
+      ]
+    }
+  }
+}
+```
+
+**提示**: 也可以使用 `--type mssql` 作为别名。
+
+### 启用写入模式
+
+```json
+{
+  "mcpServers": {
+    "sqlserver-write": {
+      "command": "npx",
+      "args": [
+        "universal-db-mcp",
+        "--type", "sqlserver",
+        "--host", "localhost",
+        "--port", "1433",
+        "--user", "sa",
+        "--password", "YourPassword123",
+        "--database", "MyDatabase",
+        "--danger-allow-write"
+      ]
+    }
+  }
+}
+```
+
+### 连接 Azure SQL Database
+
+```json
+{
+  "mcpServers": {
+    "azure-sql": {
+      "command": "npx",
+      "args": [
+        "universal-db-mcp",
+        "--type", "sqlserver",
+        "--host", "myserver.database.windows.net",
+        "--port", "1433",
+        "--user", "myadmin",
+        "--password", "MyPassword123!",
+        "--database", "mydatabase"
+      ]
+    }
+  }
+}
+```
+
+**注意**: 连接 Azure SQL Database 时会自动启用加密连接。
+
+### 与 Claude 对话示例
+
+**用户**: 查看数据库中有哪些表？
+
+**Claude 会自动**:
+
+1. 调用 `get_schema` 工具
+2. 执行查询: `SELECT TABLE_SCHEMA, TABLE_NAME FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_TYPE = 'BASE TABLE'`
+3. 返回表列表
+
+**用户**: 查看 Users 表的结构
+
+**Claude 会自动**:
+
+1. 调用 `get_table_info` 工具
+2. 返回列信息、主键、索引等详细信息
+
+**用户**: 统计每个部门的员工数量
+
+**Claude 会自动**:
+
+1. 理解需求
+2. 生成 SQL: `SELECT DepartmentID, COUNT(*) as EmployeeCount FROM Employees GROUP BY DepartmentID ORDER BY EmployeeCount DESC`
+3. 执行并返回结果
+
+**用户**: 查找最近一周创建的订单
+
+**Claude 会自动**:
+
+1. 生成 SQL: `SELECT * FROM Orders WHERE CreatedDate >= DATEADD(day, -7, GETDATE()) ORDER BY CreatedDate DESC`
+2. 执行并返回结果
+
+### 注意事项
+
+1. **默认端口**: SQL Server 默认端口为 1433
+2. **身份验证**: 支持 SQL Server 身份验证（用户名/密码）
+3. **加密连接**: 连接 Azure SQL 时会自动启用加密，本地 SQL Server 默认不加密
+4. **数据库名**: 必须指定数据库名（如 master、tempdb 或自定义数据库）
+5. **权限**: 确保用户有足够的权限访问系统视图（INFORMATION_SCHEMA）
+6. **参数化查询**: 支持 `?` 占位符,会自动转换为 SQL Server 的 `@param0` 语法
+
+---
+
+## MongoDB 使用示例
+
+### 基础配置（只读模式）
+
+```json
+{
+  "mcpServers": {
+    "mongodb-db": {
+      "command": "npx",
+      "args": [
+        "universal-db-mcp",
+        "--type", "mongodb",
+        "--host", "localhost",
+        "--port", "27017",
+        "--user", "admin",
+        "--password", "your_password",
+        "--database", "myapp"
+      ]
+    }
+  }
+}
+```
+
+### 无认证连接（开发环境）
+
+```json
+{
+  "mcpServers": {
+    "mongodb-local": {
+      "command": "npx",
+      "args": [
+        "universal-db-mcp",
+        "--type", "mongodb",
+        "--host", "localhost",
+        "--port", "27017",
+        "--database", "test"
+      ]
+    }
+  }
+}
+```
+
+### 启用写入模式
+
+```json
+{
+  "mcpServers": {
+    "mongodb-write": {
+      "command": "npx",
+      "args": [
+        "universal-db-mcp",
+        "--type", "mongodb",
+        "--host", "localhost",
+        "--port", "27017",
+        "--user", "dev_user",
+        "--password", "dev_password",
+        "--database", "development",
+        "--danger-allow-write"
+      ]
+    }
+  }
+}
+```
+
+### 连接 MongoDB Atlas
+
+```json
+{
+  "mcpServers": {
+    "mongodb-atlas": {
+      "command": "npx",
+      "args": [
+        "universal-db-mcp",
+        "--type", "mongodb",
+        "--host", "cluster0.xxxxx.mongodb.net",
+        "--port", "27017",
+        "--user", "myuser",
+        "--password", "mypassword",
+        "--database", "production"
+      ]
+    }
+  }
+}
+```
+
+### 查询格式
+
+MongoDB 适配器支持两种查询格式：
+
+#### 1. JSON 格式（推荐）
+
+```json
+{
+  "collection": "users",
+  "operation": "find",
+  "query": {"age": {"$gt": 18}},
+  "options": {"limit": 10}
+}
+```
+
+#### 2. 简化格式
+
+```javascript
+db.users.find({"age": {"$gt": 18}})
+```
+
+### 与 Claude 对话示例
+
+**用户**: 查看数据库中有哪些集合？
+
+**Claude 会自动**:
+1. 调用 `get_schema` 工具
+2. 返回所有集合的列表和基本信息
+3. 显示每个集合的文档数量和推断的字段结构
+
+**用户**: 查询 users 集合中年龄大于 18 的用户
+
+**Claude 会自动**:
+1. 生成查询: `{"collection": "users", "operation": "find", "query": {"age": {"$gt": 18}}}`
+2. 执行并返回结果
+
+**用户**: 统计每个城市的用户数量
+
+**Claude 会自动**:
+1. 理解需求
+2. 生成聚合查询:
+```json
+{
+  "collection": "users",
+  "operation": "aggregate",
+  "pipeline": [
+    {"$group": {"_id": "$city", "count": {"$sum": 1}}},
+    {"$sort": {"count": -1}}
+  ]
+}
+```
+3. 执行并返回结果
+
+**用户**: 查找最近创建的 10 个订单
+
+**Claude 会自动**:
+1. 生成查询:
+```json
+{
+  "collection": "orders",
+  "operation": "find",
+  "query": {},
+  "options": {"sort": {"createdAt": -1}, "limit": 10}
+}
+```
+2. 执行并返回结果
+
+### 支持的操作
+
+#### 查询操作（只读模式）
+- `find` - 查询文档
+- `findOne` - 查询单个文档
+- `count` / `countDocuments` - 统计文档数量
+- `distinct` - 获取字段的不同值
+- `aggregate` - 聚合管道查询
+
+#### 写入操作（需要 --danger-allow-write）
+- `insert` / `insertOne` - 插入单个文档
+- `insertMany` - 插入多个文档
+- `update` / `updateOne` - 更新单个文档
+- `updateMany` - 更新多个文档
+- `delete` / `deleteOne` - 删除单个文档
+- `deleteMany` - 删除多个文档
+
+### 注意事项
+
+1. **默认端口**: MongoDB 默认端口为 27017
+2. **认证**: 支持用户名/密码认证，默认认证数据库为 admin
+3. **集合结构**: MongoDB 是无模式数据库，Schema 信息通过采样文档推断
+4. **ObjectId**: 查询结果中的 ObjectId 会自动转换为字符串
+5. **查询语法**: 使用 MongoDB 原生查询语法，不是 SQL
+6. **聚合管道**: 支持完整的聚合管道功能
+
+---
+
 ## Claude Desktop 配置示例
 
 ### 同时连接多个数据库

package/README.md

@@ -19,7 +19,7 @@
 
 ✅ **智能表结构理解** - 自动获取数据库 Schema，提供精准建议
 
-✅ **多数据库支持** - MySQL、PostgreSQL、Redis、Oracle、达梦 一键切换
+✅ **多数据库支持** - MySQL、PostgreSQL、Redis、Oracle、达梦、SQL Server、MongoDB 一键切换
 
 ✅ **安全第一** - 默认只读模式，防止误操作删库
 
@@ -33,7 +33,7 @@
 
 - Node.js >= 20
 - Claude Desktop 应用
-- 至少一个数据库实例（MySQL/PostgreSQL/Redis/Oracle/达梦）
+- 至少一个数据库实例（MySQL/PostgreSQL/Redis/Oracle/达梦/SQL Server/MongoDB）
 
 ### 安装
 
@@ -113,7 +113,8 @@ Claude 会自动调用数据库工具完成查询！
 | Redis | `--type redis` | 6379 | ✅ 已支持 | - |
 | Oracle（12c以上） | `--type oracle` | 1521 | ✅ 已支持 | - |
 | 达梦（DM7/DM8） | `--type dm` | 5236 | ✅ 已支持 | 驱动自动安装 |
-| MongoDB | `--type mongo` | - | 🚧 计划中 | - |
+| SQL Server (2012+) | `--type sqlserver` 或 `--type mssql` | 1433 | ✅ 已支持 | 支持 Azure SQL Database |
+| MongoDB | `--type mongodb` | 27017 | ✅ 已支持 | 支持 MongoDB 4.0+ |
 | SQLite | `--type sqlite` | - | 🚧 计划中 | - |
 
 **注意**: 达梦数据库驱动 `dmdb` 会作为可选依赖自动安装。如果安装失败，请手动运行 `npm install -g dmdb`。
@@ -124,7 +125,7 @@ Claude 会自动调用数据库工具完成查询！
 universal-db-mcp [选项]
 
 选项：
-  --type <db>              数据库类型 (mysql|postgres|redis|oracle|dm)
+  --type <db>              数据库类型 (mysql|postgres|redis|oracle|dm|sqlserver|mssql|mongodb)
   --host <host>            数据库主机地址 (默认: localhost)
   --port <port>            数据库端口
   --user <user>            用户名
@@ -145,7 +146,9 @@ src/
 │   ├── postgres.ts
 │   ├── redis.ts
 │   ├── oracle.ts
-│   └── dm.ts
+│   ├── dm.ts
+│   ├── sqlserver.ts
+│   └── mongodb.ts
 ├── types/             # TypeScript 类型定义
 │   └── adapter.ts
 ├── utils/             # 工具函数

package/dist/adapters/mongodb.d.ts

@@ -0,0 +1,74 @@
+/**
+ * MongoDB 数据库适配器
+ * 使用 mongodb 驱动实现 DbAdapter 接口
+ *
+ * 注意：MongoDB 是 NoSQL 文档数据库，没有固定的表结构
+ * 本适配器提供集合操作和文档查询功能
+ */
+import type { DbAdapter, QueryResult, SchemaInfo } from '../types/adapter.js';
+export declare class MongoDBAdapter implements DbAdapter {
+    private client;
+    private db;
+    private config;
+    constructor(config: {
+        host: string;
+        port: number;
+        user?: string;
+        password?: string;
+        database?: string;
+        authSource?: string;
+    });
+    /**
+     * 连接到 MongoDB 数据库
+     */
+    connect(): Promise<void>;
+    /**
+     * 断开数据库连接
+     */
+    disconnect(): Promise<void>;
+    /**
+     * 执行 MongoDB 查询
+     *
+     * 支持的查询格式：
+     * 1. JSON 格式的 MongoDB 查询：
+     *    {"collection": "users", "operation": "find", "query": {"age": {"$gt": 18}}}
+     * 2. 简化的命令格式：
+     *    db.users.find({"age": {"$gt": 18}})
+     * 3. 聚合管道：
+     *    {"collection": "users", "operation": "aggregate", "pipeline": [...]}
+     */
+    executeQuery(query: string, _params?: unknown[]): Promise<QueryResult>;
+    /**
+     * 解析查询字符串
+     */
+    private parseQuery;
+    /**
+     * 执行 MongoDB 操作
+     */
+    private executeOperation;
+    /**
+     * 格式化 MongoDB 文档（将 ObjectId 转换为字符串）
+     */
+    private formatDocument;
+    /**
+     * 获取 MongoDB 数据库信息
+     *
+     * MongoDB 没有固定的表结构，这里通过采样文档来推断集合的字段
+     */
+    getSchema(): Promise<SchemaInfo>;
+    /**
+     * 获取 MongoDB 值的类型
+     */
+    private getMongoType;
+    /**
+     * 检查是否为写操作
+     *
+     * MongoDB 写操作包括：insert, update, delete, drop 等
+     */
+    isWriteOperation(query: string): boolean;
+    /**
+     * 检查操作名称是否为写操作
+     */
+    private isWriteOperationName;
+}
+//# sourceMappingURL=mongodb.d.ts.map

package/dist/adapters/mongodb.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mongodb.d.ts","sourceRoot":"","sources":["../../src/adapters/mongodb.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,KAAK,EACV,SAAS,EACT,WAAW,EACX,UAAU,EAGX,MAAM,qBAAqB,CAAC;AAE7B,qBAAa,cAAe,YAAW,SAAS;IAC9C,OAAO,CAAC,MAAM,CAA4B;IAC1C,OAAO,CAAC,EAAE,CAAmB;IAC7B,OAAO,CAAC,MAAM,CAOZ;gBAEU,MAAM,EAAE;QAClB,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;IAID;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAyC9B;;OAEG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAQjC;;;;;;;;;;OAUG;IACG,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,WAAW,CAAC;IA+B5E;;OAEG;IACH,OAAO,CAAC,UAAU;IA2ClB;;OAEG;YACW,gBAAgB;IA4H9B;;OAEG;IACH,OAAO,CAAC,cAAc;IAuBtB;;;;OAIG;IACG,SAAS,IAAI,OAAO,CAAC,UAAU,CAAC;IA8FtC;;OAEG;IACH,OAAO,CAAC,YAAY;IAYpB;;;;OAIG;IACH,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAsBxC;;OAEG;IACH,OAAO,CAAC,oBAAoB;CAc7B"}