vmoo-mcp-database-server 1.0.0

package/README.md

@@ -0,0 +1,178 @@
+# vmoo-mcp-database-server
+
+VMOO数据库MCP服务器 - 支持开发和生产环境的安全数据库访问
+
+[![npm version](https://badge.fury.io/js/vmoo-mcp-database-server.svg)](https://badge.fury.io/js/vmoo-mcp-database-server)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## 🚀 快速开始
+
+### 使用npx直接运行（推荐）
+
+```bash
+# 开发环境
+npx vmoo-mcp-database-server@latest --env=dev
+
+# 生产环境
+npx vmoo-mcp-database-server@latest --env=prod
+```
+
+### 在Augment中配置
+
+```json
+{
+  "mcpServers": {
+    "vmoo-database-dev": {
+      "command": "npx",
+      "args": ["vmoo-mcp-database-server@latest", "--env=dev"]
+    },
+    "vmoo-database-prod": {
+      "command": "npx",
+      "args": ["vmoo-mcp-database-server@latest", "--env=prod"]
+    }
+  }
+}
+```
+
+### 1. 安装依赖
+
+```bash
+npm install
+```
+
+### 2. 测试数据库连接
+
+```bash
+npm test
+```
+
+如果看到 ✅ 连接成功，说明配置正确。
+
+### 3. 启动MCP服务器
+
+```bash
+npm start
+```
+
+## 🔧 在Augment中配置
+
+### 找到Augment配置文件
+
+- **Windows**: `%APPDATA%\Augment\config.json`
+- **macOS**: `~/Library/Application Support/Augment/config.json`
+- **Linux**: `~/.config/Augment/config.json`
+
+### 添加MCP服务器配置
+
+在配置文件中添加：
+
+```json
+{
+  "mcpServers": {
+    "vmoo-database": {
+      "command": "node",
+      "args": ["D:\\代码库\\vmoo-mcp-server\\mcp-vmoo-database-server.js"],
+      "env": {}
+    }
+  }
+}
+```
+
+**注意**: 请将路径替换为你的实际路径。
+
+### 重启Augment
+
+保存配置文件后，重启Augment应用。
+
+## 🛠️ 可用工具
+
+配置成功后，你可以在Augment中直接询问：
+
+### 1. 查询数据库
+- "列出所有fanwe_开头的表"
+- "查询最近注册的10个用户"
+- "显示fanwe_menu表中价格最高的商品"
+
+### 2. 查看表结构
+- "fanwe_user表的结构是什么？"
+- "描述fanwe_order表的字段"
+
+### 3. 获取示例数据
+- "显示fanwe_menu表的前5条记录"
+- "fanwe_user表的示例数据"
+
+### 4. 统计信息
+- "fanwe_user表有多少条记录？"
+- "数据库中有多少个表？"
+
+## 📊 数据库信息
+
+- **主机**: 118.25.190.11:3306
+- **数据库**: ceshi_v_moo_com
+- **表前缀**: fanwe_
+- **字符集**: utf8mb4
+
+## 🔒 安全特性
+
+### 允许的操作
+- **查询操作**: SELECT、SHOW、DESCRIBE、EXPLAIN
+- **数据修改**: INSERT、UPDATE（仅限新增和修改）
+- **表结构**: CREATE TABLE、ALTER TABLE
+
+### 安全防护
+- **禁止所有删除操作**: 完全阻止DELETE、DROP TABLE、DROP DATABASE等删除操作
+- **测试环境专用**: 专为测试环境设计，确保数据安全
+- **查询限制**: 自动添加LIMIT防止大量数据返回
+- **SQL注入防护**: 使用参数化查询
+- **连接池管理**: 自动管理数据库连接
+- **错误处理**: 完善的错误捕获和提示
+
+## 📝 使用示例
+
+```
+用户: "VMOO数据库中有哪些用户相关的表？"
+AI: 调用list_tables工具，返回包含user的表列表
+
+用户: "fanwe_user表的字段都有什么含义？"
+AI: 调用describe_table工具，返回表结构详情
+
+用户: "最近一周注册的用户有多少？"
+AI: 调用query_database工具，执行相应SQL查询
+```
+
+## 🛠️ 开发调试
+
+### 启用调试模式
+
+```bash
+npm run dev
+```
+
+这将启用Node.js调试器，可以在Chrome DevTools中调试。
+
+### 查看日志
+
+MCP服务器的日志会输出到stderr，可以通过以下方式查看：
+
+```bash
+node mcp-vmoo-database-server.js 2> debug.log
+```
+
+## 🔧 故障排除
+
+### 连接问题
+- 检查网络连接
+- 确认数据库服务器可访问
+- 验证防火墙设置
+
+### 权限问题
+- 确保数据库用户有查询权限
+- 检查表访问权限
+
+### 配置问题
+- 验证Augment配置文件路径正确
+- 确保Node.js版本 >= 18.0.0
+
+## 📄 许可证
+
+MIT License

package/bin/vmoo-mcp-dev.js

@@ -0,0 +1,45 @@
+#!/usr/bin/env node
+
+// VMOO开发环境MCP服务器启动器
+
+import { spawn } from 'child_process';
+import { fileURLToPath } from 'url';
+import path from 'path';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+// 解析命令行参数
+const args = process.argv.slice(2);
+const configPath = args.find(arg => arg.startsWith('--config='))?.split('=')[1];
+
+console.log('🟡 启动VMOO开发环境MCP服务器...');
+
+// 服务器文件路径
+const serverPath = path.join(__dirname, '../vmoo-database-dev/server.js');
+
+// 启动服务器
+const serverProcess = spawn('node', [serverPath], {
+  stdio: 'inherit',
+  env: {
+    ...process.env,
+    ...(configPath && { CONFIG_PATH: configPath })
+  }
+});
+
+// 处理进程退出
+serverProcess.on('close', (code) => {
+  console.log(`🟡 开发环境MCP服务器已退出，退出码: ${code}`);
+  process.exit(code);
+});
+
+// 处理中断信号
+process.on('SIGINT', () => {
+  console.log('\n🛑 正在关闭开发环境MCP服务器...');
+  serverProcess.kill('SIGINT');
+});
+
+process.on('SIGTERM', () => {
+  console.log('\n🛑 正在关闭开发环境MCP服务器...');
+  serverProcess.kill('SIGTERM');
+});

package/bin/vmoo-mcp-prod.js

@@ -0,0 +1,45 @@
+#!/usr/bin/env node
+
+// VMOO生产环境MCP服务器启动器
+
+import { spawn } from 'child_process';
+import { fileURLToPath } from 'url';
+import path from 'path';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+// 解析命令行参数
+const args = process.argv.slice(2);
+const configPath = args.find(arg => arg.startsWith('--config='))?.split('=')[1];
+
+console.log('🔴 启动VMOO生产环境MCP服务器...');
+
+// 服务器文件路径
+const serverPath = path.join(__dirname, '../vmoo-database-prod/server.js');
+
+// 启动服务器
+const serverProcess = spawn('node', [serverPath], {
+  stdio: 'inherit',
+  env: {
+    ...process.env,
+    ...(configPath && { CONFIG_PATH: configPath })
+  }
+});
+
+// 处理进程退出
+serverProcess.on('close', (code) => {
+  console.log(`🔴 生产环境MCP服务器已退出，退出码: ${code}`);
+  process.exit(code);
+});
+
+// 处理中断信号
+process.on('SIGINT', () => {
+  console.log('\n🛑 正在关闭生产环境MCP服务器...');
+  serverProcess.kill('SIGINT');
+});
+
+process.on('SIGTERM', () => {
+  console.log('\n🛑 正在关闭生产环境MCP服务器...');
+  serverProcess.kill('SIGTERM');
+});

package/index.js

@@ -0,0 +1,38 @@
+#!/usr/bin/env node
+
+// VMOO MCP数据库服务器包主入口
+
+export { createConnectionPool, executeQuery } from './shared/database-utils.js';
+export { SECURITY_LEVELS, performSecurityCheck } from './shared/security-utils.js';
+export { processTimeFields } from './shared/time-utils.js';
+export { anonymizeQueryResults } from './shared/privacy-utils.js';
+
+// 默认导出服务器启动函数
+export default function startServer(environment = 'dev') {
+  const { spawn } = require('child_process');
+  const path = require('path');
+  
+  const serverPath = environment === 'prod' 
+    ? path.join(__dirname, 'vmoo-database-prod/server.js')
+    : path.join(__dirname, 'vmoo-database-dev/server.js');
+    
+  return spawn('node', [serverPath], { stdio: 'inherit' });
+}
+
+// 如果直接运行此文件，显示帮助信息
+if (import.meta.url === `file://${process.argv[1]}`) {
+  console.log(`
+🟡 VMOO MCP数据库服务器
+
+使用方法:
+  npx @vmoo/mcp-database-server@latest --env=dev   # 开发环境
+  npx @vmoo/mcp-database-server@latest --env=prod  # 生产环境
+
+或者直接使用:
+  npx vmoo-mcp-dev    # 开发环境
+  npx vmoo-mcp-prod   # 生产环境
+
+配置文件:
+  --config=path/to/config.json  # 自定义配置文件路径
+  `);
+}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "vmoo-mcp-database-server",
+  "version": "1.0.0",
+  "description": "VMOO数据库MCP服务器集合 - 支持开发和生产环境的安全数据库访问",
+  "type": "module",
+  "main": "index.js",
+  "bin": {
+    "vmoo-mcp-dev": "./bin/vmoo-mcp-dev.js",
+    "vmoo-mcp-prod": "./bin/vmoo-mcp-prod.js"
+  },
+  "scripts": {
+    "start:prod": "cd vmoo-database-prod && npm start",
+    "start:dev": "cd vmoo-database-dev && npm start",
+    "install:all": "npm install && cd vmoo-database-prod && npm install && cd ../vmoo-database-dev && npm install",
+    "test:all": "cd vmoo-database-prod && npm test && cd ../vmoo-database-dev && npm test",
+    "build": "echo '构建完成'",
+    "deploy": "./scripts/deploy.sh"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.17.2",
+    "mysql2": "^3.6.5"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0"
+  },
+  "keywords": [
+    "mcp",
+    "database",
+    "mysql",
+    "vmoo",
+    "model-context-protocol",
+    "production",
+    "development",
+    "privacy",
+    "security"
+  ],
+  "author": "VMOO Team",
+  "license": "MIT",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "bin/",
+    "shared/",
+    "vmoo-database-dev/",
+    "vmoo-database-prod/",
+    "index.js",
+    "README.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jinzong8/vmoo-mcp-server.git"
+  },
+  "bugs": {
+    "url": "https://github.com/jinzong8/vmoo-mcp-server/issues"
+  },
+  "homepage": "https://github.com/jinzong8/vmoo-mcp-server#readme"
+}

