docs: correct MySQL skill repository registration - #2817
Open
mvanhorn wants to merge 1 commit into
Open
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
AgentScope-Java Version
Documentation-only change against the
docs/v2tree; it corrects a codesample and is not tied to one dependency version. The corrected snippet uses
ReActAgent.Builder.skillRepository(...), which is the current v2 API.Description
Replace the invalid
Toolkitregistration block in both localized quickstarts with the establishedReActAgent.builder()flow, passing the existingMysqlSkillRepositoryinstance toskillRepository(...). Add the imports and minimal agent builder context needed for each snippet to communicate where the repository belongs, following the examples in the building-block documentation. Keep repository construction, database setup, schema, and CRUD guidance unchanged because those sections describe valid APIs and are outside the reported defect.The Chinese MySQL skill repository quickstart instructs users to pass loaded skills to
Toolkit.registerSkill, butToolkithas no such method. The English counterpart contains the same invalid call, so users following either version receive a compile-time error. In the current API, repositories are attached to an agent throughReActAgent.Builder.skillRepository(...), which installs the dynamic skill middleware during agent construction. The defect is confined to the paired documentation examples; the repository and agent APIs already support the intended integration.Fixes #2657
Checklist
Please check the following items before code is ready to be reviewed.
mvn spotless:applyNot run: no test command resolved in this workspace, so nothing was executed to pass.
mvn test)Not run: no test command resolved in this workspace, so nothing was executed to pass.
N/A: this PR changes Markdown documentation only, no Java sources.
This PR is the documentation update: both the English and Chinese
MySQL skill-repository quickstarts.