Skip to content

docs(im): fix skill discoverability for +messages-search and +chat-messages-list - #1535

Closed
zhangheng023 wants to merge 1 commit into
mainfrom
docs/opt-im-skill-discoverability
Closed

docs(im): fix skill discoverability for +messages-search and +chat-messages-list#1535
zhangheng023 wants to merge 1 commit into
mainfrom
docs/opt-im-skill-discoverability

Conversation

@zhangheng023

@zhangheng023 zhangheng023 commented Jun 22, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • +messages-search:在 Shortcuts 表摘要中补全关键参数名(--query--chat-id 单值逗号分隔而非 --chat-ids--sender--start/--end),加 read reference before use 提示
  • +chat-messages-list:同样补全 --page-size(非 --page-limit)、--start/--end--sort asc|desc,加提示

背景

通过评测驱动优化(opt-workflow)发现:agent 直接从 Shortcuts 表摘要猜参数时,会用 --chat-ids(应为 --chat-id)和 --page-limit(应为 --page-size),导致命令调用失败。根因是摘要描述了功能但未点名易错参数名,agent 无法不读 reference 就用对。

本次改动直接在摘要行点出正确参数名,最大化可发现性,引导 agent 在需要精确用法时读 reference 文档。

验证

eval 数据(3 case × K=5 sealed run,commit 2752ed2b → 2d4edfe):

  • 效果分:0.933 → 0.967(+0.033 vs Φ0 noise band,seal PASS)
  • 改动文件:skills/lark-im/SKILL.md(T1 纯文档,2 行)

Test plan

  • seal eval PASS(3/3 × 5 runs,commit 2d4edfe
  • 人工确认 shortcuts 表参数描述准确(对照各 reference 文档)

Summary by CodeRabbit

Release Notes

  • Documentation
    • Updated chat messaging shortcuts documentation with corrected parameter names, clearer feature descriptions, and explicit usage guidance to enhance accuracy and user understanding.

…essages-list 关键参数名,修复触达缺失根因

Shortcuts 表两条命令摘要缺少易错参数名,agent 直接从摘要猜参数导致
--chat-ids(应为 --chat-id)和 --page-limit(应为 --page-size)用错,
现在摘要直接点名正确参数名并标注 "read reference before use"。
@github-actions github-actions Bot added domain/im PR touches the im domain size/M Single-domain feat or fix with limited business impact labels Jun 22, 2026
@coderabbitai

coderabbitai Bot commented Jun 22, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 510b181d-88f1-44e2-a40e-477c8cda0faa

📥 Commits

Reviewing files that changed from the base of the PR and between 824aa9e and 2d4edfe.

📒 Files selected for processing (1)
  • skills/lark-im/SKILL.md

📝 Walkthrough

Walkthrough

Documentation corrections in skills/lark-im/SKILL.md update the Shortcuts table: +chat-messages-list has its pagination flag corrected to --page-size, and +messages-search is clarified as user-only with --chat-id (not --chat-ids). Both entries gain explicit "read reference before use" notes, and nearby shortcut descriptions are refreshed.

Changes

lark-im Shortcut Documentation

Layer / File(s) Summary
Shortcut table description corrections
skills/lark-im/SKILL.md
Corrects +chat-messages-list pagination flag to --page-size, clarifies +messages-search as user-only with --chat-id (single comma-separated list, not --chat-ids), adds explicit "read reference before use" notes to both, and refreshes wording for +chat-search, +chat-update, +messages-mget, +messages-reply, and +messages-resources-download.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • larksuite/cli#812: Edits the same +chat-search row in skills/lark-im/SKILL.md, clarifying member filtering flag names in the same shortcut table.
  • larksuite/cli#865: Updates +messages-search and +chat-messages-list documentation in the same file, clarifying user-only constraints and correct bot workflows.

Suggested labels

domain/im, size/M

Suggested reviewers

  • liangshuo-1
  • YangJunzhou-01

Poem

🐇 A flag was wrong, a note was missed,
The shortcut table gave a twist —
--page-size now stands up right,
And user-only shines in light.
Read the reference, little coder friend,
The docs are tidy, start to end! 🌿

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change—fixing skill discoverability for two specific commands by improving parameter documentation.
Description check ✅ Passed The description provides comprehensive detail on the changes, background reasoning, and evaluation results, though the manual verification validation task is marked incomplete.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/opt-im-skill-discoverability

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov

codecov Bot commented Jun 22, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.79%. Comparing base (e53f9d9) to head (2d4edfe).
⚠️ Report is 55 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1535      +/-   ##
==========================================
+ Coverage   72.83%   73.79%   +0.96%     
==========================================
  Files         731      787      +56     
  Lines       69111    76142    +7031     
==========================================
+ Hits        50335    56191    +5856     
- Misses      14999    15742     +743     
- Partials     3777     4209     +432     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

npm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@2d4edfea2dfa10c60ae5b40bb0dc4be15db2cb8e

🧩 Skill update

npx skills add larksuite/cli#docs/opt-im-skill-discoverability -y -g

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain/im PR touches the im domain size/M Single-domain feat or fix with limited business impact

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant