@liangshanli/mcp-server-project-standards 1.0.0

package/src/utils/database_standards.js

@@ -0,0 +1,147 @@
+const fs = require('fs-extra');
+const path = require('path');
+
+/**
+ * Database standards tool - get, set or delete database standards
+ * @param {Object} params - Parameters
+ * @param {string} params.action - Action to perform ('get', 'set', or 'delete')
+ * @param {Array} params.standards - Array of database standards (required for 'set' action)
+ * @param {boolean} params.forceOverwrite - Force overwrite array values when action is 'set' and value is array (default: false)
+ * @param {string} params.standard - Standard content to delete when action is 'delete'
+ * @param {Object} config - Server configuration
+ * @param {Function} saveConfig - Function to save configuration (required for 'set' and 'delete' actions)
+ * @returns {Array|Object} Database standards array or update result
+ */
+async function database_standards(params, config, saveConfig) {
+  const { action, standards, forceOverwrite = false, standard } = params || {};
+  
+  if (!action) {
+    throw new Error('Missing action parameter. Must be "get", "set", or "delete"');
+  }
+  
+  if (action === 'get') {
+    try {
+      // 从配置文件的 database_standards 字段中获取标准，如果没有则使用默认值
+      const databaseStandards = config?.database_standards || [
+        'Use meaningful table names with descriptive prefixes',
+        'Use snake_case for table and column names',
+        'Use singular names for table names',
+        'Use plural names for junction tables',
+        'Include created_at and updated_at timestamps',
+        'Use UUID for primary keys when appropriate',
+        'Create indexes for frequently queried columns',
+        'Use foreign key constraints for data integrity',
+        'Normalize database structure to reduce redundancy',
+        'Use appropriate data types for each column',
+        'Set NOT NULL constraints where data is required',
+        'Use CHECK constraints for data validation',
+        'Create unique constraints for business rules',
+        'Use database transactions for data consistency',
+        'Implement soft deletes instead of hard deletes',
+        'Use database views for complex queries',
+        'Create stored procedures for complex business logic',
+        'Use database triggers sparingly and document them',
+        'Implement database backup and recovery procedures',
+        'Monitor database performance and optimize queries',
+        'Use connection pooling for better performance',
+        'Implement database security best practices',
+        'Use environment-specific database configurations',
+        'Document database schema and relationships',
+        'Version control database migrations',
+        'Test database changes in development first',
+        'Use database monitoring and alerting tools',
+        'Implement database replication for high availability',
+        'Use database partitioning for large tables',
+        'Regularly analyze and optimize database performance'
+      ];
+
+      return databaseStandards;
+    } catch (err) {
+      throw new Error(`Failed to get database standards: ${err.message}`);
+    }
+  } else if (action === 'set') {
+    if (!Array.isArray(standards)) {
+      throw new Error('Standards must be an array for set action');
+    }
+    
+    if (!saveConfig) {
+      throw new Error('saveConfig function is required for set action');
+    }
+    
+    try {
+      // 更新配置
+      if (!config.database_standards) {
+        config.database_standards = [];
+      }
+      
+      // 处理数组类型的合并逻辑
+      if (!forceOverwrite) {
+        // 如果 forceOverwrite 为 false，则合并数组而不是覆盖
+        const existingArray = config.database_standards;
+        const newArray = [...new Set([...existingArray, ...standards])];
+        config.database_standards = newArray;
+      } else {
+        // 直接覆盖
+        config.database_standards = standards;
+      }
+      
+      // 保存配置
+      const saved = saveConfig(config);
+      if (!saved) {
+        throw new Error('Failed to save configuration');
+      }
+      
+      return {
+        success: true,
+        message: 'Successfully updated database standards',
+        updatedCount: config.database_standards.length,
+        forceOverwrite: forceOverwrite,
+        timestamp: new Date().toISOString()
+      };
+    } catch (err) {
+      throw new Error(`Failed to update database standards: ${err.message}`);
+    }
+  } else if (action === 'delete') {
+    if (!standard) {
+      throw new Error('Missing standard parameter for delete action');
+    }
+    
+    if (!saveConfig) {
+      throw new Error('saveConfig function is required for delete action');
+    }
+    
+    try {
+      // 确保 config.database_standards 存在
+      if (!config.database_standards) {
+        config.database_standards = [];
+      }
+      
+      // 查找并删除指定的 standard
+      const standardIndex = config.database_standards.indexOf(standard);
+      if (standardIndex !== -1) {
+        config.database_standards.splice(standardIndex, 1);
+        
+        // 保存配置
+        const saved = saveConfig(config);
+        if (!saved) {
+          throw new Error('Failed to save configuration');
+        }
+        
+        return {
+          success: true,
+          message: `Successfully deleted standard: ${standard}`,
+          deletedStandard: standard,
+          timestamp: new Date().toISOString()
+        };
+      } else {
+        throw new Error(`Standard '${standard}' not found`);
+      }
+    } catch (err) {
+      throw new Error(`Failed to delete standard: ${err.message}`);
+    }
+  } else {
+    throw new Error('Invalid action. Must be "get", "set", or "delete"');
+  }
+}
+
+module.exports = database_standards;

package/src/utils/execute_custom_tool.js

@@ -0,0 +1,51 @@
+const fs = require('fs-extra');
+const path = require('path');
+
+/**
+ * Execute a custom tool
+ * @param {Object} params - Parameters
+ * @param {string} params.toolName - Name of the custom tool to execute
+ * @param {Object} params.arguments - Arguments to pass to the custom tool
+ * @param {Object} config - Server configuration
+ * @returns {Object} Result of tool execution
+ */
+async function execute_custom_tool(params, config) {
+  const { toolName, arguments: args } = params || {};
+  
+  if (!toolName) {
+    throw new Error('Missing toolName parameter');
+  }
+
+  const tool = (config.customTools || []).find(t => t.name === toolName);
+  if (!tool) {
+    throw new Error(`Custom tool '${toolName}' not found`);
+  }
+
+  try {
+    // Create a safe execution context
+    const context = {
+      args: args || {},
+      config: config,
+      fs: fs,
+      path: path,
+      console: console,
+      Date: Date,
+      JSON: JSON
+    };
+
+    // Execute the handler code
+    const handler = new Function('context', tool.handlerCode);
+    const result = handler(context);
+
+    return {
+      success: true,
+      result: result,
+      toolName: toolName,
+      timestamp: new Date().toISOString()
+    };
+  } catch (err) {
+    throw new Error(`Failed to execute custom tool '${toolName}': ${err.message}`);
+  }
+}
+
+module.exports = execute_custom_tool;

package/src/utils/get_api_standards.js