package/shared/database-utils.js

@@ -0,0 +1,102 @@
+// VMOO数据库工具函数
+import mysql from 'mysql2/promise';
+
+/**
+ * 创建数据库连接池
+ * @param {Object} config 数据库配置
+ * @returns {Object} 连接池
+ */
+function createConnectionPool(config) {
+  return mysql.createPool({
+    ...config,
+    waitForConnections: true,
+    connectionLimit: 10,
+    queueLimit: 0
+  });
+}
+
+/**
+ * 标准化表名（添加fanwe_前缀）
+ * @param {string} tableName 表名
+ * @returns {string} 标准化后的表名
+ */
+function normalizeTableName(tableName) {
+  if (!tableName.startsWith('fanwe_')) {
+    return `fanwe_${tableName}`;
+  }
+  return tableName;
+}
+
+/**
+ * 执行查询并处理错误
+ * @param {Object} pool 连接池
+ * @param {string} query 查询语句
+ * @returns {Array} 查询结果
+ */
+async function executeQuery(pool, query) {
+  try {
+    const [rows] = await pool.execute(query);
+    return rows;
+  } catch (error) {
+    throw new Error(`数据库查询失败: ${error.message}`);
+  }
+}
+
+/**
+ * 获取表结构
+ * @param {Object} pool 连接池
+ * @param {string} tableName 表名
+ * @returns {Array} 表结构
+ */
+async function getTableStructure(pool, tableName) {
+  const normalizedName = normalizeTableName(tableName);
+  return await executeQuery(pool, `DESCRIBE ${normalizedName}`);
+}
+
+/**
+ * 获取表记录数
+ * @param {Object} pool 连接池
+ * @param {string} tableName 表名
+ * @returns {number} 记录数
+ */
+async function getTableCount(pool, tableName) {
+  const normalizedName = normalizeTableName(tableName);
+  const rows = await executeQuery(pool, `SELECT COUNT(*) as count FROM ${normalizedName}`);
+  return rows[0].count;
+}
+
+/**
+ * 获取表示例数据
+ * @param {Object} pool 连接池
+ * @param {string} tableName 表名
+ * @param {number} limit 限制数量
+ * @returns {Array} 示例数据
+ */
+async function getTableSampleData(pool, tableName, limit = 10) {
+  const normalizedName = normalizeTableName(tableName);
+  return await executeQuery(pool, `SELECT * FROM ${normalizedName} LIMIT ${limit}`);
+}
+
+/**
+ * 列出所有表
+ * @param {Object} pool 连接池
+ * @param {string} pattern 匹配模式
+ * @returns {Array} 表列表
+ */
+async function listTables(pool, pattern = null) {
+  let query = "SHOW TABLES";
+  if (pattern) {
+    query += ` LIKE '%${pattern}%'`;
+  }
+  return await executeQuery(pool, query);
+}
+
+export {
+  createConnectionPool,
+  normalizeTableName,
+  executeQuery,
+  getTableStructure,
+  getTableCount,
+  getTableSampleData,
+  listTables
+};

