Skip to content

docs: Correct and clarify LocalShellTool documentation #1538

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

docs: Correct and clarify LocalShellTool documentation #1538

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions docs/tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,14 @@ Tools let agents take actions: things like fetching data, running code, calling

OpenAI offers a few built-in tools when using the [`OpenAIResponsesModel`][agents.models.openai_responses.OpenAIResponsesModel]:

- The [`WebSearchTool`][agents.tool.WebSearchTool] lets an agent search the web.
- The [`FileSearchTool`][agents.tool.FileSearchTool] allows retrieving information from your OpenAI Vector Stores.
- The [`ComputerTool`][agents.tool.ComputerTool] allows automating computer use tasks.
- The [`CodeInterpreterTool`][agents.tool.CodeInterpreterTool] lets the LLM execute code in a sandboxed environment.
- The [`HostedMCPTool`][agents.tool.HostedMCPTool] exposes a remote MCP server's tools to the model.
- The [`ImageGenerationTool`][agents.tool.ImageGenerationTool] generates images from a prompt.
- The [`LocalShellTool`][agents.tool.LocalShellTool] runs shell commands on your machine.
- The [`WebSearchTool`][agents.tool.WebSearchTool] lets an agent search the web for real-time information.
- The [`FileSearchTool`][agents.tool.FileSearchTool] allows retrieving information from your OpenAI Vector Stores or uploaded files.
- The [`ComputerTool`][agents.tool.ComputerTool] enables automating computer tasks programmatically.
- The [`CodeInterpreterTool`][agents.tool.CodeInterpreterTool] lets the LLM execute code safely in a sandboxed environment.
- The [`HostedMCPTool`][agents.tool.HostedMCPTool] exposes a remote MCP server's tools to the agent.
- The [`ImageGenerationTool`][agents.tool.ImageGenerationTool] generates images from text prompts using a hosted service.
- The [`LocalShellTool`][agents.tool.LocalShellTool] allows running shell commands on your **local machine**. ⚠️ **This is not a hosted tool** — be careful with permissions and security.


```python
from agents import Agent, FileSearchTool, Runner, WebSearchTool
Expand Down