@@ -0,0 +1,203 @@
+const fs = require('fs-extra');
+const path = require('path');
+
+/**
+ * API standards tool - get, set or delete API standards
+ * @param {Object} params - Parameters
+ * @param {string} params.action - Action to perform ('get', 'set', or 'delete')
+ * @param {string} params.key - Key to update when action is 'set' (interfaceType|successStructure|errorStructure|basicHeaders|requirements)
+ * @param {*} params.value - Value to set when action is 'set'
+ * @param {boolean} params.forceOverwrite - Force overwrite array values when action is 'set' and value is array (default: false)
+ * @param {string} params.headerName - Header name to delete when action is 'delete'
+ * @param {string} params.requirement - Requirement content to delete when action is 'delete'
+ * @param {Object} config - Server configuration
+ * @param {Function} saveConfig - Function to save configuration (required for 'set' and 'delete' actions)
+ * @returns {Object} API standards or update result
+ */
+async function api_standards(params, config, saveConfig) {
+  const { action, key, value, forceOverwrite = false, headerName, requirement } = params || {};
+  
+  if (!action) {
+    throw new Error('Missing action parameter. Must be "get", "set", or "delete"');
+  }
+  
+  if (action === 'get') {
+    try {
+      // 从配置文件的 api_standards 字段中获取标准，如果没有则使用默认值
+      const apiStandards = config?.api_standards || {
+        interfaceType: 'restful',
+        successStructure: {
+          code: 'number',
+          message: 'string',
+          data: 'object|array',
+          timestamp: 'string'
+        },
+        errorStructure: {
+          code: 'number',
+          message: 'string',
+          error: 'string',
+          timestamp: 'string'
+        },
+        basicHeaders: {
+          'Content-Type': 'application/json',
+          'Accept': 'application/json',
+          'Authorization': 'Bearer token',
+          'X-Request-ID': 'string'
+        },
+        requirements: [
+          'Unified response format',
+          'Error code standards',
+          'Parameter validation',
+          'API documentation'
+        ]
+      };
+
+      return apiStandards;
+    } catch (err) {
+      throw new Error(`Failed to get API standards: ${err.message}`);
+    }
+  } else if (action === 'set') {
+    if (!key) {
+      throw new Error('Missing key parameter for set action');
+    }
+    
+    if (!['interfaceType', 'successStructure', 'errorStructure', 'basicHeaders', 'requirements'].includes(key)) {
+      throw new Error('Invalid key. Must be one of: interfaceType, successStructure, errorStructure, basicHeaders, requirements');
+    }
+    
+    if (typeof value !== 'string' && !Array.isArray(value)) {
+      throw new Error('Value must be a string or array');
+    }
+    
+    if (!saveConfig) {
+      throw new Error('saveConfig function is required for set action');
+    }
+    
+    try {
+      // 确保 config.api_standards 存在
+      if (!config.api_standards) {
+        config.api_standards = {};
+      }
+      
+      // 处理数组类型的合并逻辑
+      if (Array.isArray(value) && !forceOverwrite) {
+        // 如果 forceOverwrite 为 false，则合并数组而不是覆盖
+        if (!config.api_standards[key]) {
+          config.api_standards[key] = [];
+        }
+        
+        // 确保现有值是数组
+        if (!Array.isArray(config.api_standards[key])) {
+          config.api_standards[key] = [];
+        }
+        
+        // 合并数组，去重
+        const existingArray = config.api_standards[key];
+        const newArray = [...new Set([...existingArray, ...value])];
+        config.api_standards[key] = newArray;
+      } else {
+        // 直接覆盖
+        config.api_standards[key] = value;
+      }
+      
+      // 保存配置
+      const saved = saveConfig(config);
+      if (!saved) {
+        throw new Error('Failed to save configuration');
+      }
+      
+      return {
+        success: true,
+        message: `Successfully updated ${key}`,
+        updatedField: key,
+        newValue: config.api_standards[key],
+        forceOverwrite: forceOverwrite,
+        timestamp: new Date().toISOString()
+      };
+    } catch (err) {
+      throw new Error(`Failed to update API standards: ${err.message}`);
+    }
+  } else if (action === 'delete') {
+    if (!headerName && !requirement) {
+      throw new Error('Missing headerName or requirement parameter for delete action');
+    }
+    
+    if (headerName && requirement) {
+      throw new Error('Cannot delete both header and requirement at the same time. Please specify either headerName or requirement');
+    }
+    
+    if (!saveConfig) {
+      throw new Error('saveConfig function is required for delete action');
+    }
+    
+    try {
+      // 确保 config.api_standards 存在
+      if (!config.api_standards) {
+        config.api_standards = {};
+      }
+      
+      // 删除 header
+      if (headerName) {
+        // 确保 basicHeaders 存在
+        if (!config.api_standards.basicHeaders) {
+          config.api_standards.basicHeaders = {};
+        }
+        
+        // 删除指定的 header
+        if (config.api_standards.basicHeaders.hasOwnProperty(headerName)) {
+          delete config.api_standards.basicHeaders[headerName];
+          
+          // 保存配置
+          const saved = saveConfig(config);
+          if (!saved) {
+            throw new Error('Failed to save configuration');
+          }
+          
+          return {
+            success: true,
+            message: `Successfully deleted header: ${headerName}`,
+            deletedHeader: headerName,
+            timestamp: new Date().toISOString()
+          };
+        } else {
+          throw new Error(`Header '${headerName}' not found`);
+        }
+      }
+      
+      // 删除 requirement
+      if (requirement) {
+        // 确保 requirements 存在
+        if (!config.api_standards.requirements) {
+          config.api_standards.requirements = [];
+        }
+        
+        // 查找并删除指定的 requirement
+        const requirementIndex = config.api_standards.requirements.indexOf(requirement);
+        if (requirementIndex !== -1) {
+          config.api_standards.requirements.splice(requirementIndex, 1);
+          
+          // 保存配置
+          const saved = saveConfig(config);
+          if (!saved) {
+            throw new Error('Failed to save configuration');
+          }
+          
+          return {
+            success: true,
+            message: `Successfully deleted requirement: ${requirement}`,
+            deletedRequirement: requirement,
+            timestamp: new Date().toISOString()
+          };
+        } else {
+          throw new Error(`Requirement '${requirement}' not found`);
+        }
+      }
+    } catch (err) {
+      throw new Error(`Failed to delete: ${err.message}`);
+    }
+  } else {
+    throw new Error('Invalid action. Must be "get", "set", or "delete"');
+  }
+}
+
+module.exports = api_standards;

