---
type: email
from: Muhammad Hamid Raza <notifications@github.com>
subject: [openai/openai-agents-python] docs: Add external documentation link

 to LocalShellTool docstring (PR #1547)
received: 2026-03-05 10:13:15
date_header: Thu, 21 Aug 2025 00:30:20 -0700
priority: normal
status: awaiting_approval
uid: 28256
---

## Email Content

**From:** Muhammad Hamid Raza <notifications@github.com>
**Subject:** [openai/openai-agents-python] docs: Add external documentation link

 to LocalShellTool docstring (PR #1547)
**Date:** Thu, 21 Aug 2025 00:30:20 -0700

### Body (preview)

This pull request addresses the need for detailed documentation regarding the `LocalShellTool`.



Per the discussion in a previous pull request, it was decided that adding extensive details to the main documentation page would be too verbose. Instead, the recommended approach was to include a link to the detailed external documentation within the tool&#39;s docstring.



This change implements that decision by adding a direct link to the official guide in the `LocalShellTool` docstring. This approach keeps the primary documentation concise while providing a clear path for users to access in-depth information and security best practices for using the tool.

You can view, comment on, or merge this pull request online at:



  https://github.com/openai/openai-agents-python/pull/1547



-- Commit Summary --



  * Update tool.py



-- File Changes --



    M src/agents/tool.py (6)



-- Patch Links --



https://github.com/openai/openai-agents-python/pull/1547.patch

https://github.com/openai/openai-agents-python/pull/1547.diff



-- 

Reply to this email directly or view it on GitHub:

https://github.com/openai/openai-agents-python/pull/1547

You are receiving this because you are subscribed to this thread.



Message ID: &lt;openai/openai-agents-python/pull/1547@github.com&gt;

---

## Suggested Actions
- [ ] Reply
- [ ] Archive
- [ ] Escalate
