@hyqf98/easy_db_mcp_server 1.0.0 → 2.0.0

package/README.md

@@ -2,6 +2,10 @@
 
 一个通过 npx 部署的 MCP 服务器，为 AI 助手提供统一的数据库访问接口。
 
+## 版本
+
+v2.0.0 - 支持 13 个数据库操作工具
+
 ## 支持的数据库
 
 - MySQL (5.7+)
@@ -73,17 +77,26 @@ export EASYDB_DATABASE=/path/to/database.db
         "EASYDB_HOST": "localhost",
         "EASYDB_USER": "root",
         "EASYDB_PASSWORD": "your_password",
-        "EASYDB_DATABASE": "mydb"
+        "EASYDB_DATABASE": "mydb",
+        "EASYDB_ALLOW_WRITE": "true",
+        "EASYDB_ALLOW_DDL": "true",
       }
     }
   }
 }
 ```
 
+## Claude Code
+
+```cmd
+claude mcp add --scope user --transport stdio easy_db_mcp_server --env EASYDB_TYPE=mysql --env EASYDB_HOST=host --env EASYDB_USER=root --env EASYDB_PASSWORD=123456 --env EASYDB_ALLOW_WRITE=true --env EASYDB_ALLOW_DDL=true -- npx -y @hyqf98/easy_db_mcp_server
+```
+
 ## 可用工具
 
-### list_tables
+### 基础操作
 
+#### list_tables
 列出数据库中的所有表。
 
 **参数：**
@@ -94,8 +107,7 @@ export EASYDB_DATABASE=/path/to/database.db
 请显示数据库中的所有表
 ```
 
-### describe_table
-
+#### describe_table
 获取表的结构，包括列、类型和约束。
 
 **参数：**
@@ -107,8 +119,7 @@ export EASYDB_DATABASE=/path/to/database.db
 显示 users 表的结构
 ```
 
-### execute_query
-
+#### execute_query
 执行 SELECT 查询（只读）。
 
 **参数：**
@@ -120,8 +131,7 @@ export EASYDB_DATABASE=/path/to/database.db
 查找过去 7 天内创建的所有用户
 ```
 
-### execute_sql
-
+#### execute_sql
 执行任意 SQL 语句（需要 `EASYDB_ALLOW_WRITE=true`）。
 
 **参数：**
@@ -130,6 +140,177 @@ export EASYDB_DATABASE=/path/to/database.db
 
 **注意：** DDL 语句（CREATE、DROP、ALTER）还需要 `EASYDB_ALLOW_DDL=true`。
 
+### 批量操作（v2.0.0 新增）
+
+#### execute_transaction
+执行一组 SQL 语句作为事务，失败时自动回滚。
+
+**参数：**
+- `sql`（必填）：SQL 语句数组
+- `database`（可选）：数据库名
+
+**示例：**
+```
+在事务中插入用户和关联的配置数据
+```
+
+#### batch_insert
+批量插入数据，支持多行一次性插入。
+
+**参数：**
+- `table`（必填）：表名
+- `data`（必填）：数据行数组
+- `database`（可选）：数据库名
+
+**返回：**
+- `insertedRows`：成功插入的行数
+- `duplicateRows`：重复的行数
+
+**示例：**
+```
+批量插入 100 条用户数据
+```
+
+#### batch_update
+批量更新数据，基于条件更新。
+
+**参数：**
+- `table`（必填）：表名
+- `updates`（必填）：
+  - `set`：要更新的列值
+  - `where`：WHERE 条件
+- `database`（可选）：数据库名
+
+**返回：**
+- `affectedRows`：受影响的行数
+
+**示例：**
+```
+将所有状态为 inactive 的用户更新为 active
+```
+
+### 数据管理（v2.0.0 新增）
+
+#### export_data
+导出数据为 JSON/CSV 并保存到文件。
+
+**参数：**
+- `table`（必填）：表名
+- `format`（必填）：导出格式（`json` 或 `csv`）
+- `filePath`（可选）：文件保存路径（默认：`~/table_name.json`）
+- `limit`（可选）：行数限制
+- `where`（可选）：WHERE 条件
+- `database`（可选）：数据库名
+
+**返回：**
+- `success`：是否成功
+- `filePath`：实际保存路径
+- `rowCount`：导出的行数
+- `fileSize`：文件大小
+
+**示例：**
+```
+导出 users 表为 JSON 文件
+```
+
+#### create_table
+创建表。
+
+**参数：**
+- `table`（必填）：表名
+- `columns`（必填）：列定义数组
+  - `name`：列名
+  - `type`：数据类型
+  - `nullable`：是否可空
+  - `primaryKey`：是否为主键
+  - `defaultValue`：默认值
+- `database`（可选）：数据库名
+
+**返回：**
+- `success`：是否成功
+- `tableName`：表名
+
+**示例：**
+```
+创建一个 products 表，包含 id、name、price 列
+```
+
+#### drop_table
+删除表。
+
+**参数：**
+- `table`（必填）：表名
+- `ifExists`（可选）：使用 IF EXISTS 避免表不存在时报错
+- `database`（可选）：数据库名
+
+**返回：**
+- `success`：是否成功
+- `tableName`：表名
+
+**示例：**
+```
+删除 temp_data 表
+```
+
+### 数据分析（v2.0.0 新增）
+
+#### get_table_stats
+获取表的统计信息。
+
+**参数：**
+- `table`（必填）：表名
+- `database`（可选）：数据库名
+
+**返回：**
+- `tableName`：表名
+- `rowCount`：行数
+- `columns`：列数
+- `indexes`：索引列表
+- `size`：表大小
+
+**示例：**
+```
+显示 orders 表的统计信息
+```
+
+#### preview_data
+分页预览表数据。
+
+**参数：**
+- `table`（必填）：表名
+- `page`（可选）：页码（默认：1）
+- `pageSize`（可选）：每页行数（默认：50）
+- `orderBy`（可选）：排序列
+- `database`（可选）：数据库名
+
+**返回：**
+- `rows`：数据行
+- `currentPage`：当前页码
+- `totalPages`：总页数
+- `totalRows`：总行数
+
+**示例：**
+```
+预览 users 表的第 2 页，每页 20 条
+```
+
+#### sample_data
+随机采样数据。
+
+**参数：**
+- `table`（必填）：表名
+- `count`（可选）：采样数量（默认：10）
+- `database`（可选）：数据库名
+
+**返回：**
+- `rows`：采样的数据行
+- `sampleCount`：实际采样数量
+
+**示例：**
+```
+从 orders 表随机采样 5 条数据
+```
+
 ## 安全性
 
 默认情况下，服务器只允许读取操作。要启用写入权限：
@@ -161,6 +342,19 @@ npm run dev
 npm start
 ```
 
+## 版本历史
+
+### v2.0.0
+- 升级到 MCP SDK 1.25.3
+- 迁移到新的 McpServer API
+- 新增 9 个工具：execute_transaction, batch_insert, batch_update, export_data, create_table, drop_table, get_table_stats, preview_data, sample_data
+- 新增文件工具模块
+
+### v1.0.0
+- 初始版本
+- 支持 MySQL、PostgreSQL、SQLite
+- 4 个基础工具：list_tables, describe_table, execute_query, execute_sql
+
 ## 许可证
 
 MIT

package/dist/database/base.d.ts

@@ -5,14 +5,84 @@ export interface TableColumn {
     defaultValue: string | null;
     primaryKey: boolean;
     extra?: string;
+    [key: string]: unknown;
 }
 export interface TableInfo {
     name: string;
     rowCount?: number;
+    [key: string]: unknown;
 }
 export interface QueryResult {
     rows: Record<string, unknown>[];
     rowCount: number;
+    [key: string]: unknown;
+}
+export interface BatchInsertResult {
+    insertedRows: number;
+    duplicateRows: number;
+    [key: string]: unknown;
+}
+export interface BatchUpdateOptions {
+    set: Record<string, unknown>;
+    where: string;
+}
+export interface BatchUpdateResult {
+    affectedRows: number;
+    [key: string]: unknown;
+}
+export interface TransactionResult {
+    success: boolean;
+    affectedRows: number;
+    results: unknown[];
+    [key: string]: unknown;
+}
+export interface ExportOptions {
+    limit?: number;
+    where?: string;
+}
+export interface ExportResult {
+    success: boolean;
+    filePath: string;
+    rowCount: number;
+    fileSize: string;
+    [key: string]: unknown;
+}
+export interface TableColumnDef {
+    name: string;
+    type: string;
+    nullable?: boolean;
+    primaryKey?: boolean;
+    defaultValue?: unknown;
+}
+export interface CreateTableResult {
+    success: boolean;
+    tableName: string;
+    [key: string]: unknown;
+}
+export interface DropTableResult {
+    success: boolean;
+    tableName: string;
+    [key: string]: unknown;
+}
+export interface TableStatsResult {
+    tableName: string;
+    rowCount: number;
+    columns: number;
+    indexes: string[];
+    size: string;
+    [key: string]: unknown;
+}
+export interface PreviewDataResult {
+    rows: Record<string, unknown>[];
+    currentPage: number;
+    totalPages: number;
+    totalRows: number;
+    [key: string]: unknown;
+}
+export interface SampleDataResult {
+    rows: Record<string, unknown>[];
+    sampleCount: number;
+    [key: string]: unknown;
 }
 export interface DatabaseAdapter {
     /**
@@ -41,4 +111,13 @@ export interface DatabaseAdapter {
      * Close the database connection
      */
     close(): Promise<void>;
+    batchInsert(table: string, data: Record<string, unknown>[], database?: string): Promise<BatchInsertResult>;
+    batchUpdate(table: string, updates: BatchUpdateOptions, database?: string): Promise<BatchUpdateResult>;
+    executeTransaction(queries: string[], database?: string): Promise<TransactionResult>;
+    exportData(table: string, format: 'json' | 'csv', filePath?: string, options?: ExportOptions, database?: string): Promise<ExportResult>;
+    createTable(table: string, columns: TableColumnDef[], database?: string): Promise<CreateTableResult>;
+    dropTable(table: string, ifExists?: boolean, database?: string): Promise<DropTableResult>;
+    getTableStats(table: string, database?: string): Promise<TableStatsResult>;
+    previewData(table: string, page?: number, pageSize?: number, orderBy?: string, database?: string): Promise<PreviewDataResult>;
+    sampleData(table: string, count?: number, database?: string): Promise<SampleDataResult>;
 }

package/dist/database/mysql.d.ts

@@ -1,4 +1,4 @@
-import type { DatabaseAdapter, TableInfo, TableColumn, QueryResult } from './base.js';
+import type { DatabaseAdapter, TableInfo, TableColumn, QueryResult, TransactionResult, BatchInsertResult, BatchUpdateResult, BatchUpdateOptions, ExportResult, ExportOptions, CreateTableResult, DropTableResult, TableColumnDef, TableStatsResult, PreviewDataResult, SampleDataResult } from './base.js';
 import type { DatabaseConfig } from '../config.js';
 export declare class MySQLAdapter implements DatabaseAdapter {
     private pool?;
@@ -12,4 +12,14 @@ export declare class MySQLAdapter implements DatabaseAdapter {
         affectedRows: number;
     }>;
     close(): Promise<void>;
+    executeTransaction(queries: string[], database?: string): Promise<TransactionResult>;
+    batchInsert(table: string, data: Record<string, unknown>[], database?: string): Promise<BatchInsertResult>;
+    batchUpdate(table: string, updates: BatchUpdateOptions, database?: string): Promise<BatchUpdateResult>;
+    private escapeValue;
+    exportData(table: string, format: 'json' | 'csv', filePath?: string, options?: ExportOptions, database?: string): Promise<ExportResult>;
+    createTable(table: string, columns: TableColumnDef[], database?: string): Promise<CreateTableResult>;
+    dropTable(table: string, ifExists?: boolean, database?: string): Promise<DropTableResult>;
+    getTableStats(table: string, database?: string): Promise<TableStatsResult>;
+    previewData(table: string, page?: number, pageSize?: number, orderBy?: string, database?: string): Promise<PreviewDataResult>;
+    sampleData(table: string, count?: number, database?: string): Promise<SampleDataResult>;
 }