Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

enhance: use more descriptive names for database tools #334

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

njhale
Copy link
Member

@njhale njhale commented Jan 10, 2025

To reduce confusion in both the LLM and tool maintainers, rename the following tools in the Database bundle:

  1. Tables -> List Tables
  2. Exec -> Exec Statement
  3. Query -> Run Query

Also fix tool descriptions to reflect the change from raw markdown output to JSON.

Addresses obot-platform/obot#1208

Since these tools are in the Capability category, the "blast radius" of this change includes the TableHandler implementation in obot and all tools/agents currently using them. That being the case, we
should hold-off on merging this change until the TableHandler implementation has been updated to the new tool names, or I keep duplicate tools that have the old names around until the handler implementation is updated.

To prevent collisions with other tools, it may behoove us to make these names even more descriptive -- e.g. Exec SQL Statement -- but I'd like to get some feedback on these names before I do that.

njhale added a commit to njhale/obot that referenced this pull request Jan 10, 2025
To reduce confusion in both the LLM and tool maintainers, rename the
following tools in the `Database` bundle:

1. `Tables` -> `List Tables`
2. `Exec` -> `Exec Statement`
3. `Query` -> `Run Query`

Also fix tool descriptions to reflect the change from raw markdown
output to JSON.

Addresses obot-platform/obot#1208

Since these tools are in the `Capability` category, the "blast
radius" of this change includes
[the `TableHandler` implementation in obot](https://github.com/obot-platform/obot/blob/31ceab62d455bd798a069be034ea8effb1b41ac4/ui/user/src/lib/components/navbar/Tables.svelte#L8)
and all tools/agents currently using them. That being the case, we
should hold-off on merging this change until the `TableHandler`
implementation has been updated to the new tool names. I can also keep
the old tools around until the handler implementation is updated.

To prevent collisions with other tools, it may behoove us to make these
names even more descriptive -- e.g. `Exec SQL Statement` -- but I'd like
to get some feedback on these names before I do that.

Signed-off-by: Nick Hale <[email protected]>
@njhale njhale force-pushed the enhance/rename-database-exec branch from b178ee0 to d20beeb Compare January 10, 2025 23:28
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