fix(schemas): give optional tool params a None default#36
Open
devteamaegis wants to merge 1 commit into
Open
Conversation
…ls don't crash Optional[...] fields declared with Field(description=...) and no default are required in Pydantic v2, so invoking tools like create_inbox with no arguments (the documented default) raised a ValidationError instead of running.
b9aea45 to
715ae78
Compare
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.
What's broken
Every optional field in the toolkit's parameter schemas is declared as
Optional[...] = Field(description=...)with no default. In Pydantic v2 anOptionalfield without a default is still required, so the tools mark fields the API treats as optional as mandatory. Callingcreate_inboxwith no arguments — the documented way to get a random inbox — raises before any request is made:The same defect breaks minimal calls to list/send/reply/forward/update.
Why it happens
In Pydantic v2,
Optional[X] = Field(...)withoutdefault=is a required field.Fix
Add
default=Noneto the optional fields that were missing it.Test
CreateInboxParams()andListItemsParams(limit=5)now construct without error; both raisedValidationErrorbefore.Summary by cubic
Set default=None on all optional params in the toolkit schemas to match
pydanticv2 behavior. This prevents ValidationError crashes on minimal calls likecreate_inbox()with no args.default=Nonefor all Optional fields across parameter models so optional inputs are truly optional.CreateInboxParams()andListItemsParams(limit=5)instantiate without errors and keeppage_token=None.Written for commit 715ae78. Summary will update on new commits.