Skip to content

Feature/tool error handling docs #6654

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.

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

Open
wants to merge 39 commits into
base: main
Choose a base branch
from

Conversation

tejas-dharani
Copy link
Contributor

@tejas-dharani tejas-dharani commented Jun 9, 2025

Why are these changes needed?

This PR adds comprehensive documentation for tool error handling in AutoGen, addressing the lack of guidance for developers on how to properly handle errors when tools fail during agent interactions. The changes include:

  • New tutorial tool-error-handling.ipynb with practical examples demonstrating error handling patterns
  • Updated navigation in agentchat user guide index files to include the new tutorial
  • Enhanced error handling examples in existing agents.ipynb and tools.ipynb notebooks
  • Documentation of best practices for exception types and error messages

These additions will help developers build more robust agent applications by providing clear guidance on error handling strategies, exception management, and recovery patterns when tools encounter failures.

Related issue number

Closes #5272

Checks

…on guide- Fix version format from 0.4.0-dev-1 to 0.4.0-dev.1 for all packages- Remove reference to non-existent Microsoft.AutoGen.Extensions package- Add correct extension packages: Aspire, MEAI, and SemanticKernel- Fix typo: RuntimeGatewway -> RuntimeGateway- Improve documentation structure with clear section headersFixes microsoft#6244
Fix issue microsoft#6277 where TextMessage was used but not imported in three code cells
of the custom agents documentation, causing NameError when users run the examples.

Changes:
- Add TextMessage to imports in ArithmeticAgent section
- Add TextMessage to imports in GeminiAssistantAgent section
- Add TextMessage to imports in Declarative GeminiAssistantAgent section

The CountDownAgent section already had the correct import.

Fixes microsoft#6277
…stallation guide- Fix version format from 0.4.0-dev-1 to 0.4.0-dev.1 for all packages- Remove reference to non-existent Microsoft.AutoGen.Extensions package- Add correct extension packages: Aspire, MEAI, and SemanticKernel- Fix typo: RuntimeGatewway -> RuntimeGateway- Improve documentation structure with clear section headersFixes microsoft#6244"

This reverts commit 6d9fb2e.
…stallation guide- Fix version format from 0.4.0-dev-1 to 0.4.0-dev.1 for all packages- Remove reference to non-existent Microsoft.AutoGen.Extensions package- Add correct extension packages: Aspire, MEAI, and SemanticKernel- Fix typo: RuntimeGatewway -> RuntimeGateway- Improve documentation structure with clear section headersFixes microsoft#6244"

This reverts commit 6d9fb2e.
Copy link
Collaborator

@ekzhu ekzhu left a comment

Choose a reason for hiding this comment

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

I see a lot of duplications. Can you just have one page in the Core API doc under component guides? Just reference the doc from AgentChat's doc.

@tejas-dharani tejas-dharani requested a review from ekzhu June 28, 2025 12:02
@tejas-dharani
Copy link
Contributor Author

I see a lot of duplications. Can you just have one page in the Core API doc under component guides? Just reference the doc from AgentChat's doc.

Hello @ekzhu Sir,

I’ve implemented the changes as per your guidance.
Please let me know if any further adjustments are needed.

Copy link

codecov bot commented Jul 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.35%. Comparing base (9f2c5aa) to head (7ffbda3).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #6654   +/-   ##
=======================================
  Coverage   80.35%   80.35%           
=======================================
  Files         233      233           
  Lines       17701    17701           
=======================================
  Hits        14224    14224           
  Misses       3477     3477           
Flag Coverage Δ
unittests 80.35% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve tool use documentation in AgentChat tutorial to provide guideline for error handling of tool calls.
2 participants