universal-db-mcp 0.1.0

package/dist/types/adapter.d.ts

@@ -0,0 +1,114 @@
+/**
+ * 数据库适配器接口
+ * 所有数据库实现都必须遵循此接口，确保统一的调用方式
+ */
+export interface DbAdapter {
+    /**
+     * 连接到数据库
+     * @throws 连接失败时抛出错误
+     */
+    connect(): Promise<void>;
+    /**
+     * 断开数据库连接
+     */
+    disconnect(): Promise<void>;
+    /**
+     * 执行查询语句
+     * @param query - SQL 查询语句或 Redis 命令
+     * @param params - 查询参数（用于防止 SQL 注入）
+     * @returns 查询结果
+     */
+    executeQuery(query: string, params?: unknown[]): Promise<QueryResult>;
+    /**
+     * 获取数据库结构信息
+     * @returns 数据库的表结构、索引等元数据
+     */
+    getSchema(): Promise<SchemaInfo>;
+    /**
+     * 检查查询是否为写操作
+     * @param query - 待检查的查询语句
+     * @returns 如果是写操作返回 true
+     */
+    isWriteOperation(query: string): boolean;
+}
+/**
+ * 查询结果接口
+ */
+export interface QueryResult {
+    /** 查询返回的行数据 */
+    rows: Record<string, unknown>[];
+    /** 受影响的行数（用于 INSERT/UPDATE/DELETE） */
+    affectedRows?: number;
+    /** 执行时间（毫秒） */
+    executionTime?: number;
+    /** 额外的元数据 */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * 数据库结构信息
+ */
+export interface SchemaInfo {
+    /** 数据库类型 */
+    databaseType: 'mysql' | 'postgres' | 'redis';
+    /** 数据库名称 */
+    databaseName: string;
+    /** 表信息列表 */
+    tables: TableInfo[];
+    /** 数据库版本 */
+    version?: string;
+}
+/**
+ * 表结构信息
+ */
+export interface TableInfo {
+    /** 表名 */
+    name: string;
+    /** 列信息 */
+    columns: ColumnInfo[];
+    /** 主键列名 */
+    primaryKeys: string[];
+    /** 索引信息 */
+    indexes?: IndexInfo[];
+    /** 预估行数 */
+    estimatedRows?: number;
+}
+/**
+ * 列信息
+ */
+export interface ColumnInfo {
+    /** 列名 */
+    name: string;
+    /** 数据类型 */
+    type: string;
+    /** 是否可为空 */
+    nullable: boolean;
+    /** 默认值 */
+    defaultValue?: string;
+    /** 注释说明 */
+    comment?: string;
+}
+/**
+ * 索引信息
+ */
+export interface IndexInfo {
+    /** 索引名称 */
+    name: string;
+    /** 索引列 */
+    columns: string[];
+    /** 是否唯一索引 */
+    unique: boolean;
+}
+/**
+ * 数据库连接配置
+ */
+export interface DbConfig {
+    type: 'mysql' | 'postgres' | 'redis';
+    host: string;
+    port: number;
+    user?: string;
+    password?: string;
+    database?: string;
+    /** 是否允许写操作（默认 false，只读模式） */
+    allowWrite?: boolean;
+}
+//# sourceMappingURL=adapter.d.ts.map

package/dist/types/adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../../src/types/adapter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,WAAW,SAAS;IACxB;;;OAGG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzB;;OAEG;IACH,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5B;;;;;OAKG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAEtE;;;OAGG;IACH,SAAS,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC;IAEjC;;;;OAIG;IACH,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,eAAe;IACf,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;IAChC,sCAAsC;IACtC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,YAAY;IACZ,YAAY,EAAE,OAAO,GAAG,UAAU,GAAG,OAAO,CAAC;IAC7C,YAAY;IACZ,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY;IACZ,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,YAAY;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,SAAS;IACT,IAAI,EAAE,MAAM,CAAC;IACb,UAAU;IACV,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,WAAW;IACX,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,WAAW;IACX,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC;IACtB,WAAW;IACX,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,SAAS;IACT,IAAI,EAAE,MAAM,CAAC;IACb,WAAW;IACX,IAAI,EAAE,MAAM,CAAC;IACb,YAAY;IACZ,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU;IACV,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW;IACX,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,WAAW;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU;IACV,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,aAAa;IACb,MAAM,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,OAAO,GAAG,UAAU,GAAG,OAAO,CAAC;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6BAA6B;IAC7B,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB"}

package/dist/types/adapter.js

@@ -0,0 +1,6 @@
+/**
+ * 数据库适配器接口
+ * 所有数据库实现都必须遵循此接口，确保统一的调用方式
+ */
+export {};
+//# sourceMappingURL=adapter.js.map

package/dist/types/adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.js","sourceRoot":"","sources":["../../src/types/adapter.ts"],"names":[],"mappings":"AAAA;;;GAGG"}

package/dist/utils/safety.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 安全检查工具
+ * 用于防止误操作删库等危险行为
+ */
+/**
+ * 检查 SQL 语句是否包含写操作
+ * @param query - 待检查的 SQL 语句
+ * @returns 如果包含写操作返回 true
+ */
+export declare function isWriteOperation(query: string): boolean;
+/**
+ * 验证查询是否允许执行
+ * @param query - 待执行的查询
+ * @param allowWrite - 是否允许写操作
+ * @throws 如果查询被拒绝，抛出带有中文提示的错误
+ */
+export declare function validateQuery(query: string, allowWrite: boolean): void;
+/**
+ * 获取查询中的危险关键字（用于日志记录）
+ * @param query - SQL 查询语句
+ * @returns 找到的危险关键字数组
+ */
+export declare function getDangerousKeywords(query: string): string[];
+//# sourceMappingURL=safety.d.ts.map

package/dist/utils/safety.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"safety.d.ts","sourceRoot":"","sources":["../../src/utils/safety.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAkBH;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAQvD;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,GAAG,IAAI,CAStE;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAK5D"}

package/dist/utils/safety.js

@@ -0,0 +1,56 @@
+/**
+ * 安全检查工具
+ * 用于防止误操作删库等危险行为
+ */
+/**
+ * 危险的 SQL 关键字列表
+ * 这些操作会修改或删除数据
+ */
+const DANGEROUS_KEYWORDS = [
+    'DELETE',
+    'DROP',
+    'TRUNCATE',
+    'UPDATE',
+    'INSERT',
+    'ALTER',
+    'CREATE',
+    'RENAME',
+    'REPLACE',
+];
+/**
+ * 检查 SQL 语句是否包含写操作
+ * @param query - 待检查的 SQL 语句
+ * @returns 如果包含写操作返回 true
+ */
+export function isWriteOperation(query) {
+    const upperQuery = query.trim().toUpperCase();
+    return DANGEROUS_KEYWORDS.some(keyword => {
+        // 检查是否以该关键字开头（忽略前导空格和注释）
+        const pattern = new RegExp(`^(\\s|--.*|/\\*.*?\\*/)*${keyword}\\b`, 'i');
+        return pattern.test(upperQuery);
+    });
+}
+/**
+ * 验证查询是否允许执行
+ * @param query - 待执行的查询
+ * @param allowWrite - 是否允许写操作
+ * @throws 如果查询被拒绝，抛出带有中文提示的错误
+ */
+export function validateQuery(query, allowWrite) {
+    if (!allowWrite && isWriteOperation(query)) {
+        throw new Error('❌ 操作被拒绝：当前处于只读安全模式。\n' +
+            '检测到危险操作（DELETE/UPDATE/DROP/TRUNCATE 等）。\n' +
+            '如需执行写入操作，请在启动时添加 --danger-allow-write 参数。\n' +
+            '⚠️  警告：启用写入模式后，AI 可以修改你的数据库，请谨慎使用！');
+    }
+}
+/**
+ * 获取查询中的危险关键字（用于日志记录）
+ * @param query - SQL 查询语句
+ * @returns 找到的危险关键字数组
+ */
+export function getDangerousKeywords(query) {
+    const upperQuery = query.trim().toUpperCase();
+    return DANGEROUS_KEYWORDS.filter(keyword => upperQuery.includes(keyword));
+}
+//# sourceMappingURL=safety.js.map

package/dist/utils/safety.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"safety.js","sourceRoot":"","sources":["../../src/utils/safety.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;GAGG;AACH,MAAM,kBAAkB,GAAG;IACzB,QAAQ;IACR,MAAM;IACN,UAAU;IACV,QAAQ;IACR,QAAQ;IACR,OAAO;IACP,QAAQ;IACR,QAAQ;IACR,SAAS;CACD,CAAC;AAEX;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAa;IAC5C,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAE9C,OAAO,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;QACvC,yBAAyB;QACzB,MAAM,OAAO,GAAG,IAAI,MAAM,CAAC,2BAA2B,OAAO,KAAK,EAAE,GAAG,CAAC,CAAC;QACzE,OAAO,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,KAAa,EAAE,UAAmB;IAC9D,IAAI,CAAC,UAAU,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3C,MAAM,IAAI,KAAK,CACb,uBAAuB;YACvB,2CAA2C;YAC3C,6CAA6C;YAC7C,oCAAoC,CACrC,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAAa;IAChD,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAC9C,OAAO,kBAAkB,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CACzC,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,CAC7B,CAAC;AACJ,CAAC"}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "universal-db-mcp",
+  "version": "0.1.0",
+  "description": "MCP 数据库万能连接器 - 让 Claude Desktop 直接连接你的数据库",
+  "main": "dist/index.js",
+  "bin": {
+    "universal-db-mcp": "dist/index.js"
+  },
+  "type": "module",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "prepare": "npm run build",
+    "start": "node dist/index.js"
+  },
+  "keywords": [
+    "mcp",
+    "model-context-protocol",
+    "claude",
+    "database",
+    "mysql",
+    "postgresql",
+    "redis",
+    "数据库",
+    "AI"
+  ],
+  "author": "Universal DB MCP Contributors",
+  "license": "MIT",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts",
+    "dist/**/*.js.map",
+    "dist/**/*.d.ts.map",
+    "!dist/test.*",
+    "README.md",
+    "EXAMPLES.md",
+    "DEPLOYMENT.md",
+    "CONTRIBUTING.md",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.0.4",
+    "commander": "^12.1.0",
+    "ioredis": "^5.4.2",
+    "mysql2": "^3.11.5",
+    "pg": "^8.13.1",
+    "zod": "^3.24.1"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.5",
+    "@types/pg": "^8.11.10",
+    "typescript": "^5.7.3"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/universal-db-mcp/universal-db-mcp.git"
+  },
+  "bugs": {
+    "url": "https://github.com/universal-db-mcp/universal-db-mcp/issues"
+  },
+  "homepage": "https://github.com/universal-db-mcp/universal-db-mcp#readme"
+}