Skip to content

docs: clarify base search routing#708

Merged
kongenpei merged 4 commits intomainfrom
codex/lark-base-search-guidance
Apr 29, 2026
Merged

docs: clarify base search routing#708
kongenpei merged 4 commits intomainfrom
codex/lark-base-search-guidance

Conversation

@kongenpei
Copy link
Copy Markdown
Collaborator

@kongenpei kongenpei commented Apr 29, 2026

Summary

Clarify the lark-base skill route for finding Base/bitable resources by name or keyword before doing table-level operations. This helps agents avoid inventing nonexistent Base search commands and instead use the existing cloud-space search shortcut.

Changes

  • Add Base name/keyword discovery to the lark-base skill description.
  • Document the correct search route: read lark-doc/references/lark-doc-search.md, run lark-cli docs +search --query ... --filter '{"doc_types":["BITABLE"]}', then return to lark-cli base +....
  • Explicitly reject invalid guessed commands such as base +search, lark-doc +search, and drive +search.

Test Plan

  • Unit tests pass: make unit-test
  • Manual local verification confirms the lark xxx command works as expected
    • git diff --check -- skills/lark-base/SKILL.md
    • acpx practical verification was run before this PR: Codex followed the route in 2/2 cases; Coco followed it when it read the skill/reference, and the skill text was tightened based on the observed failure mode.

Related Issues

  • None

Summary by CodeRabbit

  • Documentation
    • Added a resource-discovery flow for Base: guidance to search for Base/multitable resources by name or keywords before operating.
    • Registered an actionable search command in the Base navigation and clarified when to prefer search for ambiguous requests.
    • Clarified unsupported search variants and linked to deeper search reference.

@kongenpei kongenpei requested a review from zgz2048 April 29, 2026 05:41
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 29, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: c8ded911-7960-467e-b757-66c783999d7a

📥 Commits

Reviewing files that changed from the base of the PR and between e53d73f and 7602ac0.

📒 Files selected for processing (1)
  • skills/lark-base/SKILL.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • skills/lark-base/SKILL.md

📝 Walkthrough

Walkthrough

This change updates skills/lark-base/SKILL.md to add an explicit Base resource-discovery flow: instruct users to run lark-cli docs +search (filter BITABLE) when only a Base name/keywords are provided, register the command in module navigation, and forbid unsupported +search variants.

Changes

Cohort / File(s) Summary
Skill Documentation
skills/lark-base/SKILL.md
Added resource-discovery guidance using lark-cli docs +search (filter=BITABLE), integrated discovery into pre-execution routing/decision logic, added a “资源发现” navigation entry, and documented prohibited +search variants and referral to lark-doc-search for complex cases.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Router as Pre-exec Router
    participant CLI as lark-cli
    participant DocsSearch as lark-docs(+search)
    participant BaseModule as Base Module

    User->>Router: Provide Base identifier (name/keywords)
    Router->>CLI: Invoke `docs +search` (filter=BITABLE)
    CLI->>DocsSearch: Run search query
    DocsSearch-->>CLI: Return matched resources
    CLI-->>Router: Deliver discovered resources
    Router->>BaseModule: Route with selected Base URL
    BaseModule-->>User: Continue Base commands
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested labels

documentation

Suggested reviewers

  • zgz2048
  • fangshuyu-768

Poem

🐰 I hopped through docs with eager cheer,
I sniffed for Base and bitable near,
"Run docs +search" I softly sing,
Found the URL — then routing takes wing,
Hooray — discovery makes work clear!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and concisely summarizes the main change: clarifying the Base search routing documentation in the lark-base skill.
Description check ✅ Passed The description includes all required template sections with complete information about the changes, test verification, and search routing details.
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 codex/lark-base-search-guidance

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
Review rate limit: 7/8 reviews remaining, refill in 7 minutes and 30 seconds.

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

@github-actions github-actions Bot added domain/base PR touches the base domain size/M Single-domain feat or fix with limited business impact labels Apr 29, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 29, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 64.06%. Comparing base (6bb988a) to head (7602ac0).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #708      +/-   ##
==========================================
+ Coverage   63.80%   64.06%   +0.26%     
==========================================
  Files         500      503       +3     
  Lines       43531    44091     +560     
==========================================
+ Hits        27773    28249     +476     
- Misses      13317    13382      +65     
- Partials     2441     2460      +19     

☔ View full report in Codecov by Sentry.
📢 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.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
skills/lark-base/SKILL.md (1)

17-17: Optional: Consider minor phrasing adjustment for clarity.

The static analysis tool flagged potential ambiguity in the phrase "按名称/关键词查找 Base、多维表格、bitable 或报表". While the meaning is clear in context, you could optionally rephrase for maximum clarity, such as:

  • "如果用户要按名称或关键词查找 Base(多维表格/bitable)或报表"
  • "如果用户要通过名称/关键词定位 Base、多维表格、bitable 或报表资源"

However, given that the PR objectives mention successful practical verification where agents followed the guidance correctly, the current phrasing appears adequate.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@skills/lark-base/SKILL.md` at line 17, The phrase "按名称/关键词查找
Base、多维表格、bitable 或报表" in SKILL.md may be slightly ambiguous; please optionally
rephrase that sentence to improve clarity by replacing that fragment with one of
the suggested alternatives (e.g., "按名称或关键词查找 Base(多维表格/bitable)或报表" or
"通过名称/关键词定位 Base、多维表格、bitable 或报表资源") while keeping the rest of the guidance and
the referenced lark-cli commands intact.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@skills/lark-base/SKILL.md`:
- Line 17: The phrase "按名称/关键词查找 Base、多维表格、bitable 或报表" in SKILL.md may be
slightly ambiguous; please optionally rephrase that sentence to improve clarity
by replacing that fragment with one of the suggested alternatives (e.g.,
"按名称或关键词查找 Base(多维表格/bitable)或报表" or "通过名称/关键词定位 Base、多维表格、bitable 或报表资源") while
keeping the rest of the guidance and the referenced lark-cli commands intact.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 817e359c-3cc8-4f16-8b49-7161196e9278

📥 Commits

Reviewing files that changed from the base of the PR and between 6bb988a and d796da7.

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

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 29, 2026

🚀 PR Preview Install Guide

🧰 CLI update

npm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@7602ac0b382ebd9d942f8221fcee455490a3effe

🧩 Skill update

npx skills add larksuite/cli#codex/lark-base-search-guidance -y -g

@kongenpei kongenpei force-pushed the codex/lark-base-search-guidance branch from d796da7 to 47d6500 Compare April 29, 2026 05:54
@kongenpei kongenpei force-pushed the codex/lark-base-search-guidance branch from 47d6500 to e53d73f Compare April 29, 2026 07:46
@kongenpei kongenpei merged commit 7fc963f into main Apr 29, 2026
30 of 32 checks passed
@kongenpei kongenpei deleted the codex/lark-base-search-guidance branch April 29, 2026 08:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain/base PR touches the base 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.

2 participants