Update parameter handling of tools #618

yuancu · 2025-08-08T09:50:29Z

Description

The PR opensearch-project/ml-commons/pull/4053 introduced a change to parameter handling of tools. This leads to several IT failures.

This PR fixes these failures by updating the implementation. It standardizes parameter handling across all Tool implementations:

Updates all Tool interface implementations to use the new extractInputParameters utility
Updates release notes with these improvements

Related Issues

Resolves #617

Check List

New functionality includes testing.
New functionality has been documented.
API changes companion pull request created.
Commits are signed per the DCO using --signoff.
Public documentation issue/PR created.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

- Add utilities for extracting required parameters and JSON input parameters - Apply parameter extraction in AbstractRetrieverTool and RAGTool - Define TOOL_REQUIRED_PARAMS constant for consistent parameter handling Signed-off-by: Yuanchun Shen <yuanchu@amazon.com>

- Update all Tool interface implementations to use extractInputParameters utility Signed-off-by: Yuanchun Shen <yuanchu@amazon.com>

Signed-off-by: Yuanchun Shen <yuanchu@amazon.com>

zane-neo · 2025-08-08T10:22:04Z

src/main/java/org/opensearch/agent/tools/utils/ToolHelper.java

+     * @param attributes The tool attributes containing required parameter information
+     * @return A map containing only the required parameters or all parameters if no required parameters are specified
+     */
+    public static Map<String, String> extractRequiredParameters(Map<String, String> parameters, Map<String, ?> attributes) {


Do not copy the code, skills has dependency to ml-commons, re-use the method directly, if the module is not introduced, try introduce it or change the code in ml-commons.

Replaced with library method.

zane-neo · 2025-08-08T10:22:32Z

src/main/java/org/opensearch/agent/tools/utils/ToolConstants.java

    public static final String ALERTING_CONFIG_INDEX = ".opendistro-alerting-config";
    public static final String ALERTING_ALERTS_INDEX = ".opendistro-alerting-alerts";

+    public static final String TOOL_REQUIRED_PARAMS = "required_parameters";


Use the constant from ml-commons if possible

Thank you for pointing out. Fixed.

Signed-off-by: Yuanchun Shen <yuanchu@amazon.com>

codecov · 2025-08-08T14:05:10Z

Codecov Report

❌ Patch coverage is 75.00000% with 9 lines in your changes missing coverage. Please review.
✅ Project coverage is 74.97%. Comparing base (2b76e3c) to head (eec38d6).
⚠️ Report is 87 commits behind head on main.

Files with missing lines	Patch %	Lines
...a/org/opensearch/agent/tools/utils/ToolHelper.java	68.00%	7 Missing and 1 partial ⚠️
...java/org/opensearch/agent/tools/WebSearchTool.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main     #618      +/-   ##
============================================
- Coverage     81.78%   74.97%   -6.82%     
- Complexity      193      404     +211     
============================================
  Files            11       24      +13     
  Lines           961     2162    +1201     
  Branches        137      302     +165     
============================================
+ Hits            786     1621     +835     
- Misses          121      438     +317     
- Partials         54      103      +49

☔ 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.

Signed-off-by: Yuanchun Shen <yuanchu@amazon.com>

* Add parameter extraction utilities for tool inputs - Add utilities for extracting required parameters and JSON input parameters - Apply parameter extraction in AbstractRetrieverTool and RAGTool - Define TOOL_REQUIRED_PARAMS constant for consistent parameter handling Signed-off-by: Yuanchun Shen <yuanchu@amazon.com> * Standardize parameter handling in all Tool implementations - Update all Tool interface implementations to use extractInputParameters utility Signed-off-by: Yuanchun Shen <yuanchu@amazon.com> * Update release note Signed-off-by: Yuanchun Shen <yuanchu@amazon.com> * Declare origin of helper method extractInputParameters Signed-off-by: Yuanchun Shen <yuanchu@amazon.com> * Remove displaced comment in javadoc Signed-off-by: Yuanchun Shen <yuanchu@amazon.com> * Fix failed test in AbstractRetrieverToolTests Signed-off-by: Yuanchun Shen <yuanchu@amazon.com> * Replace copied tool utils to library ones Signed-off-by: Yuanchun Shen <yuanchu@amazon.com> --------- Signed-off-by: Yuanchun Shen <yuanchu@amazon.com> (cherry picked from commit addf057) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* Add parameter extraction utilities for tool inputs - Add utilities for extracting required parameters and JSON input parameters - Apply parameter extraction in AbstractRetrieverTool and RAGTool - Define TOOL_REQUIRED_PARAMS constant for consistent parameter handling * Standardize parameter handling in all Tool implementations - Update all Tool interface implementations to use extractInputParameters utility * Update release note * Declare origin of helper method extractInputParameters * Remove displaced comment in javadoc * Fix failed test in AbstractRetrieverToolTests * Replace copied tool utils to library ones --------- (cherry picked from commit addf057) Signed-off-by: Yuanchun Shen <yuanchu@amazon.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

yuancu added 3 commits August 8, 2025 17:03

Standardize parameter handling in all Tool implementations

12bf1b5

- Update all Tool interface implementations to use extractInputParameters utility Signed-off-by: Yuanchun Shen <yuanchu@amazon.com>

Update release note

e43de96

Signed-off-by: Yuanchun Shen <yuanchu@amazon.com>

yuancu changed the title ~~Issues/617~~ Update parameter handling of tools Aug 8, 2025

Declare origin of helper method extractInputParameters

30ce089

Signed-off-by: Yuanchun Shen <yuanchu@amazon.com>

zane-neo reviewed Aug 8, 2025

View reviewed changes

yuancu mentioned this pull request Aug 8, 2025

[AUTOCUT] Integration Test Failed for skills-3.2.0 #617

Closed

xinyual marked this pull request as ready for review August 8, 2025 12:01

xinyual requested review from Zhangxunmt, amitgalitz, b4sjoo, dbwiddis, dhrubo-os, eirsep, jackiehanyang, jngz-es, joshpalis, joshuali925, kaituo, lezzago, model-collapse, ohltyler, owaiskazi19, rbhavna, sbcd90, xinyual, ylwu-amzn and zhichao-aws as code owners August 8, 2025 12:01

Remove displaced comment in javadoc

b2db2c1

Signed-off-by: Yuanchun Shen <yuanchu@amazon.com>

Fix failed test in AbstractRetrieverToolTests

eec38d6

Signed-off-by: Yuanchun Shen <yuanchu@amazon.com>

yuancu force-pushed the issues/617 branch from ad3bdee to eec38d6 Compare August 8, 2025 13:28

Replace copied tool utils to library ones

af4ee49

Signed-off-by: Yuanchun Shen <yuanchu@amazon.com>

yuancu force-pushed the issues/617 branch from a6ad353 to af4ee49 Compare August 10, 2025 16:18

zane-neo approved these changes Aug 11, 2025

View reviewed changes

zane-neo merged commit addf057 into opensearch-project:main Aug 11, 2025
12 checks passed

zane-neo added the backport 3.2 label Aug 11, 2025

opensearch-trigger-bot bot mentioned this pull request Aug 11, 2025

[Backport 3.2] Update parameter handling of tools #619

Merged

yuancu deleted the issues/617 branch August 11, 2025 02:34

yuancu mentioned this pull request Aug 11, 2025

[RELEASE] Release version 3.2.0 #602

Open

23 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update parameter handling of tools #618

Update parameter handling of tools #618

Uh oh!

yuancu commented Aug 8, 2025 •

edited

Loading

Uh oh!

zane-neo Aug 8, 2025

Uh oh!

yuancu Aug 10, 2025

Uh oh!

zane-neo Aug 8, 2025

Uh oh!

yuancu Aug 10, 2025

Uh oh!

codecov bot commented Aug 8, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Update parameter handling of tools #618

Update parameter handling of tools #618

Uh oh!

Conversation

yuancu commented Aug 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Check List

Uh oh!

zane-neo Aug 8, 2025

Choose a reason for hiding this comment

Uh oh!

yuancu Aug 10, 2025

Choose a reason for hiding this comment

Uh oh!

zane-neo Aug 8, 2025

Choose a reason for hiding this comment

Uh oh!

yuancu Aug 10, 2025

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Aug 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

yuancu commented Aug 8, 2025 •

edited

Loading

codecov bot commented Aug 8, 2025 •

edited

Loading