@liangshanli/mcp-server-project-standards 2.1.10 → 3.0.0

package/README.md

@@ -4,6 +4,28 @@ A MCP (Model Context Protocol) server for project standards management, designed
 
 ## 📋 Version Updates
 
+### v3.0.0 (2025-10-31) - Major Release
+
+#### 🚀 Breaking Changes
+- Config directory resolution now depends on both `CONFIG_DIR` and `TOOL_PREFIX`:
+  - If `CONFIG_DIR` is set, it is used as-is
+  - If `CONFIG_DIR` is not set and `TOOL_PREFIX` is set, use `./.setting.<TOOL_PREFIX>`
+  - Otherwise default to `./.setting`
+- `tools/call` now strips the `TOOL_PREFIX` from tool names before method dispatch. If you call `xxx_api_debug` (with `TOOL_PREFIX=xxx`), the server routes the call to `api_debug` internally.
+
+#### ✨ New/Improved
+- Unified `getConfigDir()` used by both `server-final.js` and `api_common.js`
+- `tools/list` shows environment with resolved `CONFIG_DIR`
+- Prefixed tool names and project-branded descriptions when both `TOOL_PREFIX` and `PROJECT_NAME` are provided
+
+#### 🧹 Cleanup
+- Removed duplicate legacy `api_debug` method definition
+
+#### 💡 Benefits
+- Multi-project isolation: simple per-project segregation via `TOOL_PREFIX` without code changes
+- Zero-friction switching: swap project context by environment only
+- Smoother tool calling: clients can call prefixed names, server auto-routes
+
 ### v2.0.0 (2024-12-19) - Major Release
 
 #### 🚀 New Tools & Features
@@ -127,7 +149,9 @@ The server uses the `./.setting/` directory to store configuration files by defa
 
 | Variable | Default | Description | Example |
 |----------|---------|-------------|---------|
-| CONFIG_DIR | ./.setting | Configuration file directory (contains config.json and api.json) | `export CONFIG_DIR="./config"` |
+| CONFIG_DIR | ./.setting or ./.setting.<TOOL_PREFIX> | Configuration directory. If set, used as-is; else if TOOL_PREFIX set, uses ./.setting.<TOOL_PREFIX>; else ./.setting | `export CONFIG_DIR="./config"` |
+| TOOL_PREFIX |  | Optional tool prefix for tool names and config isolation | `export TOOL_PREFIX="projA"` |
+| PROJECT_NAME |  | Optional project branding for tool descriptions | `export PROJECT_NAME="MyProject"` |
 | API_DEBUG_ALLOWED_METHODS | GET | Control allowed request methods (supports: GET,POST,PUT,DELETE,PATCH, etc.) | `export API_DEBUG_ALLOWED_METHODS="GET,POST"` |
 | API_DEBUG_LOGIN_URL | /api/login | Set login API URL | `export API_DEBUG_LOGIN_URL="/api/auth/login"` |
 | API_DEBUG_LOGIN_METHOD | POST | Set login request method | `export API_DEBUG_LOGIN_METHOD="POST"` |
@@ -223,7 +247,9 @@ npm run dev
       "command": "npx",
       "args": ["@liangshanli/mcp-server-project-standards"],
       "env": {
-        "CONFIG_DIR": "./.setting",
+        "TOOL_PREFIX": "projA",
+        "PROJECT_NAME": "MyProject",
+        "CONFIG_DIR": "./.setting", 
         "API_DEBUG_ALLOWED_METHODS": "GET,POST,PUT,DELETE",
         "API_DEBUG_LOGIN_URL": "/api/login",
         "API_DEBUG_LOGIN_METHOD": "POST",
@@ -247,7 +273,9 @@ npm run dev
       "command": "npx",
       "args": ["@liangshanli/mcp-server-project-standards"],
       "env": {
-        "CONFIG_DIR": "./.setting",
+        "TOOL_PREFIX": "projA",
+        "PROJECT_NAME": "MyProject",
+        "CONFIG_DIR": "./.setting", 
         "API_DEBUG_ALLOWED_METHODS": "GET,POST,PUT,DELETE",
         "API_DEBUG_LOGIN_URL": "/api/login",
         "API_DEBUG_LOGIN_METHOD": "POST",

package/README.zh-CN.md

@@ -4,6 +4,27 @@
 
 ## 📋 版本更新说明
 
+### v3.0.0 (2025-10-31) - 重大更新
+
+#### 🚀 破坏性变更
+- 配置目录解析新增 `TOOL_PREFIX` 参与：
+  - 若设置了 `CONFIG_DIR`，优先使用该值
+  - 若未设置 `CONFIG_DIR` 且设置了 `TOOL_PREFIX`，使用 `./.setting.<TOOL_PREFIX>`
+  - 否则默认 `./.setting`
+- 在 `tools/call` 中，若工具名带有前缀（如 `xxx_api_debug` 且 `TOOL_PREFIX=xxx`），调用时会自动去除前缀，路由到真实方法（`api_debug`）。
+
+#### ✨ 新增 / 改进
+- 在 `server-final.js` 与 `api_common.js` 中统一使用 `getConfigDir()`
+- `tools/list` 环境信息展示最终生效的 `CONFIG_DIR`
+- 同时存在 `TOOL_PREFIX` 和 `PROJECT_NAME` 时，工具名自动加前缀、描述自动加项目名
+
+#### 🧹 清理
+- 移除了重复的旧版 `api_debug` 方法定义
+
+#### 💡 优势
+- 多项目隔离更简单：通过 `TOOL_PREFIX` 即可实现每项目独立配置，无需改代码
+- 切换零侵入：仅改环境变量即可切换项目上下文
+- 调用更顺滑：客户端可使用带前缀名，服务端自动剥前缀并精准路由
 ### v1.1.0 (2024-12-19)
 
 #### 🆕 新增功能
@@ -112,7 +133,9 @@ npm install
 
 | 变量名 | 默认值 | 描述 | 示例 |
 |--------|--------|------|------|
-| CONFIG_DIR | ./.setting | 配置文件目录（包含 config.json 和 api.json） | `export CONFIG_DIR="./config"` |
+| CONFIG_DIR | ./.setting 或 ./.setting.<TOOL_PREFIX> | 配置目录。若设置则直接使用；否则若设置了 TOOL_PREFIX 则使用 ./.setting.<TOOL_PREFIX>；否则 ./.setting | `export CONFIG_DIR="./config"` |
+| TOOL_PREFIX |  | 工具名前缀，同时用于多项目配置隔离 | `export TOOL_PREFIX="projA"` |
+| PROJECT_NAME |  | 工具描述前添加项目名称用于标识 | `export PROJECT_NAME="MyProject"` |
 | API_DEBUG_ALLOWED_METHODS | GET | 控制允许的请求方法（支持：GET,POST,PUT,DELETE,PATCH等） | `export API_DEBUG_ALLOWED_METHODS="GET,POST"` |
 | API_DEBUG_LOGIN_URL | /api/login | 设置登录接口 URL | `export API_DEBUG_LOGIN_URL="/api/auth/login"` |
 | API_DEBUG_LOGIN_METHOD | POST | 设置登录请求方法 | `export API_DEBUG_LOGIN_METHOD="POST"` |
@@ -208,6 +231,8 @@ npm run dev
       "command": "npx",
       "args": ["@liangshanli/mcp-server-project-standards"],
       "env": {
+        "TOOL_PREFIX": "projA",
+        "PROJECT_NAME": "MyProject",
         "CONFIG_DIR": "./.setting",
         "API_DEBUG_ALLOWED_METHODS": "GET,POST,PUT,DELETE",
         "API_DEBUG_LOGIN_URL": "/api/login",
@@ -232,6 +257,8 @@ npm run dev
       "command": "npx",
       "args": ["@liangshanli/mcp-server-project-standards"],
       "env": {
+        "TOOL_PREFIX": "projA",
+        "PROJECT_NAME": "MyProject",
         "CONFIG_DIR": "./.setting",
         "API_DEBUG_ALLOWED_METHODS": "GET,POST,PUT,DELETE",
         "API_DEBUG_LOGIN_URL": "/api/login",

package/bin/cli.js

@@ -27,16 +27,31 @@ let server = null;
 // Function to start server
 function startServer() {
   // Create environment object
+  // Determine CONFIG_DIR: use env var if set, otherwise use .setting with TOOL_PREFIX if available
+  let configDir = process.env.CONFIG_DIR;
+  if (!configDir) {
+    const toolPrefix = process.env.TOOL_PREFIX || '';
+    if (toolPrefix) {
+      configDir = `./.setting.${toolPrefix}`;
+    } else {
+      configDir = './.setting';
+    }
+  }
+  
   const env = {
     ...process.env,
-    // Set CONFIG_DIR if specified, otherwise use default
-    CONFIG_DIR: process.env.CONFIG_DIR || './.setting',
+    // Set CONFIG_DIR based on logic above
+    CONFIG_DIR: configDir,
     // API Debug environment variables
     API_DEBUG_ALLOWED_METHODS: process.env.API_DEBUG_ALLOWED_METHODS || 'GET',
     API_DEBUG_LOGIN_URL: process.env.API_DEBUG_LOGIN_URL || '/api/login',
     API_DEBUG_LOGIN_METHOD: process.env.API_DEBUG_LOGIN_METHOD || 'POST',
     API_DEBUG_LOGIN_BODY: process.env.API_DEBUG_LOGIN_BODY || '{"username":"","password":""}',
-    API_DEBUG_LOGIN_DESCRIPTION: process.env.API_DEBUG_LOGIN_DESCRIPTION || 'Save returned token to common headers in debug tool, field name Authorization, field value Bearer token'
+    API_DEBUG_LOGIN_DESCRIPTION: process.env.API_DEBUG_LOGIN_DESCRIPTION || 'Save returned token to common headers in debug tool, field name Authorization, field value Bearer token',
+    // Tool prefix for naming/identification
+    TOOL_PREFIX: process.env.TOOL_PREFIX || '',
+    // Project name for display/metadata
+    PROJECT_NAME: process.env.PROJECT_NAME || ''
   };
 
   // Convert allowed methods to uppercase if specified

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@liangshanli/mcp-server-project-standards",
-  "version": "2.1.10",
+  "version": "3.0.0",
   "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

@@ -13,9 +13,23 @@ const api_config = require('./utils/api_config');
 const api_help = require('./utils/api_help');
 const api_execute = require('./utils/api_execute');
 
+// Get config directory based on CONFIG_DIR and TOOL_PREFIX
+const getConfigDir = () => {
+  let configDir = process.env.CONFIG_DIR;
+  if (!configDir) {
+    const toolPrefix = process.env.TOOL_PREFIX || '';
+    if (toolPrefix) {
+      configDir = `./.setting.${toolPrefix}`;
+    } else {
+      configDir = './.setting';
+    }
+  }
+  return configDir;
+};
+
 // Get configuration from file or environment
 const getConfig = () => {
-  const configDir = process.env.CONFIG_DIR || './.setting';
+  const configDir = getConfigDir();
   const configPath = path.join(configDir, 'config.json');
 
   try {
@@ -33,7 +47,7 @@ const getConfig = () => {
 
 // Save configuration to file
 const saveConfig = (config) => {
-  const configDir = process.env.CONFIG_DIR || './.setting';
+  const configDir = getConfigDir();
   const configPath = path.join(configDir, 'config.json');
 
   try {
@@ -51,7 +65,7 @@ const saveConfig = (config) => {
 // 启动日志
 console.error('=== MCP Project Standards Server Starting ===');
 console.error(`Time: ${new Date().toISOString()}`);
-console.error(`Config Dir: ${process.env.CONFIG_DIR || './.setting'}`);
+console.error(`Config Dir: ${getConfigDir()}`);
 console.error('==============================================');
 
 // Final MCP Server
@@ -71,7 +85,7 @@ class ProjectStandardsMCPServer {
 
   // 创建默认配置文件
   createDefaultConfig() {
-    const configDir = process.env.CONFIG_DIR || './.setting';
+    const configDir = getConfigDir();
     const configPath = path.join(configDir, 'config.json');
 
     try {
@@ -153,16 +167,6 @@ class ProjectStandardsMCPServer {
     return result;
   }
 
-  // API debug tool (legacy)
-  async api_debug(params) {
-    const result = await api_debug(params, this.config, saveConfig);
-    // Update local config if action was 'set'
-    if (params?.action === 'set') {
-      this.config = getConfig();
-    }
-    return result;
-  }
-
   // API login tool
   async api_login(params) {
     const result = await api_login(params, this.config, saveConfig);
@@ -874,11 +878,24 @@ class ProjectStandardsMCPServer {
             }
           });
 
+          // Apply tool prefix and project name if both provided
+          const toolPrefix = process.env.TOOL_PREFIX || '';
+          const projectName = process.env.PROJECT_NAME || '';
+          let finalTools = tools;
+          if (toolPrefix && projectName) {
+            finalTools = tools.map(t => ({
+              ...t,
+              name: `${toolPrefix}_${t.name}`,
+              description: `${projectName} - ${t.description}`
+            }));
+          }
 
           result = {
-            tools: tools,
+            tools: finalTools,
             environment: {
-              CONFIG_DIR: process.env.CONFIG_DIR || './.setting',
+              CONFIG_DIR: getConfigDir(),
+              PROJECT_NAME: process.env.PROJECT_NAME || '',
+              TOOL_PREFIX: process.env.TOOL_PREFIX || '',
               serverInfo: {
                 name: this.name,
                 version: this.version
@@ -949,12 +966,19 @@ class ProjectStandardsMCPServer {
             throw new Error('Missing tool name');
           }
 
+          // Remove tool prefix if present
+          const toolPrefix = process.env.TOOL_PREFIX || '';
+          let actualToolName = name;
+          if (toolPrefix && name.startsWith(`${toolPrefix}_`)) {
+            actualToolName = name.substring(toolPrefix.length + 1);
+          }
+
           // Check if method exists
-          if (!this[name]) {
+          if (!this[actualToolName]) {
             throw new Error(`Unknown tool: ${name}`);
           }
 
-          result = await this[name](args || {});
+          result = await this[actualToolName](args || {});
 
           // Check if result has contentType (special format)
           if (result && result.contentType === "text") {

package/src/utils/api_common.js

@@ -1,9 +1,23 @@
 const fs = require('fs-extra');
 const path = require('path');
 
+// Get config directory based on CONFIG_DIR and TOOL_PREFIX
+const getConfigDir = () => {
+  let configDir = process.env.CONFIG_DIR;
+  if (!configDir) {
+    const toolPrefix = process.env.TOOL_PREFIX || '';
+    if (toolPrefix) {
+      configDir = `./.setting.${toolPrefix}`;
+    } else {
+      configDir = './.setting';
+    }
+  }
+  return configDir;
+};
+
 // Get API debug config file path
 const getApiConfigPath = () => {
-  const configDir = process.env.CONFIG_DIR || './.setting';
+  const configDir = getConfigDir();
   return path.join(configDir, 'api.json');
 };
 
@@ -30,7 +44,7 @@ const loadApiConfig = () => {
 
 // Save API debug config
 const saveApiConfig = (apiConfig) => {
-  const configDir = process.env.CONFIG_DIR || './.setting';
+  const configDir = getConfigDir();
   const apiConfigPath = path.join(configDir, 'api.json');
   
   try {
@@ -125,6 +139,7 @@ const detectContentType = (body) => {
 };
 
 module.exports = {
+  getConfigDir,
   getApiConfigPath,
   loadApiConfig,
   saveApiConfig,

package/src/utils/api_debug.js

@@ -37,33 +37,40 @@ const httpsAgent = new https.Agent({
 async function api_debug(params, config, saveConfig) {
   const { url, method = 'GET', headers = {}, query, body, contentType } = params || {};
   
+  // Resolve dynamic tool names based on prefix and project name
+  const toolPrefix = process.env.TOOL_PREFIX || '';
+  const projectName = process.env.PROJECT_NAME || '';
+  const hasCustomTools = !!(toolPrefix && projectName);
+  const configToolName = hasCustomTools ? `${toolPrefix}_api_config` : 'api_config';
+  const executeToolName = hasCustomTools ? `${toolPrefix}_api_execute` : 'api_execute';
+  
   if (!url) {
     return {
               contentType: "text",
               content: [
                 {
                   type: "text",
-                  text: "⚠️ IMPORTANT: You MUST use addApi to add the API to the list first! Use api_config tool.\n\n🔧 Step 1: Add API to Configuration (REQUIRED)\n\nCall: api_config with action=\"addApi\" and api={\"url\":\"${url}\",\"method\":\"${requestMethod}\",\"body\":\"your corrected JSON here\"}\n\n⚠️ REMINDER: You MUST use api_config with addApi to add the API to the list!"
+                  text: `⚠️ IMPORTANT: You MUST use addApi to add the API to the list first! Use ${configToolName} tool.\n\n🔧 Step 1: Add API to Configuration (REQUIRED)\n\nCall: ${configToolName} with action="addApi" and api={"url":"<your url>","method":"<METHOD>","body":"your corrected JSON here"}\n\n⚠️ REMINDER: You MUST use ${configToolName} with addApi to add the API to the list!`
                 },
                 {
                   type: "text",
-                  text: "🔧 Step 2: Execute API by Index\n\nAfter adding the API, call: api_execute with index=<returned index>\n\nThis will execute the pre-configured API with the correct format."
+                  text: `🔧 Step 2: Execute API by Index\n\nAfter adding the API, call: ${executeToolName} with index=<returned index>\n\nThis will execute the pre-configured API with the correct format.`
                 },
                 {
                   type: "text",
-                  text: "🚨 REMINDER: You MUST use addApi first!\n\n- Use api_config with action=\"addApi\" to add the API to the list\n- Then use api_execute with the returned index to execute"
+                  text: `🚨 REMINDER: You MUST use addApi first!\n\n- Use ${configToolName} with action="addApi" to add the API to the list\n- Then use ${executeToolName} with the returned index to execute`
                 },
                 {
                   type: "text",
-                  text: "💡 IMPORTANT: Remember to use addApi!\n\n- First: api_config with action=\"addApi\" to add the API\n- Second: api_execute with index to run the API"
+                  text: `💡 IMPORTANT: Remember to use addApi!\n\n- First: ${configToolName} with action="addApi" to add the API\n- Second: ${executeToolName} with index to run the API`
                 },
                 {
                   type: "text",
-                  text: "📋 Final Reminder: Use addApi → Then api_execute\n\n1. First: api_config with action=\"addApi\"\n2. Then: api_execute with index=<number>\n\nThis is the ONLY way to handle invalid JSON requests."
+                  text: `📋 Final Reminder: Use addApi → Then ${executeToolName}\n\n1. First: ${configToolName} with action="addApi"\n2. Then: ${executeToolName} with index=<number>\n\nThis is the ONLY way to handle invalid JSON requests.`
                 },
                 {
                   type: "text",
-                  text: "⚠️ ESSENTIAL: You MUST use addApi!\n\n- First: api_config with action=\"addApi\" to add the API\n- Second: api_execute with index to run the API"
+                  text: `⚠️ ESSENTIAL: You MUST use addApi!\n\n- First: ${configToolName} with action="addApi" to add the API\n- Second: ${executeToolName} with index to run the API`
                 }
               ]
             };
@@ -112,27 +119,27 @@ async function api_debug(params, config, saveConfig) {
               content: [
                 {
                   type: "text",
-                  text: "⚠️ IMPORTANT: You MUST use addApi to add the API to the list first! Use api_config tool.\n\n🔧 Step 1: Add API to Configuration (REQUIRED)\n\nCall: api_config with action=\"addApi\" and api={\"url\":\"${url}\",\"method\":\"${requestMethod}\",\"body\":\"your corrected JSON here\"}\n\n⚠️ REMINDER: You MUST use api_config with addApi to add the API to the list!"
+                  text: `⚠️ IMPORTANT: You MUST use addApi to add the API to the list first! Use ${configToolName} tool.\n\n🔧 Step 1: Add API to Configuration (REQUIRED)\n\nCall: ${configToolName} with action="addApi" and api={"url":"${url}","method":"${requestMethod}","body":"your corrected JSON here"}\n\n⚠️ REMINDER: You MUST use ${configToolName} with addApi to add the API to the list!`
                 },
                 {
                   type: "text",
-                  text: "🔧 Step 2: Execute API by Index\n\nAfter adding the API, call: api_execute with index=<returned index>\n\nThis will execute the pre-configured API with the correct format."
+                  text: `🔧 Step 2: Execute API by Index\n\nAfter adding the API, call: ${executeToolName} with index=<returned index>\n\nThis will execute the pre-configured API with the correct format.`
                 },
                 {
                   type: "text",
-                  text: "🚨 REMINDER: You MUST use addApi first!\n\n- Use api_config with action=\"addApi\" to add the API to the list\n- Then use api_execute with the returned index to execute"
+                  text: `🚨 REMINDER: You MUST use addApi first!\n\n- Use ${configToolName} with action="addApi" to add the API to the list\n- Then use ${executeToolName} with the returned index to execute`
                 },
                 {
                   type: "text",
-                  text: "💡 IMPORTANT: Remember to use addApi!\n\n- First: api_config with action=\"addApi\" to add the API\n- Second: api_execute with index to run the API"
+                  text: `💡 IMPORTANT: Remember to use addApi!\n\n- First: ${configToolName} with action="addApi" to add the API\n- Second: ${executeToolName} with index to run the API`
                 },
                 {
                   type: "text",
-                  text: "📋 Final Reminder: Use addApi → Then api_execute\n\n1. First: api_config with action=\"addApi\"\n2. Then: api_execute with index=<number>\n\nThis is the ONLY way to handle invalid JSON requests."
+                  text: `📋 Final Reminder: Use addApi → Then ${executeToolName}\n\n1. First: ${configToolName} with action="addApi"\n2. Then: ${executeToolName} with index=<number>\n\nThis is the ONLY way to handle invalid JSON requests.`
                 },
                 {
                   type: "text",
-                  text: "⚠️ ESSENTIAL: You MUST use addApi!\n\n- First: api_config with action=\"addApi\" to add the API\n- Second: api_execute with index to run the API"
+                  text: `⚠️ ESSENTIAL: You MUST use addApi!\n\n- First: ${configToolName} with action="addApi" to add the API\n- Second: ${executeToolName} with index to run the API`
                 }
               ]
             };