feat: 更新MCP工具描述

This commit is contained in:
kuaifan
2025-11-11 07:16:04 +00:00
parent cf78766a37
commit eb9b7b4f86

56
electron/lib/mcp.js vendored
View File

@@ -4,36 +4,36 @@
* DooTask 的 Electron 客户端集成了 Model Context Protocol (MCP) 服务,
* 允许 AI 助手(如 Claude)直接与 DooTask 任务进行交互。
*
* 提供的工具(共 24 个):
* 提供的工具(共 25 个):
*
* === 用户管理 ===
* - get_users_basic - 根据用户ID列表获取基础信息,便于匹配负责人/协助人
* - search_user - 按关键字或项目筛选用户,支持分页与更多过滤项
* - get_users_basic - 批量获取用户基础信息1-50个,便于匹配负责人/协助人
* - search_user - 按关键词搜索用户,支持按项目/对话范围筛选用于不知道用户ID时的查找
*
* === 任务管理 ===
* - list_tasks - 获取任务列表,支持按状态/项目/主任务筛选、搜索、分页
* - get_task - 获取任务详情,包含完整内容、负责人、协助人员、标签等所有信息
* - list_tasks - 获取当前用户相关的任务列表(负责/协助/关注),支持按状态/项目/时间筛选
* - get_task - 获取单个任务的完整详细信息,比 list_tasks 返回更详细
* - complete_task - 快速标记任务完成
* - create_task - 创建新任务
* - update_task - 更新任务,支持修改名称、内容、负责人、时间、状态等所有属性
* - create_task - 在指定项目中创建新任务
* - update_task - 更新任务的任意属性,只需提供要修改的字段
* - create_sub_task - 为指定主任务创建子任务
* - get_task_files - 获取任务附件列表
* - delete_task - 删除或还原任务
*
* === 项目管理 ===
* - list_projects - 获取项目列表,支持按归档状态筛选、搜索
* - get_project - 获取项目详情,包含列(看板列)、成员等完整信息
* - list_projects - 获取当前用户可访问的项目列表,支持按归档状态筛选、搜索
* - get_project - 获取项目的完整详细信息,比 list_projects 返回更详细
* - create_project - 创建新项目
* - update_project - 修改项目信息(名称、描述等)
*
* === 文件管理 ===
* - list_files - 获取项目文件列表,支持按父级文件夹筛选
* - search_files - 按关键词搜索文件支持搜索文件名称或ID
* - get_file_detail - 获取文件详情,返回 content_url 可配合 WebFetch 读取文件内容
* === 文件管理(个人文件系统) ===
* - list_files - 浏览个人文件系统,获取指定文件夹下的文件和子文件夹列表
* - search_files - 搜索用户文件系统中的文件(自己创建的和共享给自己的)
* - get_file_detail - 获取文件详情,支持通过文件ID或分享码访问返回 content_url 可配合 WebFetch 读取
*
* === 工作报告 ===
* - list_received_reports - 获取我接收的汇报列表,支持按类型/状态/部门/时间筛选
* - get_report_detail - 获取汇报详情,包括完整内容、汇报人、接收人、AI分析等
* - get_report_detail - 获取汇报详情,支持通过报告ID或分享码访问内容自动转为 Markdown
* - generate_report_template - 基于任务完成情况自动生成汇报模板(已完成/未完成任务)
* - create_report - 创建并提交工作汇报
* - list_my_reports - 获取我发送的汇报列表,支持按类型/时间筛选
@@ -41,7 +41,7 @@
*
* === 消息通知 ===
* - send_message_to_user - 给指定用户发送私信
* - get_message_list - 获取对话消息或执行关键词搜索
* - get_message_list - 两种模式:获取对话消息列表 或 按关键词搜索消息
*
* 配置方法:
* {
@@ -222,7 +222,7 @@ class DooTaskMCP {
// 用户管理:获取用户基础信息
this.mcp.addTool({
name: 'get_users_basic',
description: '根据用户ID列表获取用户基础信息昵称、邮箱、头像等,方便在分配任务前确认成员身份。',
description: '根据用户ID列表批量获取用户基础信息(昵称、邮箱、头像等)。适用于分配任务前确认成员身份支持1-50个用户。',
parameters: z.object({
userids: z.array(z.number())
.min(1)
@@ -269,7 +269,7 @@ class DooTaskMCP {
// 用户管理:搜索用户
this.mcp.addTool({
name: 'search_user',
description: '按关键词搜索或筛选用户,支持按项目/对话过滤并返回分页结果。',
description: '按关键词搜索用户(昵称、邮箱、拼音),支持按项目/对话范围筛选。与 get_users_basic 不同此工具用于不知道具体用户ID时的查找场景。',
parameters: z.object({
keyword: z.string()
.min(1)
@@ -376,7 +376,7 @@ class DooTaskMCP {
// 获取任务列表
this.mcp.addTool({
name: 'list_tasks',
description: '获取任务列表。可以按状态筛选(已完成/未完成)、搜索任务名称、按时间范围筛选。',
description: '获取当前用户相关的任务列表(负责/协助/关注),支持按状态、项目、时间范围筛选和搜索。',
parameters: z.object({
status: z.enum(['all', 'completed', 'uncompleted'])
.optional()
@@ -474,7 +474,7 @@ class DooTaskMCP {
// 获取任务详情
this.mcp.addTool({
name: 'get_task',
description: '获取指定任务的详细信息,包括任务描述、完整内容、负责人、协助人员、标签、时间等所有信息。返回的 content 字段为 Markdown 格式。',
description: '获取单个任务的完整详细信息包括任务描述、完整内容content、负责人、协助人员、标签、时间等。比 list_tasks 返回更详细的信息。',
parameters: z.object({
task_id: z.number()
.describe('任务ID'),
@@ -587,7 +587,7 @@ class DooTaskMCP {
// 创建任务
this.mcp.addTool({
name: 'create_task',
description: '创建新任务。可以指定任务名称、内容、负责人、时间等信息。',
description: '在指定项目中创建新任务。必需参数项目ID、任务名称。可选负责人、协助人、开始/结束时间、看板列等。',
parameters: z.object({
project_id: z.number()
.describe('项目ID'),
@@ -656,7 +656,7 @@ class DooTaskMCP {
// 更新任务
this.mcp.addTool({
name: 'update_task',
description: '更新任务信息。可以修改任务名称、内容、负责人、时间、状态等所有属性。',
description: '更新任务的任意属性(名称、内容、负责人、协助人、时间、完成状态、看板列等)。只需提供要修改的字段。',
parameters: z.object({
task_id: z.number()
.describe('任务ID'),
@@ -864,7 +864,7 @@ class DooTaskMCP {
// 获取项目列表
this.mcp.addTool({
name: 'list_projects',
description: '获取项目列表。可以按归档状态筛选、搜索项目名称。',
description: '获取当前用户可访问的项目列表,支持按归档状态筛选、搜索项目名称。',
parameters: z.object({
archived: z.enum(['no', 'yes', 'all'])
.optional()
@@ -926,7 +926,7 @@ class DooTaskMCP {
// 获取项目详情
this.mcp.addTool({
name: 'get_project',
description: '获取指定项目的详细信息,包括项目的列(看板列、成员等完整信息。',
description: '获取指定项目的完整详细信息,包括项目描述、所有看板列、成员列表及权限等。比 list_projects 返回更详细的信息。',
parameters: z.object({
project_id: z.number()
.describe('项目ID'),
@@ -1188,7 +1188,7 @@ class DooTaskMCP {
// 获取消息列表或搜索消息
this.mcp.addTool({
name: 'get_message_list',
description: '获取指定对话的消息列表,或按关键搜索消息位置/内容。',
description: '两种模式1获取指定对话的消息列表(需提供 dialog_id支持按类型筛选、分页加载2按关键搜索消息(提供 keyword可在单个对话或全局搜索。',
parameters: z.object({
dialog_id: z.number()
.optional()
@@ -1715,7 +1715,7 @@ class DooTaskMCP {
// 文件管理:获取文件列表
this.mcp.addTool({
name: 'list_files',
description: '获取项目文件列表,支持按父级文件夹筛选。可以浏览文件夹结构,查看所有文件和子文件夹。',
description: '获取用户文件列表(个人文件系统),支持按父级文件夹筛选。pid=0或不传表示获取根目录pid>0获取指定文件夹下的内容。可以浏览文件夹结构,查看所有文件和子文件夹。',
parameters: z.object({
pid: z.number()
.optional()
@@ -1764,11 +1764,11 @@ class DooTaskMCP {
// 文件管理:搜索文件
this.mcp.addTool({
name: 'search_files',
description: '按关键词搜索文件,支持搜索文件名称或ID。可以快速定位文件位置。',
description: '按关键词搜索用户文件系统中的文件,支持搜索文件名称、文件ID或分享链接。搜索范围包括自己创建的文件和共享给自己的文件。',
parameters: z.object({
keyword: z.string()
.min(1)
.describe('搜索关键词,支持文件名称文件ID'),
.describe('搜索关键词,支持文件名称文件ID或分享链接'),
take: z.number()
.optional()
.describe('返回数量默认50最大100'),
@@ -1817,7 +1817,7 @@ class DooTaskMCP {
// 文件管理:获取文件详情
this.mcp.addTool({
name: 'get_file_detail',
description: '获取指定文件的详细信息,包括类型、大小、共享状态、创建者等。返回的 content_url 可以配合 WebFetch 工具读取文件内容进行分析。支持通过文件ID或分享码访问。',
description: '获取指定文件的详细信息,包括类型、大小、共享状态、创建者等。支持通过文件ID或分享码访问。返回的 content_url 可以配合 WebFetch 工具读取文件内容进行分析。',
parameters: z.object({
file_id: z.union([z.number(), z.string()])
.describe('文件ID数字或分享码字符串'),