package/shared/privacy-utils.js

@@ -0,0 +1,207 @@
+// 个人信息匿名化工具
+
+/**
+ * 手机号码匿名化
+ * @param {string} phone 手机号码
+ * @returns {string} 匿名化后的手机号
+ */
+function anonymizePhone(phone) {
+  if (!phone || typeof phone !== 'string') return phone;
+  
+  // 移除所有非数字字符
+  const cleanPhone = phone.replace(/\D/g, '');
+  
+  if (cleanPhone.length === 11) {
+    // 中国手机号：138****1234
+    return `${cleanPhone.substring(0, 3)}****${cleanPhone.substring(7)}`;
+  } else if (cleanPhone.length >= 7) {
+    // 其他格式：保留前3位和后4位
+    const start = cleanPhone.substring(0, 3);
+    const end = cleanPhone.substring(cleanPhone.length - 4);
+    const stars = '*'.repeat(Math.max(4, cleanPhone.length - 7));
+    return `${start}${stars}${end}`;
+  }
+  
+  return phone; // 格式不符合，返回原值
+}
+
+/**
+ * 身份证号匿名化
+ * @param {string} idCard 身份证号
+ * @returns {string} 匿名化后的身份证号
+ */
+function anonymizeIdCard(idCard) {
+  if (!idCard || typeof idCard !== 'string') return idCard;
+  
+  const cleanId = idCard.replace(/\s/g, '');
+  
+  if (cleanId.length === 18) {
+    // 18位身份证：320***********1234
+    return `${cleanId.substring(0, 3)}${'*'.repeat(11)}${cleanId.substring(14)}`;
+  } else if (cleanId.length === 15) {
+    // 15位身份证：320*********34
+    return `${cleanId.substring(0, 3)}${'*'.repeat(9)}${cleanId.substring(13)}`;
+  }
+  
+  return idCard; // 格式不符合，返回原值
+}
+
+/**
+ * 邮箱地址匿名化
+ * @param {string} email 邮箱地址
+ * @returns {string} 匿名化后的邮箱
+ */
+function anonymizeEmail(email) {
+  if (!email || typeof email !== 'string') return email;
+  
+  const emailRegex = /^([^@]+)@(.+)$/;
+  const match = email.match(emailRegex);
+  
+  if (match) {
+    const [, username, domain] = match;
+    
+    if (username.length <= 3) {
+      // 短用户名：u**@example.com
+      return `${username.charAt(0)}${'*'.repeat(Math.max(2, username.length - 1))}@${domain}`;
+    } else {
+      // 长用户名：user***@example.com
+      return `${username.substring(0, 4)}${'*'.repeat(Math.max(3, username.length - 4))}@${domain}`;
+    }
+  }
+  
+  return email; // 格式不符合，返回原值
+}
+
+/**
+ * 真实姓名匿名化
+ * @param {string} name 真实姓名
+ * @returns {string} 匿名化后的姓名
+ */
+function anonymizeName(name) {
+  if (!name || typeof name !== 'string') return name;
+  
+  const trimmedName = name.trim();
+  
+  if (trimmedName.length === 1) {
+    return trimmedName; // 单字名不处理
+  } else if (trimmedName.length === 2) {
+    // 两字名：张*
+    return `${trimmedName.charAt(0)}*`;
+  } else if (trimmedName.length === 3) {
+    // 三字名：张**
+    return `${trimmedName.charAt(0)}**`;
+  } else {
+    // 长姓名：保留第一个字，其余用*
+    return `${trimmedName.charAt(0)}${'*'.repeat(Math.min(2, trimmedName.length - 1))}`;
+  }
+}
+
+/**
+ * 地址匿名化
+ * @param {string} address 地址
+ * @returns {string} 匿名化后的地址
+ */
+function anonymizeAddress(address) {
+  if (!address || typeof address !== 'string') return address;
+  
+  // 保留省市，隐藏详细地址
+  const addressRegex = /(.*?[省市区县])(.*)/;
+  const match = address.match(addressRegex);
+  
+  if (match && match[2].length > 6) {
+    const [, region, detail] = match;
+    return `${region}***${detail.substring(detail.length - 3)}`;
+  }
+  
+  return address;
+}
+
+/**
+ * 银行卡号匿名化
+ * @param {string} bankCard 银行卡号
+ * @returns {string} 匿名化后的银行卡号
+ */
+function anonymizeBankCard(bankCard) {
+  if (!bankCard || typeof bankCard !== 'string') return bankCard;
+  
+  const cleanCard = bankCard.replace(/\s/g, '');
+  
+  if (cleanCard.length >= 12) {
+    // 保留前4位和后4位
+    const start = cleanCard.substring(0, 4);
+    const end = cleanCard.substring(cleanCard.length - 4);
+    const stars = '*'.repeat(Math.max(4, cleanCard.length - 8));
+    return `${start} ${stars} ${end}`;
+  }
+  
+  return bankCard;
+}
+
+/**
+ * 对查询结果进行数据匿名化处理
+ * @param {Array} rows 查询结果
+ * @returns {Array} 匿名化后的结果
+ */
+function anonymizeQueryResults(rows) {
+  if (!Array.isArray(rows)) return rows;
+  
+  // 需要匿名化的字段映射
+  const fieldMappings = {
+    // 手机号字段
+    mobile: anonymizePhone,
+    phone: anonymizePhone,
+    tel: anonymizePhone,
+    telephone: anonymizePhone,
+    
+    // 身份证字段
+    id_card: anonymizeIdCard,
+    identity_card: anonymizeIdCard,
+    id_number: anonymizeIdCard,
+    
+    // 邮箱字段
+    email: anonymizeEmail,
+    mail: anonymizeEmail,
+    
+    // 姓名字段
+    name: anonymizeName,
+    real_name: anonymizeName,
+    user_name: anonymizeName,
+    consignee: anonymizeName,
+    
+    // 地址字段
+    address: anonymizeAddress,
+    delivery_address: anonymizeAddress,
+    
+    // 银行卡字段
+    bank_card: anonymizeBankCard,
+    card_number: anonymizeBankCard
+  };
+  
+  return rows.map(row => {
+    const anonymizedRow = { ...row };
+    
+    Object.keys(anonymizedRow).forEach(key => {
+      const lowerKey = key.toLowerCase();
+      
+      // 检查是否需要匿名化
+      Object.keys(fieldMappings).forEach(fieldPattern => {
+        if (lowerKey.includes(fieldPattern)) {
+          const anonymizeFunc = fieldMappings[fieldPattern];
+          anonymizedRow[key] = anonymizeFunc(anonymizedRow[key]);
+        }
+      });
+    });
+    
+    return anonymizedRow;
+  });
+}
+
+export {
+  anonymizePhone,
+  anonymizeIdCard,
+  anonymizeEmail,
+  anonymizeName,
+  anonymizeAddress,
+  anonymizeBankCard,
+  anonymizeQueryResults
+};