package/src/utils/get_development_standards.js

@@ -0,0 +1,139 @@
+const fs = require('fs-extra');
+const path = require('path');
+
+/**
+ * Development standards tool - get, set or delete development standards
+ * @param {Object} params - Parameters
+ * @param {string} params.action - Action to perform ('get', 'set', or 'delete')
+ * @param {Array} params.standards - Array of development standards (required for 'set' action)
+ * @param {boolean} params.forceOverwrite - Force overwrite array values when action is 'set' and value is array (default: false)
+ * @param {string} params.standard - Standard content to delete when action is 'delete'
+ * @param {Object} config - Server configuration
+ * @param {Function} saveConfig - Function to save configuration (required for 'set' and 'delete' actions)
+ * @returns {Array|Object} Development standards array or update result
+ */
+async function development_standards(params, config, saveConfig) {
+  const { action, standards, forceOverwrite = false, standard } = params || {};
+  
+  if (!action) {
+    throw new Error('Missing action parameter. Must be "get", "set", or "delete"');
+  }
+  
+  if (action === 'get') {
+    try {
+      // 从配置文件的 development_standards 字段中获取标准，如果没有则使用默认值
+      const developmentStandards = config?.development_standards || [
+        'Use 2 spaces for indentation',
+        'Use single quotes instead of double quotes',
+        'Use camelCase for functions and variables',
+        'Use PascalCase for class names',
+        'Use UPPER_SNAKE_CASE for constants',
+        'Use kebab-case for file names',
+        'Keep lines under 100 characters',
+        'Keep functions under 50 lines',
+        'Keep files under 300 lines',
+        'Use JSDoc format for code comments',
+        'Use OpenAPI/Swagger for API documentation',
+        'Include README.md in project root',
+        'Include CHANGELOG.md in project root',
+        'Separate production and development dependencies',
+        'Use environment variables for sensitive information',
+        'Validate input and output data',
+        'Prevent XSS attacks',
+        'Enable CORS for cross-origin support',
+        'Use Redis or memory cache',
+        'Enable Gzip or Brotli compression',
+        'Monitor application metrics',
+        'Use structured logging'
+      ];
+
+      return developmentStandards;
+    } catch (err) {
+      throw new Error(`Failed to get development standards: ${err.message}`);
+    }
+  } else if (action === 'set') {
+    if (!Array.isArray(standards)) {
+      throw new Error('Standards must be an array for set action');
+    }
+    
+    if (!saveConfig) {
+      throw new Error('saveConfig function is required for set action');
+    }
+    
+    try {
+      // 更新配置
+      if (!config.development_standards) {
+        config.development_standards = [];
+      }
+      
+      // 处理数组类型的合并逻辑
+      if (!forceOverwrite) {
+        // 如果 forceOverwrite 为 false，则合并数组而不是覆盖
+        const existingArray = config.development_standards;
+        const newArray = [...new Set([...existingArray, ...standards])];
+        config.development_standards = newArray;
+      } else {
+        // 直接覆盖
+        config.development_standards = standards;
+      }
+      
+      // 保存配置
+      const saved = saveConfig(config);
+      if (!saved) {
+        throw new Error('Failed to save configuration');
+      }
+      
+      return {
+        success: true,
+        message: 'Successfully updated development standards',
+        updatedCount: config.development_standards.length,
+        forceOverwrite: forceOverwrite,
+        timestamp: new Date().toISOString()
+      };
+    } catch (err) {
+      throw new Error(`Failed to update development standards: ${err.message}`);
+    }
+  } else if (action === 'delete') {
+    if (!standard) {
+      throw new Error('Missing standard parameter for delete action');
+    }
+    
+    if (!saveConfig) {
+      throw new Error('saveConfig function is required for delete action');
+    }
+    
+    try {
+      // 确保 config.development_standards 存在
+      if (!config.development_standards) {
+        config.development_standards = [];
+      }
+      
+      // 查找并删除指定的 standard
+      const standardIndex = config.development_standards.indexOf(standard);
+      if (standardIndex !== -1) {
+        config.development_standards.splice(standardIndex, 1);
+        
+        // 保存配置
+        const saved = saveConfig(config);
+        if (!saved) {
+          throw new Error('Failed to save configuration');
+        }
+        
+        return {
+          success: true,
+          message: `Successfully deleted standard: ${standard}`,
+          deletedStandard: standard,
+          timestamp: new Date().toISOString()
+        };
+      } else {
+        throw new Error(`Standard '${standard}' not found`);
+      }
+    } catch (err) {
+      throw new Error(`Failed to delete standard: ${err.message}`);
+    }
+  } else {
+    throw new Error('Invalid action. Must be "get", "set", or "delete"');
+  }
+}
+
+module.exports = development_standards;

package/src/utils/get_project_info.js

@@ -0,0 +1,87 @@
+const path = require('path');
+const fs = require('fs-extra');
+
+/**
+ * Project information tool - get or set project information
+ * @param {Object} params - Parameters
+ * @param {string} params.action - Action to perform ('get' or 'set')
+ * @param {string} params.key - Key to update when action is 'set' (projectName|developmentLanguage|basicInfo)
+ * @param {*} params.value - Value to set when action is 'set'
+ * @param {Object} config - Server configuration
+ * @param {Function} saveConfig - Function to save configuration (required for 'set' action)
+ * @returns {Object} Project information or update result
+ */
+async function project_info(params, config, saveConfig) {
+  const { action, key, value } = params || {};
+  
+  if (!action) {
+    throw new Error('Missing action parameter. Must be "get" or "set"');
+  }
+  
+  if (action === 'get') {
+    try {
+      // 从配置文件的 project_info 字段中获取项目信息，如果没有则使用默认值
+      const projectInfo = config?.project_info || '';
+      const projectName = projectInfo.projectName || '';
+      const developmentLanguage = projectInfo.developmentLanguage || '';
+      const basicInfo = projectInfo.basicInfo || '';
+
+      return {
+        // 项目名称
+        projectName: projectName,
+        
+        // 开发语言
+        developmentLanguage: developmentLanguage,
+        
+        // 基本信息
+        basicInfo: basicInfo,
+        
+        timestamp: new Date().toISOString()
+      };
+    } catch (err) {
+      throw new Error(`Failed to get project information: ${err.message}`);
+    }
+  } else if (action === 'set') {
+    if (!key) {
+      throw new Error('Missing key parameter for set action');
+    }
+    
+    if (!['projectName', 'developmentLanguage', 'basicInfo'].includes(key)) {
+      throw new Error('Invalid key. Must be one of: projectName, developmentLanguage, basicInfo');
+    }
+    
+    if (!saveConfig) {
+      throw new Error('saveConfig function is required for set action');
+    }
+    
+    try {
+      // 确保 config.project_info 存在
+      if (!config.project_info) {
+        config.project_info = {};
+      }
+      
+      // 更新指定字段
+      config.project_info[key] = value;
+      
+      // 保存配置
+      const saved = saveConfig(config);
+      if (!saved) {
+        throw new Error('Failed to save configuration');
+      }
+      
+      return {
+        success: true,
+        message: `Successfully updated ${key}`,
+        updatedField: key,
+        newValue: value,
+        timestamp: new Date().toISOString()
+      };
+    } catch (err) {
+      throw new Error(`Failed to update project info: ${err.message}`);
+    }
+  } else {
+    throw new Error('Invalid action. Must be "get" or "set"');
+  }
+}
+
+module.exports = project_info;