Python: docs: fix outdated @ai_function reference to @tool in workflows README - #5622
Merged
Eduard van Valkenburg (eavanvalkenburg) merged 2 commits intoMay 4, 2026
Conversation
The @ai_function decorator was renamed to @tool in release python-1.0.0b260128 (PR microsoft#3413) as a breaking change. Line 58 of python/samples/03-workflows/README.md still referenced the old @ai_function name, causing users to hit: ImportError: cannot import name 'AIFunction' Changes made: - Fixed @ai_function to @tool on line 58 only - No formatting or whitespace changes
Evan Mattson (moonbox3)
added
documentation
github-actions
Bot
changed the title
Copilot started reviewing on behalf of
Aishwarya Sawant (aishsawant0202-tech)
May 4, 2026 10:35
View session
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Python workflows sample README to reflect the breaking rename of the @ai_function decorator to @tool, preventing users from following outdated guidance and hitting ImportError: cannot import name 'AIFunction'.
Changes:
- Replaced the outdated
@ai_functionreference with@toolin the “Workflow as Agent kwargs” sample entry.
Eduard van Valkenburg (eavanvalkenburg)
approved these changes
May 4, 2026
Eduard van Valkenburg (eavanvalkenburg)
enabled auto-merge
May 4, 2026 10:47
Evan Mattson (moonbox3)
approved these changes
May 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The @ai_function decorator was renamed to tool in release python-1.0.0b260128 (PR #3413) as a breaking change.
Line 58 of python/samples/03-workflows/README.md still referenced the old @ai_function name, causing users to hit:
ImportError: cannot import name 'AIFunction'
Changes made:
Motivation and Context
The @ai_function decorator was renamed to tool in release python-1.0.0b260128 (Jan 28, 2026) as a breaking change (PR #3413).
However, line 58 of python/samples/03-workflows/README.md still referenced the old @ai_function name, causing users to follow outdated documentation and hit ImportError: cannot import name 'AIFunction'.
Additionally, the official Microsoft Learn docs at:
https://learn.microsoft.com/en-us/python/api/agent-framework-core/agent_framework.aifunction still show the old API — this is the primary source of user confusion.
Fixes #5564
Description
Changed @ai_function tools to tool functions on line 58 of python/samples/03-workflows/README.md in the agents table (Workflow as Agent kwargs row).
Contribution Checklist
✅ The code builds clean without any errors or warnings — docs-only change, no build impact
✅ The PR follows the Contribution Guidelines
✅ All unit tests pass, and I have added new tests where possible — no tests needed for docs fix
❌ Is this a breaking change? — No, this is a docs fix only