Skip to content

Conversation

Yuan325
Copy link
Contributor

@Yuan325 Yuan325 commented Apr 2, 2025

Add tools-file flag and deprecate tools_file flag. This is not a breaking change. The old tools_file flag is still usable.

User will see the following message when using tools_file flag:

Flag --tools_file has been deprecated, please use --tools-file instead
2025-04-03T10:09:12.803165-07:00 INFO "Initialized 2 sources."

Help command will reveal the new flag:

...
      --telemetry-service-name string   Sets the value of the service.name resource attribute for telemetry data. (default "toolbox")
      --tools-file string               File path specifying the tool configuration. (default "tools.yaml")
  -v, --version                         version for toolbox
...

Fixes #383

@Yuan325 Yuan325 requested a review from a team as a code owner April 2, 2025 21:10
@kurtisvg kurtisvg changed the title chore: normalize flag names feat: normalize flags with underscore to hypen names Apr 2, 2025
@kurtisvg kurtisvg changed the title feat: normalize flags with underscore to hypen names feat: normalize flags with underscore to hypen Apr 2, 2025
Copy link
Collaborator

@kurtisvg kurtisvg left a comment

Choose a reason for hiding this comment

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

Are we worried about any future backwards compatibility features here? If we start accepting both hypen and underscore we will have to forever?

Alternatively, would we be better to add a one-off exception for tools-file?

We should also update docs to the preffered

@Yuan325 Yuan325 force-pushed the updates branch 2 times, most recently from 8c750f4 to e7a3f21 Compare April 3, 2025 17:42
@Yuan325 Yuan325 changed the title feat: normalize flags with underscore to hypen chore: deprecate tools_file and add tools-file flag Apr 3, 2025
@kurtisvg kurtisvg changed the title chore: deprecate tools_file and add tools-file flag feat: add tools-file flag and deprecate tools_file Apr 3, 2025
@kurtisvg kurtisvg changed the title feat: add tools-file flag and deprecate tools_file feat: add tools-file flag and deprecate tools_file Apr 3, 2025
@kurtisvg kurtisvg changed the title feat: add tools-file flag and deprecate tools_file fix: add tools-file flag and deprecate tools_file Apr 3, 2025
@Yuan325 Yuan325 merged commit 34a7263 into main Apr 3, 2025
6 checks passed
@Yuan325 Yuan325 deleted the updates branch April 3, 2025 18:09
kurtisvg pushed a commit that referenced this pull request Apr 4, 2025
Add `tools-file` flag and deprecate `tools_file` flag. This is not a
breaking change. The old `tools_file` flag is still usable.

User will see the following message when using `tools_file` flag: 
```
Flag --tools_file has been deprecated, please use --tools-file instead
2025-04-03T10:09:12.803165-07:00 INFO "Initialized 2 sources."
```

Help command will reveal the new flag: 
```
...
      --telemetry-service-name string   Sets the value of the service.name resource attribute for telemetry data. (default "toolbox")
      --tools-file string               File path specifying the tool configuration. (default "tools.yaml")
  -v, --version                         version for toolbox
...
```

Fixes #383
Yuan325 pushed a commit that referenced this pull request Apr 4, 2025
🤖 I have created a release *beep* *boop*
---


##
[0.3.0](v0.2.1...v0.3.0)
(2025-04-04)


### Features

