npm - @liangshanli/mcp-server-project-standards - Versions diffs - 3.0.1 → 5.0.0 - Mend

@liangshanli/mcp-server-project-standards 3.0.1 → 5.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (17) hide show

package/README.md +62 -1
package/README.zh-CN.md +62 -1
package/bin/cli.js +1 -1
package/package.json +1 -1
package/src/server-final.js +102 -9
package/src/utils/api_common.js +3 -3
package/src/utils/api_config.js +22 -22
package/src/utils/api_debug.js +51 -44
package/src/utils/api_execute.js +56 -36
package/src/utils/api_login.js +24 -24
package/src/utils/database_standards.js +9 -9
package/src/utils/generate_cursorrules.js +172 -0
package/src/utils/get_api_standards.js +17 -17
package/src/utils/get_development_standards.js +9 -9
package/src/utils/get_project_info.js +7 -7
package/src/utils/get_project_structure.js +13 -13
package/src/utils/list_directory.js +85 -0

package/src/utils/api_debug.js CHANGED Viewed

@@ -1,38 +1,38 @@
 const { getAllowedMethods, loadApiConfig, saveApiConfig, detectContentType } = require('./api_common');
 const https = require('https');
-// 为 HTTPS 请求创建跳过证书验证的 agent
+// Create an agent for HTTPS requests that skips certificate verification
 const httpsAgent = new https.Agent({
   rejectUnauthorized: false
 });
 /**
- * API 调试工具 - 直接执行API请求
+ * API Debug Tool - Direct API request execution
  *
- * 支持的请求体格式：
- * 1. JSON对象: {"username": "admin", "password": "123456"}
- * 2. 表单数据: "username=admin&password=123456"
- * 3. 纯文本: "Hello World"
+ * Supported body formats:
+ * 1. JSON object: {"username": "admin", "password": "123456"}
+ * 2. Form data: "username=admin&password=123456"
+ * 3. Plain text: "Hello World"
  * 4. XML: "<user><name>John</name><email>john@example.com</email></user>"
  * 5. HTML: "<html><body>Content</body></html>"
  *
- * 自动内容类型检测：
- * - JSON对象 → application/json
- * - 表单数据 → application/x-www-form-urlencoded
+ * Auto content-type detection:
+ * - JSON object → application/json
+ * - Form data → application/x-www-form-urlencoded
  * - XML → application/xml
  * - HTML → text/html
- * - 纯文本 → text/plain
+ * - Plain text → text/plain
  *
- * @param {Object} params - 参数
- * @param {string} params.url - 要执行的接口URL（必需）
- * @param {string} params.method - HTTP方法（可选，默认GET）
- * @param {Object} params.headers - 额外请求头（可选）
- * @param {Object} params.query - 查询参数（可选）
- * @param {*} params.body - 请求体（可选，支持多种格式）
- * @param {string} params.contentType - 内容类型（可选，会自动检测）
- * @param {Object} config - 服务器配置
- * @param {Function} saveConfig - 保存配置函数
- * @returns {Object} API调试结果
+ * @param {Object} params - Parameters
+ * @param {string} params.url - API URL to execute (required)
+ * @param {string} params.method - HTTP method (optional, default GET)
+ * @param {Object} params.headers - Additional request headers (optional)
+ * @param {Object} params.query - Query parameters (optional)
+ * @param {*} params.body - Request body (optional, supports multiple formats)
+ * @param {string} params.contentType - Content-Type (optional, will be auto-detected)
+ * @param {Object} config - Server configuration
+ * @param {Function} saveConfig - Save configuration function
+ * @returns {Object} API debug result
  */
 async function api_debug(params, config, saveConfig) {
   const { url, method = 'GET', headers = {}, query, body, contentType } = params || {};
@@ -77,10 +77,10 @@ async function api_debug(params, config, saveConfig) {
   }
   try {
-    // 加载当前配置
+    // Load current configuration
     const apiDebugConfig = loadApiConfig();
-    // 验证请求方法是否被允许
+    // Verify if the request method is allowed
     const allowedMethods = getAllowedMethods();
     const requestMethod = method.toUpperCase();
@@ -88,7 +88,7 @@ async function api_debug(params, config, saveConfig) {
       throw new Error(`Method ${requestMethod} is not allowed. Allowed methods: ${allowedMethods.join(', ')}`);
     }
-    // 构建完整 URL
+    // Build full URL
     let fullUrl;
     if (url.startsWith('http://') || url.startsWith('https://')) {
       fullUrl = url;
@@ -97,23 +97,23 @@ async function api_debug(params, config, saveConfig) {
       fullUrl = baseUrl + url;
     }
-    // 合并请求头
+    // Merge request headers
     const finalHeaders = {
       ...apiDebugConfig.headers,
       ...headers
     };
-    // 处理请求体
+    // Process request body
     let requestBody = null;
     if (body && (requestMethod === 'POST' || requestMethod === 'PUT' || requestMethod === 'PATCH')) {
       if (typeof body === 'string') {
-        // 检查是否以 { 开头但无法解析为JSON对象
+        // Check if it starts with { but cannot be parsed as a JSON object
         if (body.trim().startsWith('{')) {
           try {
             JSON.parse(body);
-            // 如果能解析成功，继续正常处理
+            // If can parse successfully, continue normal processing
           } catch (parseError) {
-            // 无法解析为JSON，给出建议
+            // Cannot parse as JSON, give suggestions
             return {
               contentType: "text",
               content: [
@@ -146,21 +146,21 @@ async function api_debug(params, config, saveConfig) {
           }
         }
-        // 检查是否指定了 Content-Type
+        // Check if Content-Type is specified
         if (contentType) {
           finalHeaders['Content-Type'] = contentType;
           requestBody = body;
         } else {
-          // 自动判断 Content-Type
+          // Auto-detect Content-Type
           const detectedType = detectContentType(body);
           finalHeaders['Content-Type'] = detectedType;
           requestBody = body;
         }
       } else if (typeof body === 'object') {
-        // 检查是否指定了 Content-Type
+        // Check if Content-Type is specified
         if (contentType) {
           if (contentType === 'application/x-www-form-urlencoded') {
-            // 转换为 URL 编码格式
+            // Convert to URL encoded format
             const formData = new URLSearchParams();
             Object.entries(body).forEach(([key, value]) => {
               if (value !== null && value !== undefined) {
@@ -170,19 +170,19 @@ async function api_debug(params, config, saveConfig) {
             finalHeaders['Content-Type'] = 'application/x-www-form-urlencoded';
             requestBody = formData.toString();
           } else {
-            // 其他指定类型，直接序列化
+            // Other specified types, serialize directly
             finalHeaders['Content-Type'] = contentType;
             requestBody = JSON.stringify(body);
           }
         } else {
-          // 自动判断：对象默认使用 JSON 格式
+          // Auto-detect: objects default to JSON format
           finalHeaders['Content-Type'] = 'application/json';
           requestBody = JSON.stringify(body);
         }
       }
     }
-    // 处理查询参数
+    // Process query parameters
     let queryString = '';
     if (query && Object.keys(query).length > 0) {
       const queryParams = new URLSearchParams();
@@ -202,21 +202,21 @@ async function api_debug(params, config, saveConfig) {
     let error = null;
     try {
-      // 执行请求
+      // Execute request
       const fetchOptions = {
         method: requestMethod,
         headers: finalHeaders,
         body: requestBody
       };
-      // 为 HTTPS 请求添加 agent 以跳过证书验证
+      // Add agent to HTTPS requests to skip certificate verification
       if (finalRequestUrl.startsWith('https')) {
         fetchOptions.agent = httpsAgent;
       }
       response = await fetch(finalRequestUrl, fetchOptions);
-      // 获取响应数据
+      // Get response data
       const responseContentType = response.headers.get('content-type');
       if (responseContentType && responseContentType.includes('application/json')) {
@@ -225,7 +225,7 @@ async function api_debug(params, config, saveConfig) {
         responseData = await response.text();
       }
-      // 判断请求是否成功（HTTP 状态码 200-299 为成功）
+      // Determine if the request was successful (HTTP status code 200-299)
       const isHttpSuccess = response.status >= 200 && response.status < 300;
       success = isHttpSuccess;
@@ -235,20 +235,20 @@ async function api_debug(params, config, saveConfig) {
     }
     if (success && response) {
-      // 自动将接口添加到配置列表中
+      // Automatically add interface to the configuration list
       try {
         const apiConfig = loadApiConfig();
         if (!apiConfig.list) {
           apiConfig.list = [];
         }
-        // 检查是否已存在相同的接口
+        // Check if the same interface already exists
         const existingApiIndex = apiConfig.list.findIndex(api =>
           api.url === url && api.method === requestMethod
         );
         if (existingApiIndex === -1) {
-          // 如果不存在，添加到列表
+          // If it doesn't exist, add to the list
           const newApi = {
             url: url,
             method: requestMethod,
@@ -281,7 +281,7 @@ async function api_debug(params, config, saveConfig) {
             timestamp: new Date().toISOString()
           };
         } else {
-          // 如果已存在，更新接口信息
+          // If it already exists, update the interface information
           apiConfig.list[existingApiIndex] = {
             ...apiConfig.list[existingApiIndex],
             url: url,
@@ -313,7 +313,7 @@ async function api_debug(params, config, saveConfig) {
           };
         }
       } catch (saveError) {
-        // 如果保存失败，仍然返回成功响应
+        // If saving fails, still return a success response
         console.error('Failed to save API to list:', saveError.message);
         return {
           success: true,
@@ -334,6 +334,7 @@ async function api_debug(params, config, saveConfig) {
         };
       }
     } else {
+      // Return response data even on failure
       return {
         success: false,
         message: `Failed to execute API: ${url}`,
@@ -343,6 +344,12 @@ async function api_debug(params, config, saveConfig) {
           headers: finalHeaders,
           body: requestBody
         },
+        response: response ? {
+          status: response.status,
+          statusText: response.statusText,
+          headers: Object.fromEntries(response.headers.entries()),
+          data: responseData
+        } : undefined,
         error: error || (response ? `HTTP ${response.status}: ${response.statusText}` : 'Request failed'),
         timestamp: new Date().toISOString()
       };

package/src/utils/api_execute.js CHANGED Viewed

@@ -1,24 +1,25 @@
 const { loadApiConfig, getAllowedMethods } = require('./api_common');
+const https = require('https');
-// 设置全局环境变量以跳过证书验证
-if (!process.env.NODE_TLS_REJECT_UNAUTHORIZED) {
-  process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
-}
+// Create an agent for HTTPS requests that skips certificate verification
+const httpsAgent = new https.Agent({
+  rejectUnauthorized: false
+});
 /**
- * API 执行工具 - 通过索引执行已配置的API
- * @param {Object} params - 参数
- * @param {number} params.index - API索引（必需）
- * @param {Object} params.overrides - 覆盖参数（可选）
- * @param {string} params.overrides.url - 覆盖URL
- * @param {string} params.overrides.method - 覆盖HTTP方法
- * @param {Object} params.overrides.headers - 覆盖请求头
- * @param {Object} params.overrides.query - 覆盖查询参数
- * @param {*} params.overrides.body - 覆盖请求体
- * @param {string} params.overrides.contentType - 覆盖内容类型
- * @param {Object} config - 服务器配置
- * @param {Function} saveConfig - 保存配置函数
- * @returns {Object} API执行结果
+ * API Execute Tool - Execute configured APIs by index
+ * @param {Object} params - Parameters
+ * @param {number} params.index - API index (required)
+ * @param {Object} params.overrides - Override parameters (optional)
+ * @param {string} params.overrides.url - Override URL
+ * @param {string} params.overrides.method - Override HTTP method
+ * @param {Object} params.overrides.headers - Override request headers
+ * @param {Object} params.overrides.query - Override query parameters
+ * @param {*} params.overrides.body - Override request body
+ * @param {string} params.overrides.contentType - Override content type
+ * @param {Object} config - Server configuration
+ * @param {Function} saveConfig - Save configuration function
+ * @returns {Object} API execution result
  */
 async function api_execute(params, config, saveConfig) {
   const { index, overrides = {} } = params || {};
@@ -28,7 +29,7 @@ async function api_execute(params, config, saveConfig) {
   }
   try {
-    // 加载API配置
+    // Load API configuration
     const apiDebugConfig = loadApiConfig();
     if (!apiDebugConfig.list || !Array.isArray(apiDebugConfig.list)) {
@@ -39,10 +40,10 @@ async function api_execute(params, config, saveConfig) {
       throw new Error(`API index ${index} is out of range. Available APIs: 0-${apiDebugConfig.list.length - 1}`);
     }
-    // 获取API配置
+    // Get API configuration
     const apiConfig = apiDebugConfig.list[index];
-    // 合并配置和覆盖参数
+    // Merge configuration and override parameters
     const finalConfig = {
       url: overrides.url || apiConfig.url,
       method: overrides.method || apiConfig.method || 'GET',
@@ -52,13 +53,13 @@ async function api_execute(params, config, saveConfig) {
       contentType: overrides.contentType || apiConfig.contentType
     };
-    // 验证HTTP方法
+    // Verify HTTP method
     const allowedMethods = getAllowedMethods();
     if (!allowedMethods.includes(finalConfig.method.toUpperCase())) {
       throw new Error(`HTTP method '${finalConfig.method}' is not allowed. Allowed methods: ${allowedMethods.join(', ')}`);
     }
-    // 构建完整URL
+    // Build full URL
     let fullUrl;
     if (finalConfig.url.startsWith('http://') || finalConfig.url.startsWith('https://')) {
       fullUrl = finalConfig.url;
@@ -66,19 +67,19 @@ async function api_execute(params, config, saveConfig) {
       fullUrl = apiDebugConfig.baseUrl + finalConfig.url;
     }
-    // 添加查询参数
+    // Add query parameters
     if (finalConfig.query && Object.keys(finalConfig.query).length > 0) {
       const queryString = new URLSearchParams(finalConfig.query).toString();
       fullUrl += (fullUrl.includes('?') ? '&' : '?') + queryString;
     }
-    // 准备请求选项
+    // Prepare request options
     const requestOptions = {
       method: finalConfig.method.toUpperCase(),
       headers: finalConfig.headers
     };
-    // 处理请求体
+    // Process request body
     if (finalConfig.body && ['POST', 'PUT', 'PATCH'].includes(finalConfig.method.toUpperCase())) {
       if (typeof finalConfig.body === 'object') {
         requestOptions.body = JSON.stringify(finalConfig.body);
@@ -93,23 +94,41 @@ async function api_execute(params, config, saveConfig) {
       }
     }
-    // 执行请求
+    // Execute request
     const startTime = Date.now();
-    const response = await fetch(fullUrl, requestOptions);
-    const endTime = Date.now();
-    // 处理响应
+    let response;
     let responseData;
-    const contentType = response.headers.get('content-type') || '';
+    let error = null;
-    if (contentType.includes('application/json')) {
-      responseData = await response.json();
-    } else {
-      responseData = await response.text();
+    try {
+      // Add agent to HTTPS requests to skip certificate verification
+      if (fullUrl.startsWith('https')) {
+        requestOptions.agent = httpsAgent;
+      }
+      response = await fetch(fullUrl, requestOptions);
+      // Process response
+      const contentType = response.headers.get('content-type') || '';
+      if (contentType.includes('application/json')) {
+        responseData = await response.json();
+      } else {
+        responseData = await response.text();
+      }
+    } catch (fetchError) {
+      error = fetchError.message;
+      throw new Error(`Failed to execute API request: ${error}`);
     }
+    const endTime = Date.now();
+    // Determine if the request was successful (HTTP status code 200-299)
+    const isHttpSuccess = response.status >= 200 && response.status < 300;
+    const success = isHttpSuccess;
     return {
-      success: true,
+      success: success,
       index: index,
       api: {
         url: apiConfig.url,
@@ -129,6 +148,7 @@ async function api_execute(params, config, saveConfig) {
         headers: Object.fromEntries(response.headers.entries()),
         data: responseData
       },
+      error: success ? undefined : (error || `HTTP ${response.status}: ${response.statusText}`),
       timing: {
         duration: endTime - startTime,
         timestamp: new Date().toISOString()

package/src/utils/api_login.js CHANGED Viewed

@@ -1,32 +1,32 @@
 const { getLoginUrl, getLoginMethod, getLoginBody, loadApiConfig, saveApiConfig } = require('./api_common');
 const https = require('https');
-// 为 HTTPS 请求创建跳过证书验证的 agent
+// Create an agent for HTTPS requests that skips certificate verification
 const httpsAgent = new https.Agent({
   rejectUnauthorized: false
 });
 /**
- * API 登录工具 - 直接执行登录请求（从环境变量获取登录信息）
- * @param {Object} params - 参数
- * @param {string} params.baseUrl - 基础URL（可选，会覆盖配置中的baseUrl）
- * @param {Object} config - 服务器配置
- * @param {Function} saveConfig - 保存配置函数
- * @returns {Object} 登录结果
+ * API Login Tool - Execute login request directly (Get login info from environment variables)
+ * @param {Object} params - Parameters
+ * @param {string} params.baseUrl - Base URL (optional, overrides baseUrl in configuration)
+ * @param {Object} config - Server configuration
+ * @param {Function} saveConfig - Save configuration function
+ * @returns {Object} Login result
  */
 async function api_login(params, config, saveConfig) {
   const { baseUrl } = params || {};
   try {
-    // 加载当前配置
+    // Load current configuration
     const apiDebugConfig = loadApiConfig();
-    // 使用传入的baseUrl或配置中的baseUrl
+    // Use passed baseUrl or baseUrl from configuration
     const finalBaseUrl = baseUrl || apiDebugConfig.baseUrl || '';
     const loginUrl = getLoginUrl();
     const loginMethod = getLoginMethod();
-    // 构建完整登录URL
+    // Build full login URL
     let fullLoginUrl;
     if (loginUrl.startsWith('http://') || loginUrl.startsWith('https://')) {
       fullLoginUrl = loginUrl;
@@ -34,29 +34,29 @@ async function api_login(params, config, saveConfig) {
       fullLoginUrl = finalBaseUrl + loginUrl;
     }
-    // 从环境变量获取登录请求体
+    // Get login request body from environment variables
     const loginBodyRaw = getLoginBody();
     let loginBody;
-    // 处理不同格式的请求体
+    // Process request body in different formats
     if (typeof loginBodyRaw === 'string') {
-      // 如果是字符串，直接使用
+      // If it's a string, use it directly
       loginBody = loginBodyRaw;
     } else if (typeof loginBodyRaw === 'object') {
-      // 如果是对象，转换为JSON字符串
+      // If it's an object, convert to JSON string
       loginBody = JSON.stringify(loginBodyRaw);
     } else {
-      // 其他情况，使用默认格式
+      // Otherwise, use default format
       loginBody = '{"username":"","password":""}';
     }
-    // 准备请求头
+    // Prepare request headers
     const headers = {
       ...apiDebugConfig.headers,
       'Content-Type': 'application/json'
     };
-    // 执行登录请求
+    // Execute login request
     let response;
     let responseData;
     let success = true;
@@ -69,14 +69,14 @@ async function api_login(params, config, saveConfig) {
         body: loginBody
       };
-      // 为 HTTPS 请求添加 agent 以跳过证书验证
+      // Add agent to HTTPS requests to skip certificate verification
       if (fullLoginUrl.startsWith('https')) {
         fetchOptions.agent = httpsAgent;
       }
       response = await fetch(fullLoginUrl, fetchOptions);
-      // 获取响应数据
+      // Get response data
       const contentType = response.headers.get('content-type');
       if (contentType && contentType.includes('application/json')) {
@@ -85,17 +85,17 @@ async function api_login(params, config, saveConfig) {
         responseData = await response.text();
       }
-      // 判断登录是否成功
+      // Determine if login was successful
       const isHttpSuccess = response.status >= 200 && response.status < 300;
       success = isHttpSuccess;
       if (success) {
-        // 登录成功，尝试提取token并更新公共请求头
+        // Login successful, try to extract token and update common headers
         let token = null;
-        // 尝试从响应中提取token
+        // Try to extract token from response
         if (responseData && typeof responseData === 'object') {
-          // 常见的token字段名
+          // Common token field names
           const tokenFields = ['token', 'access_token', 'accessToken', 'authToken', 'jwt'];
           for (const field of tokenFields) {
             if (responseData[field]) {
@@ -105,7 +105,7 @@ async function api_login(params, config, saveConfig) {
           }
         }
-        // 如果找到token，自动更新Authorization头
+        // If token is found, automatically update Authorization header
         if (token) {
           apiDebugConfig.headers = {
             ...apiDebugConfig.headers,

package/src/utils/database_standards.js CHANGED Viewed

@@ -21,7 +21,7 @@ async function database_standards(params, config, saveConfig) {
   if (action === 'get') {
     try {
-      // 从配置文件的 database_standards 字段中获取标准，如果没有则使用默认值
+      // Get standards from database_standards field in config file, use default if not present
       const databaseStandards = config?.database_standards || [
         'Use meaningful table names with descriptive prefixes',
         'Use snake_case for table and column names',
@@ -69,23 +69,23 @@ async function database_standards(params, config, saveConfig) {
     }
     try {
-      // 更新配置
+      // Update configuration
       if (!config.database_standards) {
         config.database_standards = [];
       }
-      // 处理数组类型的合并逻辑
+      // Handle merging logic for array types
       if (!forceOverwrite) {
-        // 如果 forceOverwrite 为 false，则合并数组而不是覆盖
+        // Merge array instead of overwrite if forceOverwrite is false
         const existingArray = config.database_standards;
         const newArray = [...new Set([...existingArray, ...standards])];
         config.database_standards = newArray;
       } else {
-        // 直接覆盖
+        // Overwrite directly
         config.database_standards = standards;
       }
-      // 保存配置
+      // Save configuration
       const saved = saveConfig(config);
       if (!saved) {
         throw new Error('Failed to save configuration');
@@ -111,17 +111,17 @@ async function database_standards(params, config, saveConfig) {
     }
     try {
-      // 确保 config.database_standards 存在
+      // Ensure config.database_standards exists
       if (!config.database_standards) {
         config.database_standards = [];
       }
-      // 查找并删除指定的 standard
+      // Find and delete specified standard
       const standardIndex = config.database_standards.indexOf(standard);
       if (standardIndex !== -1) {
         config.database_standards.splice(standardIndex, 1);
-        // 保存配置
+        // Save configuration
         const saved = saveConfig(config);
         if (!saved) {
           throw new Error('Failed to save configuration');