Skip to content

docs: list bash in get_skill_tools Returns docstring#2198

Open
anxkhn wants to merge 1 commit into
kagent-dev:mainfrom
anxkhn:docs/fix-get-skill-tools-returns-docstring
Open

docs: list bash in get_skill_tools Returns docstring#2198
anxkhn wants to merge 1 commit into
kagent-dev:mainfrom
anxkhn:docs/fix-get-skill-tools-returns-docstring

Conversation

@anxkhn

@anxkhn anxkhn commented Jul 9, 2026

Copy link
Copy Markdown
Contributor
## What

`get_skill_tools` in `python/packages/kagent-openai/src/kagent/openai/tools/_tools.py`
returns five tools:

    return [get_skill_tool(skills_directory), read_file, write_file, edit_file, bash]

but its `Returns:` docstring only listed the first four, omitting `bash`:

    A list of FunctionTool instances: skills tool, read_file, write_file, edit_file

This updates the docstring to enumerate all five tools so it matches what the
function actually returns.

## Why

`get_skill_tools` is the entry point that assembles the toolset granted to a
skills-enabled agent. `bash` is a real tool (`@function_tool(name_override="bash")`)
that executes shell commands, so leaving it out of the docstring understates the
capability, and security, surface: a reader relying on the docstring would not
realize a shell-execution tool is included in the returned set.

## Change

    -        A list of FunctionTool instances: skills tool, read_file, write_file, edit_file
    +        A list of FunctionTool instances: skills tool, read_file, write_file, edit_file, and bash

## Testing

Documentation-only change; no behavior is affected. `ruff check` and
`ruff format --check` pass on the file.

get_skill_tools returns five tools (skills, read_file, write_file,
edit_file, bash), but the Returns docstring only listed the first four,
omitting the bash execution tool. Add bash so the docstring reflects the
full toolset actually granted.

Signed-off-by: Anas Khan <83116240+anxkhn@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 9, 2026 20:34
@anxkhn anxkhn requested a review from a team as a code owner July 9, 2026 20:34
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 9, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates the get_skill_tools docstring in kagent-openai so its Returns: section accurately reflects the full tool list the function returns (including the bash tool), improving correctness and clarity around the agent’s available capabilities.

Changes:

  • Amend get_skill_tools Returns: docstring to include bash alongside the other four tools.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants