---
type: email
from: Abdul Samad Siddiqui <notifications@github.com>
subject: [openai/openai-agents-python] Add missing docstrings to function_tool

 examples in model_providers (PR #1796)
received: 2026-03-06 07:42:50
date_header: Wed, 24 Sep 2025 02:35:39 -0700
priority: normal
status: awaiting_approval
uid: 31211
---

## Email Content

**From:** Abdul Samad Siddiqui <notifications@github.com>
**Subject:** [openai/openai-agents-python] Add missing docstrings to function_tool

 examples in model_providers (PR #1796)
**Date:** Wed, 24 Sep 2025 02:35:39 -0700

### Body (preview)

Added missing docstrings to `@function_tool` decorated functions in the model_providers example files to improve LLM agent tool understanding.



## Changes

- Added descriptive docstrings to function tools in 5 model provider example files

- Added return type annotations for consistency

- No functional changes - documentation improvement only



## Why this matters

The OpenAI Agents SDK uses function docstrings to generate tool descriptions that help LLMs understand when and how to use tools. The [official documentation](https://openai.github.io/openai-agents-python/tools/) states that &quot;Tool description will be taken from the docstring of the function.&quot;



Without proper docstrings, developers following these examples may create tools that agents struggle to use effectively.



## Files changed

- `examples/model_providers/custom_example_agent.py`

- `examples/model_providers/custom_example_global.py`

- `examples/model_providers/custom_example_provider.py`  

- `examples/model_providers/litellm_auto.py`

- `examples/model_providers/litellm_provider.py`



## Testing

All existing functionality remains unchanged. These are documentation-only improvements to example files.

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



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



-- Commit Summary --



  * docs: add missing docstrings to function_tool examples for better LLM understanding



-- File Changes --



    M examples/model_providers/custom_example_agent.py (11)

    M examples/model_providers/custom_example_global.py (3)

    M examples/model_providers/custom_example_provider.py (13)

    M examples/model_providers/litellm_auto.py (3)

    M examples/model_providers/litellm_provider.py (3)



-- Patch Links --



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

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



-- 

Reply to this email directly or view it on GitHub:

https://github.com/openai

---

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