get_task_transition_requirements
Retrieve mandatory fields and role owners needed before transitioning a work item to a target status. Ensures all required information is provided to avoid failed status changes.
Instructions
获取将指定工作项流转到目标状态前的必填信息要求。
该工具用于在执行状态流转前,先询问系统:从当前状态流转到 target_status 需要补全哪些字段。
常见场景包括:
- 流转到“已完成/已关闭”时需要填写“解决方案”“原因”“验证人”等字段
- 流转到某些阶段需要指定角色负责人(role owners)或填写额外信息
本工具仅负责:
1) project/work_item_type 参数解析(project_name 与 project_key 分支)
2) 委托 WorkflowProvider 解析状态名并调用 WorkflowAPI.get_transition_required_info
3) 返回统一的 JSON envelope(success/data),便于 LLM 稳定解析
注意:
- 成功时返回 JSON 字符串(success=true)。
- 失败时返回纯文本错误信息(由 with_error_handling 统一处理),不会返回 JSON。
Args:
issue_id: 工作项 ID,必填。
target_status: 目标状态名称(人类可读),必填。例如:"已完成"、"待处理"。
project: 项目标识符(可选)。可以是项目名称或 project_key;不传则使用环境变量 FEISHU_PROJECT_KEY 指定的默认项目。
work_item_type: 工作项类型名称(可选)。例如:"问题管理"、"Issue管理"。
mode: 工作流查询模式(可选)。透传给后端接口,用于控制必填项返回策略。
user_key: (可选) 飞书用户标识符 (X-USER-KEY),用于以特定用户身份进行操作。
Returns:
JSON 字符串。
成功时(success=true)data 格式至少包含:
{
"required_fields": [ ... ]
}
失败时返回纯文本错误信息(由 with_error_handling 统一处理),常见原因包括:
- target_status 无法匹配(会提示“可选状态”)
- 当前用户无权限查询该工作项的工作流信息
- 网络/系统异常
Examples:
# 查询将 Issue 123 流转到“已完成”前需要填哪些字段
get_task_transition_requirements(issue_id=123, target_status="已完成")
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | ||
| project | No | ||
| issue_id | Yes | ||
| user_key | No | ||
| target_status | Yes | ||
| work_item_type | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |