Skip to content

docs(base): clarify unsupported capability boundaries - #2133

Open
huarenmin13 wants to merge 6 commits into
larksuite:mainfrom
huarenmin13:agent/base-capability-boundaries
Open

docs(base): clarify unsupported capability boundaries#2133
huarenmin13 wants to merge 6 commits into
larksuite:mainfrom
huarenmin13:agent/base-capability-boundaries

Conversation

@huarenmin13

@huarenmin13 huarenmin13 commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Summary

Clarify Base agent behavior when a requested operation is outside the current CLI/OpenAPI capability surface. This consolidates two evaluated guidance changes into one minimal patch, while avoiding the general create-semantics guidance already covered by #2114.

The root failure mode was repeated exploration of unsupported view properties or field types, plus ambiguity around the scope and verification of single-table copies. This change turns those cases into explicit, reusable boundaries without changing API request behavior.

Changes

  • Document that view row height, frozen columns, column width, and similar UI-only appearance settings are unsupported, without defining an incomplete closed list of supported view properties.
  • Clarify that there is no atomic +table-copy shortcut: compose existing commands according to the user-requested schema, records, and views scope, and use the existing write-response-first verification rule.
  • Treat field types absent from the field JSON reference as unsupported instead of guessing unregistered JSON, service, or schema shapes or substituting another field type.
  • Keep focused contract coverage for the three capability facts without embedding evaluation identifiers or historical command traces.

Scope intentionally excludes the same-name view auto-rename implementation and does not repeat #2114 generic create-evidence rule.

Test Plan

  • Focused Base capability contract test
  • go test -count=1 ./shortcuts/base
  • make unit-test
  • go vet ./...
  • gofmt -l . produces no output
  • go mod tidy leaves go.mod and go.sum unchanged
  • go run github.com/golangci/golangci-lint/v2/cmd/golangci-lint@v2.1.6 run --new-from-rev=upstream/main reports 0 issues
  • Skill format check
  • make build and current-branch embedded Skill read expose all three boundaries

Related Issues

Summary by CodeRabbit

  • Documentation

    • Clarified that unsupported view appearance settings should be declined rather than approximated.
    • Added guidance for copying single tables using available commands.
    • Documented that unsupported field types should be rejected without guessing schemas, APIs, or substitutes.
  • Tests

    • Added coverage to verify that required capability guidance remains present, including restrictions on unsupported settings, field types, and raw API usage.

Consolidate the retained Base guidance into generic capability rules.

Document unsupported view appearance settings, the current single-table copy contract, and unsupported field handling without carrying over same-name rename behavior or evaluation-specific command traces.
@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 Jul 31, 2026
@coderabbitai

coderabbitai Bot commented Jul 31, 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 Plus

Run ID: 0e9ab662-bc79-4c84-93a8-00017e228284

📥 Commits

Reviewing files that changed from the base of the PR and between c04b491 and c4d35f6.

📒 Files selected for processing (2)
  • shortcuts/base/base_capability_contract_test.go
  • skills/lark-base/SKILL.md
💤 Files with no reviewable changes (1)
  • skills/lark-base/SKILL.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • shortcuts/base/base_capability_contract_test.go

📝 Walkthrough

Walkthrough

The Base documentation now defines unsupported view settings and field types. A contract test loads the documentation and verifies the required refusal guidance, including single-table copying and raw API boundaries.

Changes

Base capability guidance

Layer / File(s) Summary
Document unsupported Base capabilities
skills/lark-base/SKILL.md, skills/lark-base/references/lark-base-field-json.md
The documentation rejects unsupported view settings and field types. It prohibits undocumented API use, guessed schemas, and substitute field types.
Validate capability guidance
shortcuts/base/base_capability_contract_test.go
The test reads both guidance files through the virtual filesystem, normalizes whitespace, and checks the required capability boundaries.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the documentation changes for unsupported Base capabilities.
Description check ✅ Passed The description includes a clear summary, detailed changes, completed test plan, and related issue information.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

Avoid an incomplete closed list of supported view properties and scope table-copy guidance to the user's requested resources.

Replace evaluation-trace blacklists with three focused capability contract checks.
@huarenmin13
huarenmin13 marked this pull request as ready for review July 31, 2026 09:26

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@shortcuts/base/base_capability_contract_test.go`:
- Around line 26-34: Extend the contract assertions in the test around the
existing view-appearance, single-table-copy, and unsupported-field-type checks
to require the mandated stop/refusal behaviors: “说明能力边界并停止”, “说明当前 CLI 不支持并停止”,
and the raw-API prohibition. Keep the existing trigger and guidance assertions,
and fail with targeted messages when any required action is missing.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: f70c5174-581c-426a-a059-bfe949fe5fff

📥 Commits

Reviewing files that changed from the base of the PR and between 5cf09ec and c04b491.

📒 Files selected for processing (3)
  • shortcuts/base/base_capability_contract_test.go
  • skills/lark-base/SKILL.md
  • skills/lark-base/references/lark-base-field-json.md

Comment thread shortcuts/base/base_capability_contract_test.go Outdated
Comment thread skills/lark-base/SKILL.md Outdated
Comment thread shortcuts/base/base_capability_contract_test.go Outdated
Comment thread shortcuts/base/base_capability_contract_test.go Outdated
1. Delete the prose-fragment assertions for the shipped Base skill guidance
@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

npx skills add huarenmin13/cli#agent/base-capability-boundaries -y -g

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.

3 participants