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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@liangshanli/mcp-server-project-standards",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "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,10 +631,26 @@ 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: {

package/src/utils/api_help.js

@@ -0,0 +1,169 @@
+/**
+ * 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': '删除指定请求头',
+        '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' 
+          }
+        }
+      ]
+    }
+  };
+  
+  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;