* Add 'alloydb-ai-nl' tool
([#358](#358))
([f02885f](f02885f))
* Add HTTP Source and Tool
([#332](#332))
([64da5b4](64da5b4))
* Adding support for Model Context Protocol (MCP).
([#396](#396))
([a7d1d4e](a7d1d4e))
* Added [toolbox-core](https://pypi.org/project/toolbox-core/) SDK –
easily integrate Toolbox into any Python function calling framework


### Bug Fixes

* Add `tools-file` flag and deprecate `tools_file`
([#384](#384))
([34a7263](34a7263)),
closes [#383](#383)

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

---------

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
Co-authored-by: Kurtis Van Gent <31518063+kurtisvg@users.noreply.github.com>
github-actions bot pushed a commit that referenced this pull request Apr 4, 2025
🤖 I have created a release *beep* *boop*
---

##
[0.3.0](v0.2.1...v0.3.0)
(2025-04-04)

### Features

* Add 'alloydb-ai-nl' tool
([#358](#358))
([f02885f](f02885f))
* Add HTTP Source and Tool
([#332](#332))
([64da5b4](64da5b4))
* Adding support for Model Context Protocol (MCP).
([#396](#396))
([a7d1d4e](a7d1d4e))
* Added [toolbox-core](https://pypi.org/project/toolbox-core/) SDK –
easily integrate Toolbox into any Python function calling framework

### Bug Fixes

* Add `tools-file` flag and deprecate `tools_file`
([#384](#384))
([34a7263](34a7263)),
closes [#383](#383)

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

---------

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
Co-authored-by: Kurtis Van Gent <31518063+kurtisvg@users.noreply.github.com> 12222fe
github-actions bot pushed a commit to renovate-bot/googleapis-_-genai-toolbox that referenced this pull request Apr 4, 2025
🤖 I have created a release *beep* *boop*
---

##
[0.3.0](googleapis/genai-toolbox@v0.2.1...v0.3.0)
(2025-04-04)

### Features

* Add 'alloydb-ai-nl' tool
([googleapis#358](googleapis#358))
([f02885f](googleapis@f02885f))
* Add HTTP Source and Tool
([googleapis#332](googleapis#332))
([64da5b4](googleapis@64da5b4))
* Adding support for Model Context Protocol (MCP).
([googleapis#396](googleapis#396))
([a7d1d4e](googleapis@a7d1d4e))
* Added [toolbox-core](https://pypi.org/project/toolbox-core/) SDK –
easily integrate Toolbox into any Python function calling framework

### Bug Fixes

* Add `tools-file` flag and deprecate `tools_file`
([googleapis#384](googleapis#384))
([34a7263](googleapis@34a7263)),
closes [googleapis#383](googleapis#383)

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

---------

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
Co-authored-by: Kurtis Van Gent <31518063+kurtisvg@users.noreply.github.com> 12222fe
Yuan325 added a commit that referenced this pull request May 5, 2025
Updating docs to use the `--tools-file` flag over the now deprecated
`--tools_file`.

The new flag was added as of `v0.3.0` in #384 

This change reduces confusion as current usage in docs results in
following message on startup of Toolbox server:

```sh
Flag --tools_file has been deprecated, please use --tools-file instead
```

Fixes #514

---------

Co-authored-by: Yuan <45984206+Yuan325@users.noreply.github.com>
github-actions bot pushed a commit that referenced this pull request May 5, 2025
Updating docs to use the `--tools-file` flag over the now deprecated
`--tools_file`.

The new flag was added as of `v0.3.0` in #384

This change reduces confusion as current usage in docs results in
following message on startup of Toolbox server:

```sh
Flag --tools_file has been deprecated, please use --tools-file instead
```

Fixes #514

---------

Co-authored-by: Yuan <45984206+Yuan325@users.noreply.github.com> c7189e9
github-actions bot pushed a commit to renovate-bot/googleapis-_-genai-toolbox that referenced this pull request May 5, 2025
…leapis#524)

Updating docs to use the `--tools-file` flag over the now deprecated
`--tools_file`.

The new flag was added as of `v0.3.0` in googleapis#384

This change reduces confusion as current usage in docs results in
following message on startup of Toolbox server:

```sh
Flag --tools_file has been deprecated, please use --tools-file instead
```

Fixes googleapis#514

---------

Co-authored-by: Yuan <45984206+Yuan325@users.noreply.github.com> c7189e9
jeffreyrubi pushed a commit to jeffreyrubi/genai-toolbox that referenced this pull request Jun 7, 2025
Add `tools-file` flag and deprecate `tools_file` flag. This is not a
breaking change. The old `tools_file` flag is still usable.

User will see the following message when using `tools_file` flag: 
```
Flag --tools_file has been deprecated, please use --tools-file instead
2025-04-03T10:09:12.803165-07:00 INFO "Initialized 2 sources."
```

Help command will reveal the new flag: 
```
...
      --telemetry-service-name string   Sets the value of the service.name resource attribute for telemetry data. (default "toolbox")
      --tools-file string               File path specifying the tool configuration. (default "tools.yaml")
  -v, --version                         version for toolbox
...
```

Fixes googleapis#383
jeffreyrubi pushed a commit to jeffreyrubi/genai-toolbox that referenced this pull request Jun 7, 2025
🤖 I have created a release *beep* *boop*
---


##
[0.3.0](googleapis/genai-toolbox@v0.2.1...v0.3.0)
(2025-04-04)


### Features

* Add 'alloydb-ai-nl' tool
([googleapis#358](googleapis#358))
([f02885f](googleapis@f02885f))
* Add HTTP Source and Tool
([googleapis#332](googleapis#332))
([64da5b4](googleapis@64da5b4))
* Adding support for Model Context Protocol (MCP).
([googleapis#396](googleapis#396))
([a7d1d4e](googleapis@a7d1d4e))
* Added [toolbox-core](https://pypi.org/project/toolbox-core/) SDK –
easily integrate Toolbox into any Python function calling framework


### Bug Fixes

* Add `tools-file` flag and deprecate `tools_file`
([googleapis#384](googleapis#384))
([34a7263](googleapis@34a7263)),
closes [googleapis#383](googleapis#383)

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

---------

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
Co-authored-by: Kurtis Van Gent <31518063+kurtisvg@users.noreply.github.com>
jeffreyrubi pushed a commit to jeffreyrubi/genai-toolbox that referenced this pull request Jun 7, 2025
Updating docs to use the `--tools-file` flag over the now deprecated
`--tools_file`.

The new flag was added as of `v0.3.0` in googleapis#384 

This change reduces confusion as current usage in docs results in
following message on startup of Toolbox server:

```sh
Flag --tools_file has been deprecated, please use --tools-file instead
```

Fixes googleapis#514

---------

Co-authored-by: Yuan <45984206+Yuan325@users.noreply.github.com>
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.

Add support for --tools-file alias
3 participants