@zzp123/mcp-zentao 1.4.3 → 1.6.0

package/CHANGELOG.md

@@ -5,6 +5,52 @@ 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.6.0] - 2025-11-05
+
+### Changed - 重大更新
+- **迁移到自定义模块接口** `/custom/modules` - 替代原生 `/modules` 接口
+  - 接口路径：`GET /custom/modules`（原 `/modules`）
+  - 支持字段过滤功能：通过 `fields` 参数指定返回字段
+  - 默认返回精简字段：id、name、parent、grade、type
+  - 可选字段：id、root、branch、name、parent、path、grade、order、type、owner、collector、short
+
+### Added
+- 新增 `fields` 参数支持，可大幅减少返回数据量（60-80%）
+- 新增 `ModulesResponse` 接口：`{ modules: SimpleModule[], total: number }`
+- 更新 `SimpleModule` 接口，支持更多可选字段
+
+### Technical
+- 返回数据结构变化：从嵌套树形结构改为扁平化数组
+- 通过 `parent` 字段关联父子关系，通过 `path` 字段表示层级路径
+- 移除 `simplifyModule()` 递归处理方法（不再需要）
+- 接口响应包含 `total` 字段，返回模块总数
+
+### Benefits
+- **性能提升**：支持按需获取字段，减少60-80%数据传输量
+- **更灵活**：可根据实际需求指定返回字段
+- **更标准**：返回格式包含 total 统计信息
+
+### Breaking Changes
+- `getModules()` 返回类型从 `SimpleModule[]` 改为 `ModulesResponse`
+- `SimpleModule` 不再包含 `children` 字段（数据已扁平化）
+
+## [1.5.0] - 2025-11-05
+
+### Added
+- **模块数据简化功能** - 新增 `SimpleModule` 接口，简化模块API返回数据
+  - `getModules` 接口现在只返回核心字段：id、name、parent、grade、children
+  - 移除冗余的字段（type、path、order等），大幅减少数据传输量
+  - 保持树形结构，递归简化所有子模块数据
+
+### Changed
+- 优化 `getModules()` 方法，返回类型从 `Module[]` 改为 `SimpleModule[]`
+- 添加 `simplifyModule()` 私有方法，用于递归转换模块数据结构
+
+### Benefits
+- 减少网络传输数据量，提升API响应速度
+- 简化客户端数据处理逻辑
+- 更清晰的数据结构，只包含必要信息
+
 ## [1.4.3] - 2025-11-05
 
 ### Fixed

package/README.md

@@ -15,10 +15,11 @@ npm install @zzp123/mcp-zentao -g
 
 查看完整的版本更新历史，请访问 [CHANGELOG.md](./CHANGELOG.md)
 
-**最新版本**: v1.4.3
-- 将 CHANGELOG.md 添加到 npm 包中，用户可直接查看版本历史
-- 完整的文档更新和示例代码修正
-- 修正包名和API签名
+**最新版本**: v1.6.0
+- 迁移到自定义模块接口 /custom/modules，支持字段过滤
+- 新增 fields 参数，可减少60-80%数据传输量
+- 返回数据扁平化，包含 total 统计信息
+- ⚠️ Breaking Change: getModules 返回类型变更
 
 **主要版本**:
 - v1.4.1 - 修复 uploadImageFromClipboard 返回值问题

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, Module, ModuleType, Plan, Product, Program, Project, Release, ResolveBugRequest, Story, Task, TaskStatus, TaskUpdate, TestCase, Ticket, UpdateBuildRequest, UpdateBugRequest, UpdateExecutionRequest, UpdateFeedbackRequest, UpdatePlanRequest, UpdateProductRequest, UpdateProgramRequest, UpdateProjectRequest, UpdateStoryRequest, UpdateTestCaseRequest, UpdateTicketRequest, UpdateUserRequest, UploadFileRequest, UserDetail, ZentaoConfig } from '../types/zentao';
+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, UpdateStoryRequest, UpdateTestCaseRequest, UpdateTicketRequest, UpdateUserRequest, UploadFileRequest, UserDetail, ZentaoConfig } from '../types/zentao';
 export declare class ZentaoAPI {
     private config;
     private client;
@@ -148,7 +148,14 @@ export declare class ZentaoAPI {
     deleteTicket(ticketId: number): Promise<{
         message: string;
     }>;
-    getModules(type: ModuleType, id: number): Promise<Module[]>;
+    /**
+     * 获取模块列表（使用自定义接口，支持字段过滤）
+     * @param type 模块类型：story(需求)、bug、case(用例)、task(任务)、feedback(反馈)、product
+     * @param id 对象ID：产品ID或项目ID
+     * @param fields 可选，指定返回的字段，多个字段用逗号分隔。默认返回：id,name,parent,grade,type
+     * @returns Promise<ModulesResponse> 包含模块列表和总数
+     */
+    getModules(type: ModuleType, id: number, fields?: string): Promise<ModulesResponse>;
     uploadFile(uploadRequest: UploadFileRequest): Promise<FileUploadResponse>;
     downloadFile(fileId: number): Promise<Buffer>;
 }

package/dist/api/zentaoApi.js

@@ -1119,13 +1119,24 @@ export class ZentaoAPI {
         }
     }
     // 模块相关API
