@aipper/zentao-mcp-server 0.1.10 → 0.1.12

package/src/tools.js

@@ -8,6 +8,8 @@ export function toMcpTextResult(text, options = {}) {
   };
 }
 
+const SAFE_BUG_LIST_PATHS = new Set(["/bugs", "/my/bug", "/my/bugs"]);
+
 export const TOOLS = [
   {
     name: "get_token",
@@ -18,24 +20,9 @@ export const TOOLS = [
       additionalProperties: false,
     },
   },
-  {
-    name: "call",
-    description: "Call ZenTao REST API v1 path with Token header.",
-    inputSchema: {
-      type: "object",
-      properties: {
-        path: { type: "string", minLength: 1, description: "API path, e.g. /projects or bugs/123" },
-        method: { type: "string", description: "GET/POST/PUT/DELETE..." },
-        query: { type: "object", additionalProperties: true },
-        body: {},
-      },
-      required: ["path"],
-      additionalProperties: false,
-    },
-  },
   {
     name: "list_my_projects",
-    description: "List projects I participate in (heuristic filtering).",
+    description: "List projects I participate in (heuristic filtering). Not reliable for project-set-only bugs when the project set has no concrete projects.",
     inputSchema: {
       type: "object",
       properties: { keyword: { type: "string" } },
@@ -44,7 +31,8 @@ export const TOOLS = [
   },
   {
     name: "get_my_bugs",
-    description: "List bugs assigned to me (supports status/keyword/limit/page filter).",
+    description:
+      "List bugs assigned to me (supports status/keyword/limit/page filter). For project-set scope, prefer projectSetId or /my/bug instead of relying on list_my_projects.",
     inputSchema: {
       type: "object",
       properties: {
@@ -53,9 +41,15 @@ export const TOOLS = [
         limit: { type: "number", minimum: 1, maximum: 200, description: "Default 20, max 200" },
         page: { type: "number", minimum: 1, description: "Default 1" },
         productId: { type: "number", minimum: 1, description: "Optional product id (for instances requiring product scope)" },
-        projectSetId: { type: "number", minimum: 1, description: "Optional project-set id (for project-set scope)" },
-        path: { type: "string", description: "Optional bugs endpoint override, default /bugs" },
-        assignedTo: { type: "string", description: "Optional assignee override, default current account" },
+        projectSetId: {
+          type: "number",
+          minimum: 1,
+          description: "Optional project-set id. Prefer this when bugs are under project-set scope, especially if no concrete project exists.",
+        },
+        path: {
+          type: "string",
+          description: "Optional safe list path override. Allowed values: /bugs, /my/bug, /my/bugs.",
+        },
       },
       additionalProperties: false,
     },
@@ -67,7 +61,6 @@ export const TOOLS = [
       type: "object",
       properties: {
         id: { type: "number", minimum: 1, description: "Bug ID" },
-        path: { type: "string", description: "Optional detail endpoint template, default /bugs/{id}" },
       },
       required: ["id"],
       additionalProperties: false,
@@ -75,15 +68,21 @@ export const TOOLS = [
   },
   {
     name: "resolve_bug",
-    description: "Resolve one bug by ID (default resolution=fixed).",
+    description: "Resolve one bug by ID (default resolution=fixed). Prefer a solution that explains root cause, fix approach, and logic changes.",
     inputSchema: {
       type: "object",
       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" },
+        solution: {
+          type: "string",
+          description:
+            "Preferred. Describe the fix idea, changed logic, and affected behavior. Avoid Evidence/Verify labels, file paths, and compile/test commands.",
+        },
+        comment: {
+          type: "string",
+          description: "Optional resolve comment. If used for bug updates, prefer change summary over build/test proof.",
+        },
       },
       required: ["id"],
       additionalProperties: false,
@@ -91,7 +90,8 @@ export const TOOLS = [
   },
   {
     name: "batch_resolve_my_bugs",
-    description: "Batch resolve my bugs (default status=active, resolution=fixed).",
+    description:
+      "Batch resolve my bugs (default status=active, resolution=fixed). Prefer projectSetId or /my/bug for project-set scope, and use a shared solution that explains the common root cause and logic changes.",
     inputSchema: {
       type: "object",
       properties: {
@@ -100,15 +100,27 @@ export const TOOLS = [
         limit: { type: "number", minimum: 1, maximum: 200, description: "List page size, default 50" },
         page: { type: "number", minimum: 1, description: "Default 1" },
         productId: { type: "number", minimum: 1, description: "Optional product id (for instances requiring product scope)" },
-        projectSetId: { type: "number", minimum: 1, description: "Optional project-set id (for project-set scope)" },
-        maxItems: { type: "number", minimum: 1, maximum: 500, description: "Max resolve count, default 50" },
-        assignedTo: { type: "string", description: "Optional assignee override" },
+        projectSetId: {
+          type: "number",
+          minimum: 1,
+          description: "Optional project-set id. Prefer this for project-set bugs, especially when the project set has no concrete project entries.",
+        },
+        maxItems: { type: "number", minimum: 1, maximum: 100, description: "Max resolve count, default 20" },
         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" },
-        stopOnError: { type: "boolean", description: "Default false; stop on first resolve failure" },
+        solution: {
+          type: "string",
+          description:
+            "Preferred. Summarize the shared fix approach and changed logic. Avoid Evidence/Verify labels, file paths, and compile/test commands.",
+        },
+        comment: {
+          type: "string",
+          description: "Optional resolve comment. Prefer business-facing change summary over proof-style output.",
+        },
+        path: {
+          type: "string",
+          description: "Optional safe list path override. Allowed values: /bugs, /my/bug, /my/bugs.",
+        },
+        stopOnError: { type: "boolean", description: "Default true; stop on first resolve failure" },
       },
       additionalProperties: false,
     },
@@ -121,7 +133,6 @@ export const TOOLS = [
       properties: {
         id: { type: "number", minimum: 1, description: "Bug ID" },
         comment: { type: "string", description: "Optional close comment" },
-        path: { type: "string", description: "Optional close endpoint template, default /bugs/{id}/close" },
       },
       required: ["id"],
       additionalProperties: false,
@@ -136,8 +147,6 @@ export const TOOLS = [
         id: { type: "number", minimum: 1, description: "Bug ID" },
         result: { type: "string", description: "pass or fail, default pass" },
         comment: { type: "string", description: "Optional verification comment" },
-        closePath: { type: "string", description: "Optional close endpoint template, default /bugs/{id}/close" },
-        activatePath: { type: "string", description: "Optional activate endpoint template, default /bugs/{id}/activate" },
       },
       required: ["id"],
       additionalProperties: false,
@@ -145,13 +154,16 @@ export const TOOLS = [
   },
   {
     name: "comment_bug",
-    description: "Add comment to one bug by ID.",
+    description: "Add comment to one bug by ID. For solution updates, explain analysis and logic changes rather than build/test evidence.",
     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" },
+        comment: {
+          type: "string",
+          description:
+            "Comment content. For bug handling, prefer root cause, fix idea, and changed logic; avoid Evidence/Verify labels, file paths, and compile/test commands.",
+        },
       },
       required: ["id", "comment"],
       additionalProperties: false,
@@ -162,9 +174,6 @@ export const TOOLS = [
 export function assertToolArgs(name, args) {
   if (args == null) return;
   if (typeof args !== "object") throw new Error(`Invalid arguments for ${name}: expected object`);
-  if (name === "call" && typeof args.path !== "string") {
-    throw new Error("call.path must be a string");
-  }
   if (name === "get_my_bugs") {
     if (args.limit !== undefined && (!Number.isFinite(args.limit) || args.limit < 1 || args.limit > 200)) {
       throw new Error("get_my_bugs.limit must be a number between 1 and 200");
@@ -172,8 +181,14 @@ export function assertToolArgs(name, args) {
     if (args.page !== undefined && (!Number.isFinite(args.page) || args.page < 1)) {
       throw new Error("get_my_bugs.page must be a number >= 1");
     }
-    if (args.path !== undefined && typeof args.path !== "string") {
-      throw new Error("get_my_bugs.path must be a string");
+    if (args.path !== undefined) {
+      if (typeof args.path !== "string") throw new Error("get_my_bugs.path must be a string");
+      if (!SAFE_BUG_LIST_PATHS.has(args.path)) {
+        throw new Error("get_my_bugs.path must be one of /bugs, /my/bug, /my/bugs");
+      }
+    }
+    if (args.assignedTo !== undefined) {
+      throw new Error("get_my_bugs.assignedTo is no longer supported");
     }
     if (args.productId !== undefined && (!Number.isFinite(args.productId) || args.productId < 1)) {
       throw new Error("get_my_bugs.productId must be a number >= 1");
@@ -186,16 +201,16 @@ export function assertToolArgs(name, args) {
     if (!Number.isFinite(args.id) || Number(args.id) < 1) {
       throw new Error("get_bug_detail.id must be a number >= 1");
     }
-    if (args.path !== undefined && typeof args.path !== "string") {
-      throw new Error("get_bug_detail.path must be a string");
+    if (args.path !== undefined) {
+      throw new Error("get_bug_detail.path is no longer supported");
     }
   }
   if (name === "resolve_bug") {
     if (!Number.isFinite(args.id) || Number(args.id) < 1) {
       throw new Error("resolve_bug.id must be a number >= 1");
     }
-    if (args.path !== undefined && typeof args.path !== "string") {
-      throw new Error("resolve_bug.path must be a string");
+    if (args.path !== undefined) {
+      throw new Error("resolve_bug.path is no longer supported");
     }
     if (args.solution !== undefined && typeof args.solution !== "string") {
       throw new Error("resolve_bug.solution must be a string");
@@ -208,8 +223,8 @@ export function assertToolArgs(name, args) {
     if (args.page !== undefined && (!Number.isFinite(args.page) || args.page < 1)) {
       throw new Error("batch_resolve_my_bugs.page must be a number >= 1");
     }
-    if (args.maxItems !== undefined && (!Number.isFinite(args.maxItems) || args.maxItems < 1 || args.maxItems > 500)) {
-      throw new Error("batch_resolve_my_bugs.maxItems must be a number between 1 and 500");
+    if (args.maxItems !== undefined && (!Number.isFinite(args.maxItems) || args.maxItems < 1 || args.maxItems > 100)) {
+      throw new Error("batch_resolve_my_bugs.maxItems must be a number between 1 and 100");
     }
     if (args.productId !== undefined && (!Number.isFinite(args.productId) || args.productId < 1)) {
       throw new Error("batch_resolve_my_bugs.productId must be a number >= 1");
@@ -217,11 +232,17 @@ export function assertToolArgs(name, args) {
     if (args.projectSetId !== undefined && (!Number.isFinite(args.projectSetId) || args.projectSetId < 1)) {
       throw new Error("batch_resolve_my_bugs.projectSetId must be a number >= 1");
     }
-    if (args.listPath !== undefined && typeof args.listPath !== "string") {
-      throw new Error("batch_resolve_my_bugs.listPath must be a string");
+    if (args.path !== undefined) {
+      if (typeof args.path !== "string") throw new Error("batch_resolve_my_bugs.path must be a string");
+      if (!SAFE_BUG_LIST_PATHS.has(args.path)) {
+        throw new Error("batch_resolve_my_bugs.path must be one of /bugs, /my/bug, /my/bugs");
+      }
+    }
+    if (args.assignedTo !== undefined) {
+      throw new Error("batch_resolve_my_bugs.assignedTo is no longer supported");
     }
-    if (args.resolvePath !== undefined && typeof args.resolvePath !== "string") {
-      throw new Error("batch_resolve_my_bugs.resolvePath must be a string");
+    if (args.listPath !== undefined || args.resolvePath !== undefined) {
+      throw new Error("batch_resolve_my_bugs endpoint overrides are no longer supported");
     }
     if (args.solution !== undefined && typeof args.solution !== "string") {
       throw new Error("batch_resolve_my_bugs.solution must be a string");
@@ -231,8 +252,8 @@ export function assertToolArgs(name, args) {
     if (!Number.isFinite(args.id) || Number(args.id) < 1) {
       throw new Error("close_bug.id must be a number >= 1");
     }
-    if (args.path !== undefined && typeof args.path !== "string") {
-      throw new Error("close_bug.path must be a string");
+    if (args.path !== undefined) {
+      throw new Error("close_bug.path is no longer supported");
     }
   }
   if (name === "verify_bug") {
@@ -245,11 +266,8 @@ export function assertToolArgs(name, args) {
         throw new Error("verify_bug.result must be pass or fail");
       }
     }
-    if (args.closePath !== undefined && typeof args.closePath !== "string") {
-      throw new Error("verify_bug.closePath must be a string");
-    }
-    if (args.activatePath !== undefined && typeof args.activatePath !== "string") {
-      throw new Error("verify_bug.activatePath must be a string");
+    if (args.closePath !== undefined || args.activatePath !== undefined) {
+      throw new Error("verify_bug endpoint overrides are no longer supported");
     }
   }
   if (name === "comment_bug") {
@@ -259,8 +277,8 @@ export function assertToolArgs(name, args) {
     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");
+    if (args.path !== undefined) {
+      throw new Error("comment_bug.path is no longer supported");
     }
   }
 }