@aipper/zentao-mcp-server 0.1.7 → 0.1.8

package/.env.example

@@ -11,6 +11,12 @@ ZENTAO_PASSWORD=your_password
 # 可选：默认产品 ID（当实例请求 bug 列表需要 product id 时使用）
 # ZENTAO_PRODUCT_ID=1
 
+# 可选：我的 bug 列表路径（例如 /my/bug 或 /my/bugs）
+# ZENTAO_MY_BUGS_PATH=/my/bug
+
+# 可选：bug 列表回退路径（逗号分隔）
+# ZENTAO_BUGS_FALLBACK_PATHS=/my/bug,/my/bugs
+
 # 获取 Token 的路径（相对 ZENTAO_BASE_URL；通常为 /api.php/v1/tokens）
 ZENTAO_TOKEN_PATH=/api.php/v1/tokens
 

package/README.md

@@ -17,6 +17,8 @@
 - `ZENTAO_ACCOUNT`
 - `ZENTAO_PASSWORD`
 - （可选）`ZENTAO_PRODUCT_ID`：你的禅道实例若报 `Need product id` 时设置
+- （可选）`ZENTAO_MY_BUGS_PATH`：我的 bug 专用接口路径（如 `/my/bug`）
+- （可选）`ZENTAO_BUGS_FALLBACK_PATHS`：bug 列表回退路径（逗号分隔）
 
 > 注意：不同禅道版本/部署方式的 token 端点与返回结构可能不同；可通过 `ZENTAO_TOKEN_PATH`/`ZENTAO_API_PREFIX` 调整。
 >
@@ -88,6 +90,7 @@ npm run smoke
 `-32000` 通常是客户端侧“通用 MCP 调用失败”映射码，优先检查：
 - `env` 是否完整传入（尤其是 `ZENTAO_BASE_URL`/`ZENTAO_ACCOUNT`/`ZENTAO_PASSWORD`）。
 - 若报 `Need product id`，请设置 `ZENTAO_PRODUCT_ID`，或在 `get_my_bugs` 传 `productId`。
+- 若你的 bug 在“项目集/我的视角”而非产品，建议设置 `ZENTAO_MY_BUGS_PATH=/my/bug`（或 `/my/bugs`）。
 - `ZENTAO_API_PREFIX`/`ZENTAO_TOKEN_PATH` 是否和你的禅道实例一致。
 - MCP 客户端是否真的在执行 `npx -y @aipper/zentao-mcp-server`（而不是旧的本地命令）。
 - 客户端日志中是否有启动报错（如找不到命令、401、超时）。
@@ -99,16 +102,22 @@ npm run smoke
 - `get_my_bugs`：获取“指派给我”的 bug（支持 `status`/`keyword`/`limit`/`page`/`productId`，默认路径 `/bugs`）
 - `get_bug_detail`：按 `id` 获取 bug 详情（默认路径模板 `/bugs/{id}`，返回详情与图片链接）
 - `resolve_bug`：按 `id` 处理单个 bug 状态（默认 `resolution=fixed`）
+- `resolve_bug`：按 `id` 处理单个 bug 状态（默认 `resolution=fixed`，支持 `solution` 解决说明）
 - `batch_resolve_my_bugs`：批量处理“我的 bug”（默认筛选 `status=active`，支持 `productId`）
 - `close_bug`：按 `id` 关闭 bug
 - `verify_bug`：验证结果处理（`pass`=关闭，`fail`=激活）
+- `comment_bug`：按 `id` 添加备注（默认路径 `/bugs/{id}/comment`）
 
 示例参数：
 - `resolve_bug`：`{"id":123,"resolution":"fixed","comment":"已修复并自测"}`
+- `resolve_bug`（建议）：`{"id":123,"resolution":"fixed","solution":"修复空指针并补充参数校验"}`
 - `batch_resolve_my_bugs`：`{"status":"active","maxItems":20,"comment":"批量修复"}`
+- `batch_resolve_my_bugs`（建议）：`{"status":"active","maxItems":20,"solution":"统一修复分页参数为空导致的报错"}`
 - `get_my_bugs`（按产品）：`{"status":"active","productId":1,"limit":50}`
+- `get_my_bugs`（项目集/我的）：`{"status":"active","path":"/my/bug","limit":50}`
 - `close_bug`：`{"id":123,"comment":"验证通过，关闭"}`
 - `verify_bug`：`{"id":123,"result":"pass","comment":"验证通过"}`
+- `comment_bug`：`{"id":123,"comment":"已复现，正在定位根因"}`
 
 ## 安全建议
 - 使用最小权限账号（仅需要的项目权限），避免使用管理员账号。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aipper/zentao-mcp-server",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "private": false,
   "type": "module",
   "description": "A minimal MCP server for ZenTao (token + generic REST call + a few helper tools).",

package/src/index.js

@@ -18,6 +18,7 @@ const KNOWN_TOOL_NAMES = new Set([
   "batch_resolve_my_bugs",
   "close_bug",
   "verify_bug",
+  "comment_bug",
 ]);
 
 function normalizeToolName(rawName) {
@@ -49,6 +50,11 @@ function getConfigFromEnv() {
   const timeoutMs = Number(process.env.ZENTAO_HTTP_TIMEOUT_MS || "30000");
   const exposeToken = String(process.env.ZENTAO_EXPOSE_TOKEN || "false").toLowerCase() === "true";
   const defaultProductId = Number(process.env.ZENTAO_PRODUCT_ID || "0") || null;
+  const myBugsPath = String(process.env.ZENTAO_MY_BUGS_PATH || "").trim();
+  const bugsFallbackPaths = String(process.env.ZENTAO_BUGS_FALLBACK_PATHS || "")
+    .split(",")
+    .map((value) => value.trim())
+    .filter(Boolean);
 
   const account = requireEnv("ZENTAO_ACCOUNT");
   const password = requireEnv("ZENTAO_PASSWORD");
@@ -61,6 +67,8 @@ function getConfigFromEnv() {
     timeoutMs,
     exposeToken,
     defaultProductId,
+    myBugsPath,
+    bugsFallbackPaths,
     auth: { account, password },
   };
 }
@@ -134,6 +142,7 @@ async function main() {
         const resp = await zentao.resolveBug({
           id: args.id,
           resolution: args.resolution || "fixed",
+          solution: args.solution || "",
           comment: args.comment || "",
           path: args.path || "/bugs/{id}/resolve",
         });
@@ -150,6 +159,7 @@ async function main() {
           maxItems: args.maxItems,
           assignedTo: args.assignedTo || "",
           resolution: args.resolution || "fixed",
+          solution: args.solution || "",
           comment: args.comment || "",
           listPath: args.listPath || "/bugs",
           resolvePath: args.resolvePath || "/bugs/{id}/resolve",
@@ -178,6 +188,15 @@ async function main() {
         return toMcpTextResult(JSON.stringify(resp, null, 2));
       }
 
+      if (toolName === "comment_bug") {
+        const resp = await zentao.commentBug({
+          id: args.id,
+          comment: args.comment || "",
+          path: args.path || "/bugs/{id}/comment",
+        });
+        return toMcpTextResult(JSON.stringify(resp, null, 2));
+      }
+
       throw new Error(`Unknown tool: ${rawToolName}`);
     } catch (err) {
       const errorPayload = {

package/src/tools.js

@@ -80,6 +80,7 @@ export const TOOLS = [
       properties: {
         id: { type: "number", minimum: 1, description: "Bug ID" },
         resolution: { type: "string", description: "Default fixed" },
+        solution: { type: "string", description: "Resolution description (preferred)" },
         comment: { type: "string", description: "Optional resolve comment" },
         path: { type: "string", description: "Optional resolve endpoint template, default /bugs/{id}/resolve" },
       },
@@ -101,6 +102,7 @@ export const TOOLS = [
         maxItems: { type: "number", minimum: 1, maximum: 500, description: "Max resolve count, default 50" },
         assignedTo: { type: "string", description: "Optional assignee override" },
         resolution: { type: "string", description: "Default fixed" },
+        solution: { type: "string", description: "Resolution description (preferred)" },
         comment: { type: "string", description: "Optional resolve comment" },
         listPath: { type: "string", description: "Optional list endpoint, default /bugs" },
         resolvePath: { type: "string", description: "Optional resolve path template, default /bugs/{id}/resolve" },
@@ -139,6 +141,20 @@ export const TOOLS = [
       additionalProperties: false,
     },
   },
+  {
+    name: "comment_bug",
+    description: "Add comment to one bug by ID.",
+    inputSchema: {
+      type: "object",
+      properties: {
+        id: { type: "number", minimum: 1, description: "Bug ID" },
+        comment: { type: "string", description: "Comment content" },
+        path: { type: "string", description: "Optional comment endpoint template, default /bugs/{id}/comment" },
+      },
+      required: ["id", "comment"],
+      additionalProperties: false,
+    },
+  },
 ];
 
 export function assertToolArgs(name, args) {
@@ -176,6 +192,9 @@ export function assertToolArgs(name, args) {
     if (args.path !== undefined && typeof args.path !== "string") {
       throw new Error("resolve_bug.path must be a string");
     }
+    if (args.solution !== undefined && typeof args.solution !== "string") {
+      throw new Error("resolve_bug.solution must be a string");
+    }
   }
   if (name === "batch_resolve_my_bugs") {
     if (args.limit !== undefined && (!Number.isFinite(args.limit) || args.limit < 1 || args.limit > 200)) {
@@ -196,6 +215,9 @@ export function assertToolArgs(name, args) {
     if (args.resolvePath !== undefined && typeof args.resolvePath !== "string") {
       throw new Error("batch_resolve_my_bugs.resolvePath must be a string");
     }
+    if (args.solution !== undefined && typeof args.solution !== "string") {
+      throw new Error("batch_resolve_my_bugs.solution must be a string");
+    }
   }
   if (name === "close_bug") {
     if (!Number.isFinite(args.id) || Number(args.id) < 1) {
@@ -222,4 +244,15 @@ export function assertToolArgs(name, args) {
       throw new Error("verify_bug.activatePath must be a string");
     }
   }
+  if (name === "comment_bug") {
+    if (!Number.isFinite(args.id) || Number(args.id) < 1) {
+      throw new Error("comment_bug.id must be a number >= 1");
+    }
+    if (typeof args.comment !== "string" || !args.comment.trim()) {
+      throw new Error("comment_bug.comment must be a non-empty string");
+    }
+    if (args.path !== undefined && typeof args.path !== "string") {
+      throw new Error("comment_bug.path must be a string");
+    }
+  }
 }

package/src/zentao.js

@@ -31,7 +31,17 @@ function createAbortSignal(timeoutMs) {
 }
 
 export function createZenTaoClient(config) {
-  const { baseUrl, apiPrefix, tokenPath, tokenTtlMs, timeoutMs, defaultProductId, auth } = config;
+  const {
+    baseUrl,
+    apiPrefix,
+    tokenPath,
+    tokenTtlMs,
+    timeoutMs,
+    defaultProductId,
+    myBugsPath,
+    bugsFallbackPaths,
+    auth,
+  } = config;
 
   let cachedToken = "";
   let cachedAt = 0;
@@ -193,11 +203,25 @@ export function createZenTaoClient(config) {
     return basePath;
   }
 
+  function buildMyBugsPath(pathTemplate) {
+    const template = String(pathTemplate || "").trim();
+    if (!template) return "";
+    return template.replaceAll("{account}", encodeURIComponent(auth.account || ""));
+  }
+
   function isNeedProductIdError(err) {
     const merged = `${String(err?.message || "")} ${JSON.stringify(err?.data || "")}`.toLowerCase();
     return merged.includes("need product id");
   }
 
+  function buildResolutionComment({ solution, comment, resolution }) {
+    const normalizedSolution = String(solution || "").trim();
+    if (normalizedSolution) return `解决说明：${normalizedSolution}`;
+    const normalizedComment = String(comment || "").trim();
+    if (normalizedComment) return normalizedComment;
+    return `已处理，resolution=${String(resolution || "fixed")}`;
+  }
+
   function getBugAssignee(bug) {
     return (
       bug?.assignedTo ||
@@ -256,6 +280,16 @@ export function createZenTaoClient(config) {
     return buildBugTransitionPath({ id, path, action: "resolve" });
   }
 
+  function buildBugCommentPath({ id, path }) {
+    const normalizedId = Number(id);
+    const basePath = path || "/bugs/{id}/comment";
+    if (basePath.includes("{id}")) {
+      return basePath.replaceAll("{id}", String(normalizedId));
+    }
+    const trimmed = basePath.replace(/\/+$/, "");
+    return `${trimmed}/${normalizedId}/comment`;
+  }
+
   function buildBugTransitionPath({ id, path, action }) {
     const normalizedId = Number(id);
     const safeAction = String(action || "").trim();
@@ -313,6 +347,11 @@ export function createZenTaoClient(config) {
     const assignee = normalizeString(assignedTo) || normalizeString(auth.account);
     const effectiveProductId = normalizePositiveInt(productId) || normalizePositiveInt(defaultProductId);
     const primaryPath = buildProductScopedBugsPath({ productId: effectiveProductId, path });
+    const configuredMyBugsPath = buildMyBugsPath(myBugsPath);
+    const fallbackPathCandidates = (bugsFallbackPaths && bugsFallbackPaths.length > 0)
+      ? bugsFallbackPaths
+      : ["/my/bug", "/my/bugs"];
+    const fallbackPaths = fallbackPathCandidates.map((item) => buildMyBugsPath(item)).filter(Boolean);
 
     const query = {
       limit: safeLimit,
@@ -321,21 +360,34 @@ export function createZenTaoClient(config) {
       status: status || undefined,
       product: effectiveProductId || undefined,
     };
-    let resp;
-    try {
-      resp = await call({ path: primaryPath, method: "GET", query });
-    } catch (err) {
-      const fallbackPath = effectiveProductId ? `/products/${effectiveProductId}/bugs` : null;
-      if (
-        fallbackPath &&
-        primaryPath !== fallbackPath &&
-        isNeedProductIdError(err)
-      ) {
-        resp = await call({ path: fallbackPath, method: "GET", query: { limit: safeLimit, page: safePage } });
-      } else {
-        throw err;
+    const candidatePaths = [];
+    candidatePaths.push(primaryPath);
+    if (effectiveProductId) {
+      const productPath = `/products/${effectiveProductId}/bugs`;
+      if (!candidatePaths.includes(productPath)) candidatePaths.push(productPath);
+    }
+    if (configuredMyBugsPath && !candidatePaths.includes(configuredMyBugsPath)) {
+      candidatePaths.push(configuredMyBugsPath);
+    }
+    for (const fallback of fallbackPaths) {
+      if (!candidatePaths.includes(fallback)) candidatePaths.push(fallback);
+    }
+
+    let resp = null;
+    let usedPath = primaryPath;
+    let lastErr = null;
+    for (const candidate of candidatePaths) {
+      try {
+        usedPath = candidate;
+        resp = await call({ path: candidate, method: "GET", query });
+        break;
+      } catch (err) {
+        lastErr = err;
+        if (!isNeedProductIdError(err)) continue;
+        if (candidate !== primaryPath) continue;
       }
     }
+    if (!resp) throw lastErr;
 
     const bugs = parseBugsFromResponse(resp?.data);
     const filtered = bugs.filter((bug) => matchesBugFilters(bug, { status, keyword, assignee }));
@@ -348,7 +400,7 @@ export function createZenTaoClient(config) {
       productId: effectiveProductId,
       assignedTo: assignee,
       bugs: filtered,
-      raw: { status: resp?.status, path: primaryPath },
+      raw: { status: resp?.status, path: usedPath },
     };
   }
 
@@ -379,21 +431,33 @@ export function createZenTaoClient(config) {
     };
   }
 
-  async function resolveBug({ id, resolution = "fixed", comment = "", path = "/bugs/{id}/resolve" } = {}) {
+  async function resolveBug({
+    id,
+    resolution = "fixed",
+    solution = "",
+    comment = "",
+    path = "/bugs/{id}/resolve",
+  } = {}) {
     const bugId = Number(id);
     if (!Number.isFinite(bugId) || bugId < 1) {
       throw new Error("resolveBug requires a valid bug id");
     }
 
     const resolvePath = buildBugResolvePath({ id: bugId, path });
-    const body = { resolution: String(resolution || "fixed") };
-    if (comment) body.comment = String(comment);
+    const resolvedValue = String(resolution || "fixed");
+    const resolvedComment = buildResolutionComment({ solution, comment, resolution: resolvedValue });
+    const body = {
+      resolution: resolvedValue,
+      comment: resolvedComment,
+    };
 
     const resp = await call({ path: resolvePath, method: "POST", body });
     return {
       id: bugId,
       resolved: true,
-      resolution: body.resolution,
+      resolution: resolvedValue,
+      solution: String(solution || "").trim(),
+      comment: resolvedComment,
       raw: { status: resp.status, data: resp.data },
     };
   }
@@ -467,6 +531,41 @@ export function createZenTaoClient(config) {
     };
   }
 
+  async function commentBug({ id, comment, path = "/bugs/{id}/comment" } = {}) {
+    const bugId = Number(id);
+    if (!Number.isFinite(bugId) || bugId < 1) {
+      throw new Error("commentBug requires a valid bug id");
+    }
+    const text = String(comment || "").trim();
+    if (!text) {
+      throw new Error("commentBug requires non-empty comment");
+    }
+
+    const primaryPath = buildBugCommentPath({ id: bugId, path });
+    const body = { comment: text };
+    try {
+      const resp = await call({ path: primaryPath, method: "POST", body });
+      return {
+        id: bugId,
+        commented: true,
+        comment: text,
+        raw: { status: resp.status, path: primaryPath, data: resp.data },
+      };
+    } catch (err) {
+      const fallbackPath = primaryPath.replace(/\/comment$/, "/comments");
+      if (fallbackPath !== primaryPath && Number(err?.status) === 404) {
+        const resp = await call({ path: fallbackPath, method: "POST", body });
+        return {
+          id: bugId,
+          commented: true,
+          comment: text,
+          raw: { status: resp.status, path: fallbackPath, data: resp.data },
+        };
+      }
+      throw err;
+    }
+  }
+
   async function batchResolveMyBugs({
     status = "active",
     keyword = "",
@@ -476,6 +575,7 @@ export function createZenTaoClient(config) {
     maxItems = 50,
     assignedTo = "",
     resolution = "fixed",
+    solution = "",
     comment = "",
     listPath = "/bugs",
     resolvePath = "/bugs/{id}/resolve",
@@ -507,6 +607,7 @@ export function createZenTaoClient(config) {
         const result = await resolveBug({
           id: bugId,
           resolution,
+          solution,
           comment,
           path: resolvePath,
         });
@@ -552,6 +653,7 @@ export function createZenTaoClient(config) {
     resolveBug,
     closeBug,
     verifyBug,
+    commentBug,
     batchResolveMyBugs,
   };
 }