Larksuite Meegle CLI Meegle CLI

飞书项目 (Meego/Meegle) 操作指南

本技能通过 Meegle CLI来操作飞书项目数据。输出语言跟随用户输入语言，默认中文。

各命令的调用示例见 references/api-examples.md。 授权流程（所有业务命令前必须执行）：见 references/auth-guard.md CLI 使用指南（命令结构、参数传递、命令发现）：见 references/cli-guide.md

Project 空间域

project search

搜索空间信息，将空间名转换为 project_key 或验证空间是否存在；省略 --project-key 时返回当前用户最近访问过的空间列表（按访问时间由近及远）。

WorkItem 工作项域

元数据查询命令（workitem meta-types / workitem meta-fields / workitem meta-roles / workitem meta-create-fields）的参数表见 references/workitem.md。

workitem create

创建工作项实例。务必先用 workitem meta-fields 获取字段信息，workitem meta-roles 获取角色信息。模板 ID 是必填项。

workitem get

按 ID/名称查询工作项概况。不传 fields 时返回固定基础字段加上一组默认带出的系统字段——实测包含 group_type 拉群方式、description、current_status_operator、watchers（即便 value 为 null 也会出现）；其余字段需要通过 workitem meta-fields 拿到 key 后再传入 fields。

逻辑字段聚合（重要心智模型）：服务端把 group_id / chat_group 这类"拉群"相关的物理字段合并到一个逻辑字段 group_type。读取/更新统一走 group_type，不要再单独读取 group_id 或 chat_group。

⚠️ 读写协议不对称：读返回结构里判别键是 value（不是 type），更新时判别键是 type——别照着读到的结构直接回写。

读返回（workitem_fields[].value 字段）的形状：

• auto → {value: "auto", label: "自动拉群", group_id: "oc_xxx"}（自动拉群通常有 group_id；状态切换时 oc_id 可能会变）
• bind → {value: "bind", label: "绑定现有群", group_id: "oc_xxx"}
• disabled → {value: "disabled", label: "不拉群"}（无 group_id）

写协议（field_value 里的 JSON）：{"type": "auto" | "bind" | "disabled", "group_id": "oc_xxx"}

workitem batch-get

批量查询工作项（Meegle CLI 客户端 fan-out：并发调用 workitem get）。单次 ≤ 200 个 ID，3 并发，返回 {results, errors, summary}；ID 量大时用 --format ndjson 流式输出。

workitem update

修改指定实例的字段值或角色。节点字段更新请用 workflow update-node。

角色更新：不能通过 fields 更新角色，必须用 role_operate。role_key 通过 workitem meta-roles 获取，user_keys 通过 user search 获取。

拉群方式更新（group_type 逻辑字段）：要修改/读取拉群方式统一走 group_type，不要再单独操作 group_id / chat_group。写协议 field_value 形如：{"type": "auto" | "bind" | "disabled", "group_id": "oc_xxx"}（注意写用 type 作为判别键，与读返回的 value 不对称）。校验规则（服务端实际报错文本）：bind 不带 group_id 或带空串/纯空格 → group_id is required when group_type=bind；auto/disabled 同时带 group_id → group_type conflicts with group_id: type=<auto|disabled>。详细示例见 references/sop-update-workitem.md。

workitem query

使用 MQL 查询工作项数据。语法详见 references/mql-syntax.md。

分组分页：

• --group-pagination-list 是数组，当前只支持传一组分页数据；元素结构为 { "group_id": string, "page_num": number }
• group_id 取首查返回的 list[].group_infos[].group_id；无分组查询返回的默认分组 ID 为 "1"，翻页时也传 "1"
• page_num 从 1 开始；MQL 首查不传分页参数时默认返回第一页，单页最多 50 条。当前接口没有 page_size / page_token 子字段
• 翻页时传首查返回的 session_id 和目标分组的分页参数；传 session_id 后后端不再解析 MQL，只按已有会话取对应分组页

要点：

• 先用 workitem meta-fields / workitem meta-roles 获取字段与角色配置；查不到直接报错不要继续
• SELECT 后属性不宜过多，优先使用字段 key（如 name、priority、status）；返回按页返回，需全量时使用翻页参数

workitem list-op-records

查看工作项操作记录。

Attachment 附件域

附件上传/下载分两步：先调 attachment prepare-upload / attachment prepare-download 申请带签名的对象存储 URL，再与对象存储做 HTTP 直连。Meegle CLI 提供 attachment +upload / attachment +download 一键封装。详细参数表与流程说明见 references/attachment.md。

WorkFlow 工作流域

流转辅助命令（workflow list-state-transitions / workflow list-state-required / workflow meta-node-fields）的参数表见 references/workflow.md。

workflow transition

仅用于节点流工作项，操作节点完成流转或回滚。

workflow transition-state

仅用于状态流工作项，流转工作项状态。先用 workflow list-state-transitions 获取可流转状态及 transition_id。

workflow get-node

获取工作项中指定节点或所有节点的完整详情。

workflow update-node

修改节点（排期、负责人、自定义字段等）。排期/差异化排期/负责人不要同时修改，需分多次调用。

MyWork 工作台域

mywork todo

按 action 类型查询当前用户的工作项列表。无需 MQL 即可查询待办/已办。

需完整结果时，从 page_num=1 连续翻页直到空为止。

WorkHour 工时域

工时记录查询（workhour list-records）的参数表见 references/misc.md。

workhour list-schedule

获取指定人员在时间区间内的排期与工作量明细。

调用约束：每次最多 20 人（多人拆批次并行）；单次跨度 ≤ 3 个月（超出按月拆分）；所有批次完成后再汇总，未完整获取前不得输出结论。

UserGroup 人员域

团队相关命令（team list / team list-members）的参数表见 references/misc.md。

user search

批量查询用户基础信息。用于将姓名/邮箱转换为 userkey。

user me

查看当前用户信息。无需参数。

MQL 中可直接用 current_login_user() 函数，无需提前获取用户信息。如需获取当前用户的 userkey/姓名等详细信息，可用 user search 传入 current_login_user() 作为参数。

View 视图域

视图搜索与固定视图管理（view search / view create-fixed / view update-fixed）的参数表见 references/view.md。

view get

根据视图 ID 获取该视图下的工作项列表。

Comment 评论域

评论列表查询（comment list）的参数表见 references/misc.md。

comment add

添加评论。支持富文本 Markdown，语法详见 references/rich-text-editor-markdown-syntax.md（含 @提及、对齐、链接预览、字号/颜色等扩展语法）。

Deliverable 交付物域

单命令小域，参数表见 references/misc.md。

deliverable list

查看交付物详情及其根工作项 / 来源工作项。可按工作项 ID 列表过滤。

Resource 资源库

资源库（资源模板）管理。resource create 当前对应 MCP create_resource_work_item，用于创建资源实例；查看资源库的字段 / 角色配置用 resource meta-fields。详细参数表见 references/misc.md。

resource create

在已启用资源库的工作项类型下创建资源模板（资源实例）。创建前先调 resource meta-fields 取字段 / 角色配置。

语义边界：

• 创建资源实例：work_item_type_key 是资源库启用的工作项类型；template_id 是该类型下的流程模板 ID/名称；fields / roles 是新资源实例自身的字段和角色。
• 从资源实例创建普通工作项：不要把已有资源实例 ID 填到 work_item_type_key 或 template_id。必须以当前 resource create 的 inspect/schema 为准确认是否有源资源实例参数；若当前 schema 未暴露该参数，先向用户说明无法确认自动化参数，不要猜。

WBS 计划表

计划表（WBS）有 草稿（draft） 与 已发布实例（instance） 两套数据模型。常见编辑流程：wbs create-draft → 多次 wbs edit-draft → wbs publish-draft；放弃改动用 wbs reset-draft。详细参数表与 wbs edit-draft 的 operation 子类型见 references/wbs.md。

wbs list-draft-rows

在计划表草稿中按条件筛选行。常用筛选字段：wbs_name、wbs_parent_id、wbs_owner_in_charge、wbs_states_doing。详见 references/wbs.md。

wbs list-instance-rows

在已发布的线上计划表实例中按条件筛选行。参数同 wbs list-draft-rows。

wbs edit-draft

对计划表草稿执行一次原子编辑。一次调用只能传一个 operation_type，但该操作内部可通过 items / uuids 等数组承载单行或批量编辑；支持新增 / 删除 / 恢复 / 排序 / 改名 / 改负责人 / 改阶段 / 改排期 / 改估分 / 改实际工时等，结构见 references/wbs.md。

⚠️ 前置：草稿不存在时先调 wbs create-draft，再调 wbs edit-draft。判断方法：直接 wbs list-draft-rows 报"草稿不存在"类错误即视为缺失草稿。

wbs publish-draft

将编辑完成的草稿发布到线上。

⚠️ 全量发布前必须用固定话术二次确认："本人及协同者的全部编辑内容均会被发布，请确认是否全量发布？"；部分发布（传入 uuid_strings_list）无需二次确认。

其它低频域

度量图表、子任务、关系定义查询的命令参数表见 references/misc.md：

• Chart 度量域 — chart get / chart list
• SubTask 子任务域 — subtask update（create/update/confirm/rollback）
• Relation 关系域 — relation list / relation meta-definitions
• WBS 计划表 · 辅助命令 — wbs create-draft / wbs reset-draft / wbs get-draft-progress / wbs list-element-templates（见 references/wbs.md）

字段值格式（field_value）

🚨 STRING 协议：field_value 协议层固定为字符串。标量（text/number/bool/option_id/userkey/毫秒）直接作字符串；数组、对象必须先 JSON.stringify 再传，直接传会报 need STRING type, but got: LIST / MAP。 例：multi-user 正确写法为 "[\"7509072868295085608\"]"，错误写法为 ["7509072868295085608"]。

更新角色时不用 fields，用 workitem update 的 role_operate 参数。

关联工作项字段（workitem_related_*）

用户提供名称而非 ID 时，需按名称→ID 转换流程（搜目标空间+类型，消歧，写入格式，防循环引用）：详见 references/field-value-extras.md。

常用场景速查

通用规范

请求处理流程

收到用户输入后依次执行：

1. 参数提取：从自然语言中提取空间名、工作项类型、时间、人员、筛选条件；含 URL 时先调 url decode 解析，按 references/url-kinds.md 的 url_kind 分支决定进入哪个 SOP 或拒绝。禁止自己从 URL 截取路径段作参数。注意区分空间名与筛选维度（如「XX空间下YY业务线的缺陷」中 XX 才是空间名）。

2. 参数确认（禁止猜测）：用探测命令校验空间（project search）、类型（workitem meta-types）、人员（user search）。探测结果不唯一时必须展示并询问用户，禁止自行选择；缺失必填合并为一条消息询问。个人待办（mywork todo）可跳过；URL 经 url decode 拿到 simple_name 后仍需 project search 转权威 project_key（同名空间可能有多个无权限）。

3. 元数据收集（无需用户参与）：调用 workitem meta-fields 获取字段定义（需要特定字段用 field_keys，模糊查询用 field_query）；涉及角色时并行调 workitem meta-roles。关键字段识别：状态字段 type=_work_item_status（含「完成/关闭/终止」的值为完成态）、排期字段 type=schedule（MQL 用 __字段名_开始时间 / __字段名_结束时间）、优先级字段 key=priority。简单直调场景（仅需 project_key + work_item_id，如 comment add）可跳过本步。

4. 执行：调用目标命令，遵循 references/performance.md 的并行/翻页规则。

并行与大结果

详见 references/performance.md：并行调用（必须串行的链路、可并行的组合）、大结果分批与翻页规则。

错误处理

总则：失败后从返回的 err_msg / inner_err 中提取错误原因，针对性修正后重试；最多自动重试 2 次，连续 3 次同类失败后停止并向用户说明。

熔断条件（立即终止，禁止盲目重试）：

• 空间未找到（project search 连续 3 次失败）
• Permission Denied（当前用户对该空间无访问权限）

详细自愈规则与错误速查表（涵盖字段格式、节点流转、人员转换等常见报错）见 references/error-handling.md。

操作指南（SOP）

具体操作的完整流程、字段转换和自愈机制见对应 SOP：

• 创建工作项 — 创建需求、任务、缺陷
• 更新工作项 — 修改字段、更新角色、追加内容
• 流转节点（节点流） — 完成/回滚节点、批量流转
• 流转状态（状态流） — 流转缺陷/issue、关闭 bug

Source: larksuite/meegle-cli — distributed by TomeVault.