@zzp123/mcp-zentao 1.14.0 → 1.16.0

package/CHANGELOG.md

@@ -5,6 +5,65 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.16.0] - 2025-11-07
+
+### Fixed
+- **修复评论功能 - 使用正确的 REST API v1 接口** 🔧
+  - 之前版本使用的是 HTML 接口，现已改用标准 REST API
+  - 修复了评论创建、更新、删除等功能
+
+### Added
+- **完整的评论管理工具** 💬
+  - `getComments`: 获取指定对象的评论列表
+  - `getCommentDetail`: 获取单条评论详情
+  - `addComment`: 创建评论（支持11种对象类型）
+  - `updateComment`: 更新评论内容
+  - `deleteComment`: 删除评论
+  - 便捷工具：`addStoryComment`、`addTaskComment`、`addBugComment`
+
+### Changed
+- **更新评论接口实现**
+  - 使用标准 REST API：`POST /comment`、`GET /comments/{type}/{id}`
+  - 支持更多对象类型：新增 execution、project 类型
+  - 返回完整的评论对象信息（包含 id、actor、date 等）
+
+### Technical
+- 更新 `Comment` 接口定义
+- 添加 `UpdateCommentRequest` 接口
+- 添加 `CommentListResponse` 接口
+- 所有评论方法使用统一的 `request()` 方法，保持 Token 认证
+
+## [1.15.0] - 2025-11-07
+
+### Added
+- **评论功能完整支持** 💬
+  - 新增 `addComment` 通用评论工具，支持9种对象类型
+  - 新增专用评论工具：
+    - `addStoryComment`: 为需求添加评论（自动识别story/requirement）
+    - `addTaskComment`: 为任务添加评论
+    - `addBugComment`: 为Bug添加评论
+  - 支持的对象类型：
+    - story（软件需求）
+    - requirement（用户需求）
+    - task（任务）
+    - bug（Bug）
+    - testcase（测试用例）
+    - testtask（测试单）
+    - todo（待办）
+    - doc（文档）
+    - doctemplate（文档模板）
+
+### Changed
+- **评论内容格式**
+  - 支持纯文本评论
+  - 支持HTML格式的富文本评论
+  - 自动处理评论提交的响应格式
+
+### Technical
+- 添加 `CommentObjectType` 类型定义
+- 添加 `AddCommentRequest` 和 `CommentResponse` 接口
+- 实现混合接口调用（使用HTML接口但保持REST API认证）
+
 ## [1.14.0] - 2025-11-07
 
 ### Added

package/dist/api/zentaoApi.d.ts

@@ -1,4 +1,4 @@
-import { AssignFeedbackRequest, Bug, BugStatus, Build, CloseFeedbackRequest, CreateBuildRequest, CreateBugRequest, CreateExecutionRequest, CreateFeedbackRequest, CreatePlanRequest, CreateProductRequest, CreateProgramRequest, CreateProjectRequest, CreateStoryRequest, CreateTaskRequest, CreateTestCaseRequest, CreateTicketRequest, CreateUserRequest, Execution, Feedback, FileUploadResponse, ModulesResponse, ModuleType, Plan, Product, Program, Project, Release, ResolveBugRequest, Story, Task, TaskStatus, TaskUpdate, TestCase, Ticket, UpdateBuildRequest, UpdateBugRequest, UpdateExecutionRequest, UpdateFeedbackRequest, UpdatePlanRequest, UpdateProductRequest, UpdateProgramRequest, UpdateProjectRequest, ChangeStoryRequest, UpdateTestCaseRequest, UpdateTicketRequest, UpdateUserRequest, UploadFileRequest, UserDetail, ZentaoConfig } from '../types/zentao';
+import { AddCommentRequest, AssignFeedbackRequest, Bug, BugStatus, Build, CloseFeedbackRequest, Comment, CommentObjectType, CreateBuildRequest, CreateBugRequest, CreateExecutionRequest, CreateFeedbackRequest, CreatePlanRequest, CreateProductRequest, CreateProgramRequest, CreateProjectRequest, CreateStoryRequest, CreateTaskRequest, CreateTestCaseRequest, CreateTicketRequest, CreateUserRequest, Execution, Feedback, FileUploadResponse, ModulesResponse, ModuleType, Plan, Product, Program, Project, Release, ResolveBugRequest, Story, Task, TaskStatus, TaskUpdate, TestCase, Ticket, UpdateBuildRequest, UpdateBugRequest, UpdateCommentRequest, UpdateExecutionRequest, UpdateFeedbackRequest, UpdatePlanRequest, UpdateProductRequest, UpdateProgramRequest, UpdateProjectRequest, ChangeStoryRequest, UpdateTestCaseRequest, UpdateTicketRequest, UpdateUserRequest, UploadFileRequest, UserDetail, ZentaoConfig } from '../types/zentao';
 export declare class ZentaoAPI {
     private config;
     private client;
@@ -239,5 +239,32 @@ export declare class ZentaoAPI {
     getModules(type: ModuleType, id: number, fields?: string): Promise<ModulesResponse>;
     uploadFile(uploadRequest: UploadFileRequest): Promise<FileUploadResponse>;
     downloadFile(fileId: number): Promise<Buffer>;
+    /**
+     * 获取评论列表
+     * GET /comments/{objectType}/{objectID}
+     */
+    getComments(objectType: CommentObjectType, objectID: number): Promise<Comment[]>;
+    /**
+     * 获取单条评论详情
+     * GET /comment/{id}
+     */
+    getCommentDetail(commentId: number): Promise<Comment>;
+    /**
+     * 创建评论
+     * POST /comment
+     */
+    addComment(request: AddCommentRequest): Promise<Comment>;
+    /**
+     * 更新评论
+     * PUT /comment/{id}
+     */
+    updateComment(commentId: number, update: UpdateCommentRequest): Promise<Comment>;
+    /**
+     * 删除评论
+     * DELETE /comment/{id}
+     */
+    deleteComment(commentId: number): Promise<{
+        message: string;
+    }>;
     getConfig(): ZentaoConfig;
 }

package/dist/api/zentaoApi.js

@@ -1534,6 +1534,87 @@ export class ZentaoAPI {
             throw error;
         }
     }
+    // 评论模块 - 使用 REST API v1 接口
+    /**
+     * 获取评论列表
+     * GET /comments/{objectType}/{objectID}
+     */
+    async getComments(objectType, objectID) {
+        try {
+            console.log(`正在获取 ${objectType} ${objectID} 的评论列表...`);
+            const response = await this.request('GET', `/comments/${objectType}/${objectID}`);
+            console.log('获取评论列表响应:', response);
+            return response;
+        }
+        catch (error) {
+            console.error('获取评论列表失败:', error);
+            throw error;
+        }
+    }
+    /**
+     * 获取单条评论详情
+     * GET /comment/{id}
+     */
+    async getCommentDetail(commentId) {
+        try {
+            console.log(`正在获取评论 ${commentId} 的详情...`);
+            const response = await this.request('GET', `/comment/${commentId}`);
+            console.log('获取评论详情响应:', response);
+            return response;
+        }
+        catch (error) {
+            console.error('获取评论详情失败:', error);
+            throw error;
+        }
+    }
+    /**
+     * 创建评论
+     * POST /comment
+     */
+    async addComment(request) {
+        try {
+            console.log(`正在为 ${request.objectType} ${request.objectID} 添加评论...`);
+            const response = await this.request('POST', '/comment', undefined, request);
+            console.log('添加评论响应:', response);
+            return response;
+        }
+        catch (error) {
+            console.error('添加评论失败:', error);
+            throw error;
+        }
+    }
+    /**
+     * 更新评论
+     * PUT /comment/{id}
+     */
+    async updateComment(commentId, update) {
+        try {
+            console.log(`正在更新评论 ${commentId}...`);
+            const response = await this.request('PUT', `/comment/${commentId}`, undefined, update);
+            console.log('更新评论响应:', response);
+            return response;
+        }
+        catch (error) {
+            console.error('更新评论失败:', error);
+            throw error;
+        }
+    }
+    /**
+     * 删除评论
+     * DELETE /comment/{id}
+     */
+    async deleteComment(commentId) {
+        try {
+            console.log(`正在删除评论 ${commentId}...`);
+            const response = await this.request('DELETE', `/comment/${commentId}`);
+            console.log('删除评论响应:', response);
+            return response;
+        }
+        catch (error) {
+            console.error('删除评论失败:', error);
+            throw error;
+        }
+    }
     // 获取配置信息（用于生成图片 URL）
     getConfig() {
         return this.config;

package/dist/index.js

@@ -1504,6 +1504,188 @@ server.tool("downloadFile", {
     fs.writeFileSync(savePath, fileBuffer);
     return { content: [{ type: "text", text: `文件已下载到: ${savePath}` }] };
 });
+// Comment tools (评论工具) - 使用 REST API v1
+server.tool("getComments", "获取评论列表 - 获取指定对象的所有评论", {
+    objectType: z.enum([
+        'story', // 软件需求
+        'requirement', // 用户需求
+        'task', // 任务
+        'bug', // Bug
+        'testcase', // 测试用例
+        'testtask', // 测试单
+        'todo', // 待办
+        'doc', // 文档
+        'execution', // 执行/迭代
+        'project', // 项目
+        'doctemplate' // 文档模板
+    ]).describe("对象类型"),
+    objectID: z.number().describe("对象ID")
+}, async ({ objectType, objectID }) => {
+    if (!zentaoApi)
+        throw new Error("Please initialize Zentao API first");
+    const comments = await zentaoApi.getComments(objectType, objectID);
+    return {
+        content: [{
+                type: "text",
+                text: JSON.stringify({
+                    total: comments.length,
+                    objectType,
+                    objectID,
+                    comments
+                }, null, 2)
+            }]
+    };
+});
+server.tool("getCommentDetail", "获取单条评论详情", {
+    commentId: z.number().describe("评论ID")
+}, async ({ commentId }) => {
+    if (!zentaoApi)
+        throw new Error("Please initialize Zentao API first");
+    const comment = await zentaoApi.getCommentDetail(commentId);
+    return {
+        content: [{
+                type: "text",
+                text: JSON.stringify(comment, null, 2)
+            }]
+    };
+});
+server.tool("addComment", "添加评论 - 为需求、任务、Bug等对象添加评论", {
+    objectType: z.enum([
+        'story', // 软件需求
+        'requirement', // 用户需求
+        'task', // 任务
+        'bug', // Bug
+        'testcase', // 测试用例
+        'testtask', // 测试单
+        'todo', // 待办
+        'doc', // 文档
+        'execution', // 执行/迭代
+        'project', // 项目
+        'doctemplate' // 文档模板
+    ]).describe("对象类型"),
+    objectID: z.number().describe("对象ID"),
+    comment: z.string().describe("评论内容，支持HTML格式"),
+    uid: z.string().optional().describe("唯一标识符（可选）")
+}, async ({ objectType, objectID, comment, uid }) => {
+    if (!zentaoApi)
+        throw new Error("Please initialize Zentao API first");
+    const result = await zentaoApi.addComment({
+        objectType,
+        objectID,
+        comment,
+        uid
+    });
+    return {
+        content: [{
+                type: "text",
+                text: JSON.stringify({
+                    message: '评论添加成功',
+                    comment: result
+                }, null, 2)
+            }]
+    };
+});
+server.tool("updateComment", "更新评论 - 只能更新自己的评论", {
+    commentId: z.number().describe("评论ID"),
+    comment: z.string().describe("更新后的评论内容，支持HTML格式"),
+    uid: z.string().optional().describe("唯一标识符（可选）")
+}, async ({ commentId, comment, uid }) => {
+    if (!zentaoApi)
+        throw new Error("Please initialize Zentao API first");
+    const result = await zentaoApi.updateComment(commentId, {
+        comment,
+        uid
+    });
+    return {
+        content: [{
+                type: "text",
+                text: JSON.stringify({
+                    message: '评论更新成功',
+                    comment: result
+                }, null, 2)
+            }]
+    };
+});
+server.tool("deleteComment", "删除评论 - 只能删除自己的评论，管理员可以删除所有评论", {
+    commentId: z.number().describe("评论ID")
+}, async ({ commentId }) => {
+    if (!zentaoApi)
+        throw new Error("Please initialize Zentao API first");
+    const result = await zentaoApi.deleteComment(commentId);
+    return {
+        content: [{
+                type: "text",
+                text: JSON.stringify({
+                    status: 'success',
+                    message: result.message || '评论删除成功'
+                }, null, 2)
+            }]
+    };
+});
+// 便捷工具 - 为特定类型对象添加评论
+server.tool("addStoryComment", "为需求添加评论 - 专用工具，支持软件需求(story)和用户需求(requirement)", {
+    storyId: z.number().describe("需求ID"),
+    comment: z.string().describe("评论内容，支持HTML格式")
+}, async ({ storyId, comment }) => {
+    if (!zentaoApi)
+        throw new Error("Please initialize Zentao API first");
+    const result = await zentaoApi.addComment({
+        objectType: 'story',
+        objectID: storyId,
+        comment
+    });
+    return {
+        content: [{
+                type: "text",
+                text: JSON.stringify({
+                    message: `已为需求 #${storyId} 添加评论`,
+                    comment: result
+                }, null, 2)
+            }]
+    };
+});
+server.tool("addTaskComment", "为任务添加评论", {
+    taskId: z.number().describe("任务ID"),
+    comment: z.string().describe("评论内容，支持HTML格式")
+}, async ({ taskId, comment }) => {
+    if (!zentaoApi)
+        throw new Error("Please initialize Zentao API first");
+    const result = await zentaoApi.addComment({
+        objectType: 'task',
+        objectID: taskId,
+        comment
+    });
+    return {
+        content: [{
+                type: "text",
+                text: JSON.stringify({
+                    message: `已为任务 #${taskId} 添加评论`,
+                    comment: result
+                }, null, 2)
+            }]
+    };
+});
+server.tool("addBugComment", "为Bug添加评论", {
+    bugId: z.number().describe("Bug ID"),
+    comment: z.string().describe("评论内容，支持HTML格式")
+}, async ({ bugId, comment }) => {
+    if (!zentaoApi)
+        throw new Error("Please initialize Zentao API first");
+    const result = await zentaoApi.addComment({
+        objectType: 'bug',
+        objectID: bugId,
+        comment
+    });
+    return {
+        content: [{
+                type: "text",
+                text: JSON.stringify({
+                    message: `已为Bug #${bugId} 添加评论`,
+                    comment: result
+                }, null, 2)
+            }]
+    };
+});
 // Start receiving messages on stdin and sending messages on stdout
 const transport = new StdioServerTransport();
 await server.connect(transport).catch(console.error);

package/dist/types/zentao.d.ts

@@ -717,3 +717,31 @@ export interface UploadFileRequest {
     filename: string;
     uid?: string;
 }
+export type CommentObjectType = 'story' | 'requirement' | 'task' | 'bug' | 'testcase' | 'testtask' | 'todo' | 'doc' | 'execution' | 'project' | 'doctemplate';
+export interface Comment {
+    id: number;
+    objectType: string;
+    objectID: number;
+    action: string;
+    actor: string;
+    actorName?: string;
+    date: string;
+    comment: string;
+    extra?: string;
+}
+export interface AddCommentRequest {
+    objectType: CommentObjectType;
+    objectID: number;
+    comment: string;
+    uid?: string;
+}
+export interface UpdateCommentRequest {
+    comment: string;
+    uid?: string;
+}
+export interface CommentListResponse {
+    page: number;
+    total: number;
+    limit: number;
+    comments: Comment[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@zzp123/mcp-zentao",
-    "version": "1.14.0",
+    "version": "1.16.0",
     "description": "禅道项目管理系统的高级API集成包，提供任务管理、Bug跟踪等功能的完整封装，专为Cursor IDE设计的MCP扩展",
     "main": "dist/index.js",
     "type": "module",