[DOC] MLCommons Tools: Add attributes to toolspec

[pyek-bot]

Description

Adds attributes field for tools in ml-commons toolspec

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.

[pyek-bot]

Attributes is actually a map that can accept any key/value pairs and these are provided to the model for added context. Primarily use input_schema and strict to share context about the expected schema to the model. Any guidelines on how to define this in the spec?

[dblock]

Attributes is actually a map that can accept any key/value pairs and these are provided to the model for added context. Primarily use input_schema and strict to share context about the expected schema to the model. Any guidelines on how to define this in the spec?

An open structure with arbitrary key/value pairs is additionalProperties: true type of thing.

Start by adding/identifying a test into tests/default that you can run and that returns these fields.

[github-actions]

Changes Analysis

Commit SHA: 20ce07c
Comparing To SHA: c042c5f

API Changes

Summary

├─┬Paths
│ └─┬/_plugins/_ml/tools/{tool_name}
│   └─┬GET
│     └─┬Parameters
│       └─┬Schema
│         └──[➕] enum (24204:13)
└─┬Components
  ├──[➕] schemas (59122:7)
  ├─┬ml._common___ToolItems
  │ ├──[➕] properties (59142:9)
  │ ├──[➕] properties (59136:9)
  │ ├─┬parameters
  │ │ └──[🔀] $ref (59141:11)❌ 
  │ └─┬include_output_in_agent_response
  │   └──[🔀] $ref (59122:13)❌ 
  └─┬ml._common___Tool
    └─┬attributes
      └──[🔀] $ref (59122:13)❌ 

Document Element	Total Changes	Breaking Changes
components	6	3
paths	1	0

• ❌ BREAKING Changes: 3 out of 7
• Modifications: 3
• Additions: 4
• Breaking Modifications: 3

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/14917927391/artifacts/3090308855

API Coverage

	Before	After	Δ
Covered (%)	663 (64.94 %)	663 (64.94 %)	0 (0 %)
Uncovered (%)	358 (35.06 %)	358 (35.06 %)	0 (0 %)
Unknown	53	53	0

[github-actions]

Spec Test Coverage Analysis

Total	Tested
603	601 (99.67 %)

[pyek-bot]

Attributes is actually a map that can accept any key/value pairs and these are provided to the model for added context. Primarily use input_schema and strict to share context about the expected schema to the model. Any guidelines on how to define this in the spec?

An open structure with arbitrary key/value pairs is additionalProperties: true type of thing.

Start by adding/identifying a test into tests/default that you can run and that returns these fields.

Thanks @dblock! I was able to validate the schema by running tests/plugins/ml/ml/agents.yaml & tests/plugins/ml/ml/tools.yaml tests.

[pyek-bot]

Do you mind reviewing the PR please? Thanks!

[Xtansia]

Changes generally look good, have added some comments for how to get the CI failures to green. Please also add an entry to the CHANGELOG.md

[pyek-bot]

Thanks for the review @Xtansia ! I have addressed the comments, please take a look. Will track the CI.

[dblock]

This PR should include tests that return these new structures.

[pyek-bot]

This PR should include tests that return these new structures.

/tests/plugins/ml/ml/tools.yaml (specifically /_plugins/_ml/tools) and /tests/plugins/ml/ml/agents.yaml (specifically /_plugins/_ml/agents/_register) already cover these scenarios.

When I modify the attributes spec, these tend to fail.

[Xtansia]

Thanks @pyek-bot!

Can confirm it's covered by existing tests, as I had to add a version of the attributes property to get tests passing in #889