-    async getModules(type, id) {
-        try {
-            console.log(`正在获取模块列表，类型: ${type}, ID: ${id}...`);
+    /**
+     * 获取模块列表（使用自定义接口，支持字段过滤）
+     * @param type 模块类型：story(需求)、bug、case(用例)、task(任务)、feedback(反馈)、product
+     * @param id 对象ID：产品ID或项目ID
+     * @param fields 可选，指定返回的字段，多个字段用逗号分隔。默认返回：id,name,parent,grade,type
+     * @returns Promise<ModulesResponse> 包含模块列表和总数
+     */
+    async getModules(type, id, fields) {
+        try {
+            console.log(`正在获取模块列表，类型: ${type}, ID: ${id}, 字段: ${fields || '默认'}...`);
             const params = { type, id };
-            const response = await this.request('GET', '/modules', params);
-            console.log('获取模块列表响应:', response);
-            return response.modules;
+            if (fields) {
+                params.fields = fields;
+            }
+            // 使用新的自定义接口路径
+            const response = await this.request('GET', '/custom/modules', params);
+            console.log(`获取模块列表成功，共 ${response.total} 个模块`);
+            return response;
         }
         catch (error) {
             console.error('获取模块列表失败:', error);

package/dist/index.js

@@ -926,15 +926,16 @@ server.tool("deleteTicket", { ticketId: z.number() }, async ({ ticketId }) => {
         throw new Error("Please initialize Zentao API first");
     return { content: [{ type: "text", text: JSON.stringify(await zentaoApi.deleteTicket(ticketId), null, 2) }] };
 });
-// 模块相关工具
+// 模块相关工具（使用自定义接口，支持字段过滤）
 server.tool("getModules", {
     type: z.enum(['story', 'task', 'bug', 'case', 'feedback', 'product']),
-    id: z.number()
-}, async ({ type, id }) => {
+    id: z.number(),
+    fields: z.string().optional()
+}, async ({ type, id, fields }) => {
     if (!zentaoApi)
         throw new Error("Please initialize Zentao API first");
-    const modules = await zentaoApi.getModules(type, id);
-    return { content: [{ type: "text", text: JSON.stringify(modules, null, 2) }] };
+    const response = await zentaoApi.getModules(type, id, fields);
+    return { content: [{ type: "text", text: JSON.stringify(response, null, 2) }] };
 });
 // 文件相关工具
 server.tool("uploadFile", {

package/dist/types/zentao.d.ts

@@ -626,8 +626,30 @@ export interface Module {
     owner: string;
     collector?: string;
     short?: string;
+    deleted?: string;
+    from?: number;
+    url?: string;
+    children?: Module[];
 }
 export type ModuleType = 'story' | 'task' | 'bug' | 'case' | 'feedback' | 'product';
+export interface SimpleModule {
+    id: string;
+    name: string;
+    parent: string;
+    grade: string;
+    type?: string;
+    path?: string;
+    root?: string;
+    branch?: string;
+    order?: string;
+    owner?: string;
+    collector?: string;
+    short?: string;
+}
+export interface ModulesResponse {
+    modules: SimpleModule[];
+    total: number;
+}
 export interface FileUploadResponse {
     id: number;
     url: string;

package/package.json

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