Skip to content

docs: sync README and skill with tool registry - #739

Merged
zereight merged 1 commit into
mainfrom
automation/readme-skill-sync
Sep 12, 2026
Merged

zereight merged 1 commit into
mainfrom
automation/readme-skill-sync

Conversation

@zereight

Copy link
Copy Markdown
Owner

Regenerate the README.md TOOLS-START/TOOLS-END numbered list from tools/registry.ts base descriptions.

Verification (against origin/main 40e13c5):

  • Skill: npm run check:skill-sync passes, no skill changes needed.
  • English README: 262/262 tools, names/count/order/descriptions all match registry (115 stale description lines updated, 147 unchanged).
  • README.ko.md / README.zh-CN.md: tool sections link to the English Tools section correctly (anchor verified); category summaries describe real toolsets with no false claims, no changes needed.

This PR contains README.md only. No force-push used.

Regenerate the TOOLS-START/TOOLS-END numbered list from
tools/registry.ts base descriptions so names, count, order, and
descriptions match exactly (262/262, 0 mismatches). Updates 115
stale description lines; 147 entries unchanged.

Skill check (npm run check:skill-sync) passes unmodified; ko/zh
README tool sections already link to the English Tools section
correctly and their category summaries remain accurate.
@coderabbitai

coderabbitai Bot commented Sep 12, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 6b83ecb1-1df1-4566-93f7-e90793cd1081

📥 Commits

Reviewing files that changed from the base of the PR and between 40e13c5 and 41463f6.

📒 Files selected for processing (1)
  • README.md

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.

📜 Recent review details
⏰ Context from checks skipped due to timeout. (5)
  • GitHub Check: test
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: Analyze (python)
  • GitHub Check: Analyze (actions)
  • GitHub Check: Analyze (ruby)
🧰 Additional context used
🪛 LanguageTool
README.md

[grammar] ~649-~649: Ensure spelling is correct
Context: ... - Add an emoji reaction to an issue (e.g. thumbsup, rocket, eyes) 65. `delete_issue_emoji_...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🔇 Additional comments (2)
README.md (2)

586-591: LGTM!

Also applies to: 593-593, 596-602, 611-615, 618-619, 627-627, 631-631, 638-638, 646-646, 653-658, 663-663, 667-669, 680-681, 683-686, 688-691, 699-700, 706-707, 712-712, 720-720, 722-722, 724-724, 749-754, 756-758, 763-763, 765-765, 767-767, 778-779, 781-785, 788-791, 793-798, 799-807, 814-817, 820-837


736-736: 🎯 Functional Correctness

No README change is needed for play_pipeline_schedule.

tools/registry.ts applies getToolDescription, which preserves the next_run_at contract. README line 736 is only a short tool index entry.


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated the MCP tool catalog descriptions for tools 1–252 with shorter, clearer wording.
    • Clarified selected behaviors, including summaries, filtering, authentication, dry-run handling, artifact paths, OAuth and session behavior, work-item capabilities, and dependency-proxy pagination.
    • Refined the pipeline schedule tool description.

Walkthrough

The README MCP tool catalog was revised across tools 1–252. Descriptions use shorter wording and clarify selected behavior, including filtering, summaries, authentication, dry-run handling, artifact paths, work items, OAuth sessions, and dependency-proxy pagination.

Changes

MCP tool catalog

Layer / File(s) Summary
Core tool description updates
README.md
Descriptions for project, merge-request, issue, namespace, wiki, repository, pipeline, deployment, environment, trigger, job, and CI lint tools were shortened or clarified.
Artifact and integration behavior updates
README.md
Descriptions for schedules, artifacts, milestones, commits, downloads, releases, work items, webhooks, variables, and dependency proxies were updated. The schedule description no longer states that the next scheduled run remains unchanged.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~10 minutes

Change: Other

Suggested reviewers: agent-hellboy

Merge Risk: ⚪ Minimal · up to 41463

The documentation update is ready to merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately identifies the README synchronization with the tool registry. The skill reference is extra because the PR makes no skill changes, but it remains related to the reported verificati…
Description check ✅ Passed The description clearly explains that README.md was regenerated from tools/registry.ts and summarizes the verification results.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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
  • Commit unit tests in branch automation/readme-skill-sync
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch automation/readme-skill-sync

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.

@zereight
zereight merged commit f786b13 into main Sep 12, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant