NotificationsYou must be signed in to change notification settings
Fork1k
Star11k

Make`ToolDefinition.description` optional and fix Bedrock description handling#1507

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

DouweM merged 6 commits intomainfromdmontagu/fix-bedrock-description-handling

Jul 8, 2025

Merged

Make`ToolDefinition.description` optional and fix Bedrock description handling#1507

DouweM merged 6 commits intomainfromdmontagu/fix-bedrock-description-handling

Jul 8, 2025

Conversation

Copy link

Contributor

dmontagu commentedApr 16, 2025

Before merging this we should probably make the description field onpydantic_ai.tools.ToolDefinition optional, and handleNone properly on every other model.

Copy link

github-actionsbot commentedApr 16, 2025•
edited
Loading

Docs Preview

commit:	`cdc86dc`
Preview URL:	https://e9b86b68-pydantic-ai-previews.pydantic.workers.dev

Kludex approved these changes

Apr 16, 2025

View reviewed changes

DouweM marked this pull request as draft

April 30, 2025 19:14

DouweM assigneddmontagu

Apr 30, 2025

Copy link

Contributor

DouweM commentedApr 30, 2025

@dmontagu Makingdescription optional sounds reasonable, and would let us stop passing'' for MCP tools that don't have one. Are you planning to implement that here?

DouweM assignedDouweM and unassigneddmontagu

Jul 8, 2025

dmontaguand others added2 commits

July 8, 2025 16:06

Fix bedrock description handling

074f4eb

Make ToolDefinition.description optional

f31fb94

DouweM force-pushed thedmontagu/fix-bedrock-description-handling branch from4269d90 tof31fb94Compare

July 8, 2025 16:12

DouweM marked this pull request as ready for review

July 8, 2025 16:12

Copy link

Contributor

hyperlint-aibot commentedJul 8, 2025

PR Change Summary

Updated the handling of the description field in ToolDefinition to allow for optional descriptions and improved handling of None values across models.

Made the description field in ToolDefinition optional.
Updated the handling of None values for descriptions in various models.
Removed empty description assignments in documentation.

Modified Files

docs/direct.md
docs/tools.md

How can I customize these reviews?

Check out theHyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add thehyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to addhyperlint-ignore to the PR to ignore the link check for this PR.