@liangshanli/mcp-server-project-standards 2.0.1 → 2.0.4

package/bin/cli.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 const { spawn } = require('child_process');
 const path = require('path');
 const fs = require('fs');
@@ -19,6 +19,8 @@ if (!fs.existsSync(serverPath)) {
 }
 
 writeLog('INFO', `Starting MCP Project Standards server from: ${serverPath}`);
+writeLog('INFO', `Current working directory: ${process.cwd()}`);
+writeLog('INFO', `CLI script directory: ${__dirname}`);
 
 let server = null;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@liangshanli/mcp-server-project-standards",
-  "version": "2.0.1",
+  "version": "2.0.4",
   "description": "MCP Project Standards server with project info, structure, API standards, development standards, API debugging, login authentication and configuration management tools",
   "main": "bin/cli.js",
   "bin": {

package/src/server-final.js

@@ -1,98 +1,3 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
 const fs = require('fs-extra');
 const path = require('path');
 
@@ -105,6 +10,7 @@ const database_standards = require('./utils/database_standards');
 const api_login = require('./utils/api_login');
 const api_debug = require('./utils/api_debug');
 const api_config = require('./utils/api_config');
+const api_help = require('./utils/api_help');
 
 // Get configuration from file or environment
 const getConfig = () => {
@@ -274,6 +180,12 @@ class ProjectStandardsMCPServer {
     return result;
   }
 
+  // API help tool
+  async api_help(params) {
+    const result = await api_help(params, this.config, saveConfig);
+    return result;
+  }
+
 
 
 
@@ -617,7 +529,7 @@ class ProjectStandardsMCPServer {
           // API Login Tool
           tools.push({
             name: 'api_login',
-            description: 'API login authentication tool that uses environment variables for login credentials',
+            description: 'API login authentication tool that uses environment variables for login credentials. Automatically extracts token from response and updates Authorization headers. Example: Call with optional baseUrl parameter to override default base URL',
             inputSchema: {
               type: 'object',
               properties: {
@@ -632,7 +544,7 @@ class ProjectStandardsMCPServer {
           // API Debug Tool
           tools.push({
             name: 'api_debug',
-            description: 'API debugging tool for directly executing API requests with automatic content-type detection and flexible body format support',
+            description: 'API debugging tool for directly executing API requests with automatic content-type detection and flexible body format support. Examples: GET /api/users with query params, POST /api/login with JSON body {"username":"admin","password":"123456"}, PUT /api/users/123 with form data "name=John&email=john@example.com"',
             inputSchema: {
               type: 'object',
               properties: {
@@ -719,17 +631,33 @@ class ProjectStandardsMCPServer {
             }
           });
 
+          // API Help Tool
+          tools.push({
+            name: 'api_help',
+            description: 'API help tool that provides detailed documentation and examples for all API debugging tools. Use this to understand how to use api_debug, api_login, and api_config tools effectively',
+            inputSchema: {
+              type: 'object',
+              properties: {
+                tool: {
+                  type: 'string',
+                  description: 'Specific tool name to get help for (optional: api_debug, api_login, api_config)',
+                  examples: ['api_debug', 'api_login', 'api_config']
+                }
+              }
+            }
+          });
+
           // API Config Tool
           tools.push({
             name: 'api_config',
-            description: 'API configuration management tool for managing API settings, endpoints, and configurations',
+            description: 'API configuration management tool for managing API settings, endpoints, and configurations. Examples: get config, set baseUrl to "https://api.example.com", updateHeaders with {"Authorization":"Bearer token"}, search APIs by keyword, list all configured APIs',
             inputSchema: {
               type: 'object',
               properties: {
                 action: {
                   type: 'string',
-                  enum: ['get', 'set', 'updateBaseUrl', 'updateHeaders', 'deleteHeader', 'search', 'list'],
-                  description: 'Action to perform: "get" to retrieve config, "set" to update config, "updateBaseUrl" to update base URL, "updateHeaders" to update headers, "deleteHeader" to delete header, "search" to search APIs, "list" to list all APIs'
+                  enum: ['get', 'set', 'updateBaseUrl', 'updateHeaders', 'deleteHeader', 'addApi', 'search', 'list'],
+                  description: 'Action to perform: "get" to retrieve config, "set" to update config, "updateBaseUrl" to update base URL, "updateHeaders" to update headers, "deleteHeader" to delete header, "addApi" to add API endpoint, "search" to search APIs, "list" to list all APIs'
                 },
                 config: {
                   type: 'object',
@@ -795,6 +723,41 @@ class ProjectStandardsMCPServer {
                   type: 'string',
                   description: 'Name of header to delete (required for "deleteHeader" action)'
                 },
+                api: {
+                  type: 'object',
+                  description: 'API configuration (required for "addApi" action)',
+                  properties: {
+                    url: {
+                      type: 'string',
+                      description: 'API endpoint URL'
+                    },
+                    method: {
+                      type: 'string',
+                      enum: ['GET', 'POST', 'PUT', 'DELETE', 'PATCH'],
+                      description: 'HTTP method'
+                    },
+                    description: {
+                      type: 'string',
+                      description: 'API description'
+                    },
+                    query: {
+                      type: 'object',
+                      description: 'Query parameters'
+                    },
+                    body: {
+                      description: 'Request body'
+                    },
+                    contentType: {
+                      type: 'string',
+                      description: 'Content-Type for request body'
+                    },
+                    header: {
+                      type: 'object',
+                      description: 'Additional headers for this specific request'
+                    }
+                  },
+                  required: ['url']
+                },
                 keyword: {
                   type: 'string',
                   description: 'Search keyword (required for "search" action)'
@@ -840,6 +803,13 @@ class ProjectStandardsMCPServer {
                   },
                   required: ['headerName']
                 },
+                {
+                  properties: {
+                    action: { const: 'addApi' },
+                    api: { type: 'object' }
+                  },
+                  required: ['api']
+                },
                 {
                   properties: {
                     action: { const: 'search' },

package/src/utils/api_config.js

@@ -3,21 +3,22 @@ const { loadApiConfig, saveApiConfig } = require('./api_common');
 /**
  * API 配置工具 - 专门处理API配置管理
  * @param {Object} params - 参数
- * @param {string} params.action - 操作类型 ('get', 'set', 'updateBaseUrl', 'updateHeaders', 'deleteHeader', 'search', 'list')
+ * @param {string} params.action - 操作类型 ('get', 'set', 'updateBaseUrl', 'updateHeaders', 'deleteHeader', 'addApi', 'search', 'list')
  * @param {Object} params.config - API配置（set 时必需）
  * @param {string} params.baseUrl - 基础URL（updateBaseUrl 时必需）
  * @param {Object} params.headers - 请求头（updateHeaders 时必需）
  * @param {string} params.headerName - 要删除的请求头名称（deleteHeader 时必需）
+ * @param {Object} params.api - API配置（addApi 时必需）
  * @param {string} params.keyword - 搜索关键词（search 时必需）
  * @param {Object} config - 服务器配置
  * @param {Function} saveConfig - 保存配置函数
  * @returns {Object} API配置结果
  */
 async function api_config(params, config, saveConfig) {
-  const { action, config: apiConfig, baseUrl, headers, headerName, keyword } = params || {};
+  const { action, config: apiConfig, baseUrl, headers, headerName, api, keyword } = params || {};
   
   if (!action) {
-    throw new Error('Missing action parameter. Must be "get", "set", "updateBaseUrl", "updateHeaders", "deleteHeader", "search", or "list"');
+    throw new Error('Missing action parameter. Must be "get", "set", "updateBaseUrl", "updateHeaders", "deleteHeader", "addApi", "search", or "list"');
   }
   
   if (action === 'get') {
@@ -162,6 +163,53 @@ async function api_config(params, config, saveConfig) {
     } catch (err) {
       throw new Error(`Failed to delete header: ${err.message}`);
     }
+  } else if (action === 'addApi') {
+    if (!api || !api.url) {
+      throw new Error('Missing or invalid api parameter for addApi action. API must have url property');
+    }
+    
+    try {
+      const apiDebugConfig = loadApiConfig();
+      
+      if (!apiDebugConfig.list) {
+        apiDebugConfig.list = [];
+      }
+      
+      // 检查是否已存在相同URL的API
+      const existingIndex = apiDebugConfig.list.findIndex(item => item.url === api.url);
+      
+      if (existingIndex >= 0) {
+        // 更新现有API
+        apiDebugConfig.list[existingIndex] = { ...apiDebugConfig.list[existingIndex], ...api };
+        const saved = saveApiConfig(apiDebugConfig);
+        if (!saved) {
+          throw new Error('Failed to save API configuration');
+        }
+        
+        return {
+          success: true,
+          message: `Successfully updated existing API: ${api.url}`,
+          api: apiDebugConfig.list[existingIndex],
+          timestamp: new Date().toISOString()
+        };
+      } else {
+        // 添加新API
+        apiDebugConfig.list.push(api);
+        const saved = saveApiConfig(apiDebugConfig);
+        if (!saved) {
+          throw new Error('Failed to save API configuration');
+        }
+        
+        return {
+          success: true,
+          message: `Successfully added new API: ${api.url}`,
+          api: api,
+          timestamp: new Date().toISOString()
+        };
+      }
+    } catch (err) {
+      throw new Error(`Failed to add API: ${err.message}`);
+    }
   } else if (action === 'search') {
     if (!keyword) {
       throw new Error('Missing keyword parameter for search action');

package/src/utils/api_help.js

@@ -0,0 +1,182 @@
+/**
+ * API 帮助工具 - 返回API调试工具的详细说明和示例
+ * @param {Object} params - 参数
+ * @param {string} params.tool - 要查看的工具名称（可选，默认返回所有工具）
+ * @param {Object} config - 服务器配置
+ * @param {Function} saveConfig - 保存配置函数
+ * @returns {Object} 工具说明和示例
+ */
+async function api_help(params, config, saveConfig) {
+  const { tool } = params || {};
+  
+  const helpContent = {
+    api_debug: {
+      name: 'api_debug',
+      description: 'API调试工具 - 直接执行API请求',
+      usage: '直接传入URL和参数即可执行API请求，无需复杂的action参数',
+      supportedFormats: [
+        'JSON对象: {"username": "admin", "password": "123456"}',
+        '表单数据: "username=admin&password=123456"',
+        '纯文本: "Hello World"',
+        'XML: "<user><name>John</name><email>john@example.com</email></user>"',
+        'HTML: "<html><body>Content</body></html>"'
+      ],
+      autoContentTypeDetection: {
+        'JSON对象': 'application/json',
+        '表单数据': 'application/x-www-form-urlencoded',
+        'XML': 'application/xml',
+        'HTML': 'text/html',
+        '纯文本': 'text/plain'
+      },
+      examples: [
+        {
+          description: '简单GET请求',
+          request: {
+            url: '/api/users',
+            method: 'GET',
+            query: { page: 1, limit: 10 }
+          }
+        },
+        {
+          description: 'POST请求带JSON体',
+          request: {
+            url: '/api/login',
+            method: 'POST',
+            body: { username: 'admin', password: '123456' },
+            headers: { 'Content-Type': 'application/json' }
+          }
+        },
+        {
+          description: 'PUT请求带表单数据',
+          request: {
+            url: '/api/users/123',
+            method: 'PUT',
+            body: 'name=John&email=john@example.com',
+            contentType: 'application/x-www-form-urlencoded'
+          }
+        },
+        {
+          description: 'DELETE请求带认证',
+          request: {
+            url: '/api/users/123',
+            method: 'DELETE',
+            headers: { 'Authorization': 'Bearer token123' }
+          }
+        }
+      ],
+      bestPractices: [
+        '使用相对URL: /api/endpoint 而不是完整URL',
+        '通过api_config工具设置baseUrl',
+        '让工具自动检测内容类型，除非有特殊需求',
+        'GET请求使用query参数而不是body',
+        '通过headers参数设置认证信息'
+      ]
+    },
+    api_login: {
+      name: 'api_login',
+      description: 'API登录工具 - 使用环境变量进行登录认证',
+      usage: '无需参数，直接从环境变量获取登录信息',
+      environmentVariables: {
+        'API_DEBUG_LOGIN_URL': '登录接口URL（默认: /api/login）',
+        'API_DEBUG_LOGIN_METHOD': '登录请求方法（默认: POST）',
+        'API_DEBUG_LOGIN_BODY': '登录请求体模板（支持JSON和字符串格式）',
+        'API_DEBUG_LOGIN_DESCRIPTION': '登录接口描述'
+      },
+      features: [
+        '自动从环境变量获取登录配置',
+        '支持JSON和字符串格式的登录体',
+        '自动提取token并更新Authorization头',
+        '支持自定义baseUrl参数'
+      ],
+      examples: [
+        {
+          description: '基本登录（使用环境变量配置）',
+          request: {}
+        },
+        {
+          description: '指定baseUrl的登录',
+          request: {
+            baseUrl: 'https://api.example.com'
+          }
+        }
+      ]
+    },
+    api_config: {
+      name: 'api_config',
+      description: 'API配置管理工具 - 管理全局API配置',
+      usage: '使用action参数指定操作类型',
+      actions: {
+        'get': '获取当前配置',
+        'set': '设置完整配置',
+        'updateBaseUrl': '更新基础URL',
+        'updateHeaders': '更新请求头',
+        'deleteHeader': '删除指定请求头',
+        'addApi': '添加API端点',
+        'search': '搜索API',
+        'list': '列出所有API'
+      },
+      examples: [
+        {
+          description: '获取配置',
+          request: { action: 'get' }
+        },
+        {
+          description: '更新基础URL',
+          request: { 
+            action: 'updateBaseUrl', 
+            baseUrl: 'https://api.example.com' 
+          }
+        },
+        {
+          description: '更新请求头',
+          request: { 
+            action: 'updateHeaders', 
+            headers: { 'Authorization': 'Bearer token123' } 
+          }
+        },
+        {
+          description: '搜索API',
+          request: { 
+            action: 'search', 
+            keyword: 'user' 
+          }
+        },
+        {
+          description: '添加API端点',
+          request: { 
+            action: 'addApi', 
+            api: {
+              url: '/api/users',
+              method: 'GET',
+              description: '获取用户列表',
+              query: { page: 1, limit: 10 }
+            }
+          }
+        }
+      ]
+    }
+  };
+  
+  if (tool && helpContent[tool]) {
+    return {
+      success: true,
+      tool: helpContent[tool],
+      timestamp: new Date().toISOString()
+    };
+  } else {
+    return {
+      success: true,
+      message: 'API调试工具帮助文档',
+      tools: helpContent,
+      quickStart: {
+        '1. 设置配置': '使用 api_config 工具设置 baseUrl 和 headers',
+        '2. 登录认证': '使用 api_login 工具进行登录（如果需要）',
+        '3. 调试API': '使用 api_debug 工具执行API请求',
+        '4. 查看帮助': '使用 api_help 工具查看详细说明'
+      },
+      timestamp: new Date().toISOString()
+    };
+  }
+}
+
+module.exports = api_help;