René's URL Explorer Experiment


Title: structuredContent for a TypedDict return injects nulls for NotRequired keys, violating the tool's own outputSchema · Issue #3224 · modelcontextprotocol/python-sdk · GitHub

Open Graph Title: structuredContent for a TypedDict return injects nulls for NotRequired keys, violating the tool's own outputSchema · Issue #3224 · modelcontextprotocol/python-sdk

X Title: structuredContent for a TypedDict return injects nulls for NotRequired keys, violating the tool's own outputSchema · Issue #3224 · modelcontextprotocol/python-sdk

Description: Release line 2.x (main), reproduced at a4f4ccd0. Bug description A tool whose return annotation is a TypedDict with NotRequired keys (or total=False) publishes an outputSchema in which those properties are non-nullable, but structuredCon...

Open Graph Description: Release line 2.x (main), reproduced at a4f4ccd0. Bug description A tool whose return annotation is a TypedDict with NotRequired keys (or total=False) publishes an outputSchema in which those proper...

X Description: Release line 2.x (main), reproduced at a4f4ccd0. Bug description A tool whose return annotation is a TypedDict with NotRequired keys (or total=False) publishes an outputSchema in which those proper...

Opengraph URL: https://github.com/modelcontextprotocol/python-sdk/issues/3224

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"structuredContent for a TypedDict return injects nulls for NotRequired keys, violating the tool's own outputSchema","articleBody":"### Release line\n\n2.x (`main`), reproduced at `a4f4ccd0`.\n\n### Bug description\n\nA tool whose return annotation is a `TypedDict` with `NotRequired` keys (or `total=False`)\npublishes an `outputSchema` in which those properties are **non-nullable**, but\n`structuredContent` materialises every key the tool did not return as an explicit `null`.\n\nThe response therefore violates the schema the same server just advertised, and a conforming\nclient rejects the call. The SDK's own client does exactly that, so these tools are effectively\nunusable — even though TypedDict is one of the return shapes structured output documents.\n\nThe unstructured text block and `structuredContent` also disagree, so a client that skips\nvalidation sees two different answers for the same call.\n\n### Steps to reproduce\n\n```python\nimport anyio, json\nfrom typing import NotRequired, TypedDict\nfrom mcp.server.mcpserver import MCPServer\nfrom mcp import Client\n\nclass Person(TypedDict):\n    name: str\n    age: NotRequired[int]\n    nickname: NotRequired[str]\n\nmcp = MCPServer(\"td\")\n\n@mcp.tool()\ndef get_person() -> Person:\n    return {\"name\": \"Dave\"}          # omits both optional keys\n\nasync def main():\n    async with Client(mcp) as c:\n        tools = await c.list_tools()\n        print(\"outputSchema:\", json.dumps(tools.tools[0].output_schema, sort_keys=True))\n        r = await c.call_tool(\"get_person\", {})\n        print(\"structuredContent:\", r.structured_content)\n\nanyio.run(main)\n```\n\n### Actual behaviour\n\n```\noutputSchema: {\"properties\": {\"age\": {\"default\": null, \"title\": \"Age\", \"type\": \"integer\"},\n                              \"name\": {\"title\": \"Name\", \"type\": \"string\"},\n                              \"nickname\": {\"default\": null, \"title\": \"Nickname\", \"type\": \"string\"}},\n               \"required\": [\"name\"], \"title\": \"Person\", \"type\": \"object\"}\n\nRuntimeError: Invalid structured content returned by tool get_person: None is not of type 'string'\n\nFailed validating 'type' in schema['properties']['nickname']:\n    {'default': None, 'title': 'Nickname', 'type': 'string'}\nOn instance['nickname']:\n    None\n```\n\n`structuredContent` is `{\"name\": \"Dave\", \"age\": None, \"nickname\": None}` while the text block is\n`{\"name\": \"Dave\"}`.\n\n### Expected behaviour\n\n`structuredContent` is `{\"name\": \"Dave\"}` — a `NotRequired` key the tool omitted is absent, not\nnull — which validates against the published schema, and the call succeeds.\n\n### Root cause\n\n`_create_model_from_typeddict` (`src/mcp/server/mcpserver/utilities/func_metadata.py`) gives each\nnon-required key a `None` **default** to make it optional on the generated model; the declared type\nstays non-nullable, so the emitted schema is `{\"type\": \"integer\", \"default\": null}` and the key is\nabsent from `required`. `convert_result` then dumps with\n`model_dump(mode=\"json\", by_alias=True)` and no `exclude_unset`.\n\nThe file's own comment already prescribes the fix:\n\n```python\n# For optional TypedDict fields, set default=None\n# This makes them not required in the Pydantic model\n# The model should use exclude_unset=True when dumping to get TypedDict semantics\n```\n\nNothing applies it.\n\n### Why the tests do not catch it\n\n`tests/server/mcpserver/test_func_metadata.py::test_structured_output_typeddict` covers exactly\nthis shape but asserts only the schema, and marks the tool body `# pragma: no cover` — the tool is\nnever invoked, so `convert_result` is never exercised for a partial TypedDict.\n\n### Not a duplicate of #3100 / PR #3118\n\nThat pair concerns the validation-vs-serialization JSON-schema mode. `model_json_schema(mode=\"serialization\")`\nproduces byte-identical output for a `(int, None)` field, so it does not address this. Note #3118 does\nedit adjacent lines, so ordering matters if both land.\n\n### Disclosure\n\nInvestigated with AI assistance (Claude Code). I have a fix and tests ready and will open a PR\nlinked to this issue.\n","author":{"url":"https://github.com/sainikhiljuluri","@type":"Person","name":"sainikhiljuluri"},"datePublished":"2026-07-30T17:49:14Z","url":"https://github.com/modelcontextprotocol/python-sdk/issues/3224"}

react-profiling0
react-import-mapreact,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322
route-pattern/_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format)
route-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:d89499a3-f371-a31f-55d7-9c552e823687
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idDACA:25A204:9480B9:C5C937:6B00E23F
html-safe-noncee62ba59cd1c52f574ece9f6b5d82f9a3b8969169fb3fd4ba36d2a4174c0ade87
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJEQUNBOjI1QTIwNDo5NDgwQjk6QzVDOTM3OjZCMDBFMjNGIiwidmlzaXRvcl9pZCI6Ijg5NDUwMDM5Mjk2MTIxMTY1NDMiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ==
visitor-hmacfb9a8592e573e955b67ca5ca0400469727cb546a9b244f3a95ee8d161aaedb0e
hovercard-subject-tagissue:5022522063
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/modelcontextprotocol/python-sdk/3224/issue_layout
twitter:imagehttps://opengraph.githubassets.com/7bcea058bb0ba75ec343a5ac862687c7c8877a1a777083889f3f72f782b732a7/modelcontextprotocol/python-sdk/issues/3224
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/7bcea058bb0ba75ec343a5ac862687c7c8877a1a777083889f3f72f782b732a7/modelcontextprotocol/python-sdk/issues/3224
og:image:altRelease line 2.x (main), reproduced at a4f4ccd0. Bug description A tool whose return annotation is a TypedDict with NotRequired keys (or total=False) publishes an outputSchema in which those proper...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernamesainikhiljuluri
hostnamegithub.com
expected-hostnamegithub.com
None27088b6977484d0d3321d9a11c907c6d6637b315cfa359ef7952dbf6292f9b14
turbo-cache-controlno-preview
go-importgithub.com/modelcontextprotocol/python-sdk git https://github.com/modelcontextprotocol/python-sdk.git
octolytics-dimension-user_id182288589
octolytics-dimension-user_loginmodelcontextprotocol
octolytics-dimension-repository_id862584018
octolytics-dimension-repository_nwomodelcontextprotocol/python-sdk
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id862584018
octolytics-dimension-repository_network_root_nwomodelcontextprotocol/python-sdk
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release624179fb8b88d26ba5bba08894eb60a1c5a1d93d
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/modelcontextprotocol/python-sdk/issues/3224#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmodelcontextprotocol%2Fpython-sdk%2Fissues%2F3224
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmodelcontextprotocol%2Fpython-sdk%2Fissues%2F3224
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=modelcontextprotocol%2Fpython-sdk
Reloadhttps://github.com/modelcontextprotocol/python-sdk/issues/3224
Reloadhttps://github.com/modelcontextprotocol/python-sdk/issues/3224
Reloadhttps://github.com/modelcontextprotocol/python-sdk/issues/3224
modelcontextprotocolhttps://github.com/modelcontextprotocol
python-sdkhttps://github.com/modelcontextprotocol/python-sdk
Codehttps://github.com/modelcontextprotocol/python-sdk
Issues308 (308)https://github.com/modelcontextprotocol/python-sdk/issues
Pull requests112 (112)https://github.com/modelcontextprotocol/python-sdk/pulls
Actionshttps://github.com/modelcontextprotocol/python-sdk/actions
Projectshttps://github.com/modelcontextprotocol/python-sdk/projects
Security and quality12 (12)https://github.com/modelcontextprotocol/python-sdk/security
Insightshttps://github.com/modelcontextprotocol/python-sdk/insights
https://github.com/modelcontextprotocol/python-sdk
New issuehttps://github.com/login?return_to=https://github.com/modelcontextprotocol/python-sdk/issues/3224
New issuehttps://github.com/login?return_to=https://github.com/modelcontextprotocol/python-sdk/issues/3224
#3331https://github.com/modelcontextprotocol/python-sdk/pull/3331
structuredContent for a TypedDict return injects nulls for NotRequired keys, violating the tool's own outputSchemahttps://github.com/modelcontextprotocol/python-sdk/issues/3224#top
#3331https://github.com/modelcontextprotocol/python-sdk/pull/3331
P1Significant bug affecting many users, highly requested featurehttps://github.com/modelcontextprotocol/python-sdk/issues?q=state%3Aopen%20label%3A%22P1%22
v1Affects the v1.x maintenance linehttps://github.com/modelcontextprotocol/python-sdk/issues?q=state%3Aopen%20label%3A%22v1%22
v2Affects the v2 line (2.x on main)https://github.com/modelcontextprotocol/python-sdk/issues?q=state%3Aopen%20label%3A%22v2%22
https://github.com/sainikhiljuluri
sainikhiljulurihttps://github.com/sainikhiljuluri
on Jul 30, 2026https://github.com/modelcontextprotocol/python-sdk/issues/3224#issue-5022522063
#3100https://github.com/modelcontextprotocol/python-sdk/issues/3100
#3118https://github.com/modelcontextprotocol/python-sdk/pull/3118
#3118https://github.com/modelcontextprotocol/python-sdk/pull/3118
https://github.com/Ecocitizenz
Ecocitizenzhttps://github.com/Ecocitizenz
on Jul 31, 2026https://github.com/modelcontextprotocol/python-sdk/issues/3224#issuecomment-5137658937
maxisbeyhttps://github.com/maxisbey
P1Significant bug affecting many users, highly requested featurehttps://github.com/modelcontextprotocol/python-sdk/issues?q=state%3Aopen%20label%3A%22P1%22
v1Affects the v1.x maintenance linehttps://github.com/modelcontextprotocol/python-sdk/issues?q=state%3Aopen%20label%3A%22v1%22
v2Affects the v2 line (2.x on main)https://github.com/modelcontextprotocol/python-sdk/issues?q=state%3Aopen%20label%3A%22v2%22
on Aug 12, 2026https://github.com/modelcontextprotocol/python-sdk/issues/3224#event-29354915425
maxisbeyhttps://github.com/maxisbey
completedhttps://github.com/modelcontextprotocol/python-sdk/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Acompleted
#3331https://github.com/modelcontextprotocol/python-sdk/pull/3331
on Aug 20, 2026https://github.com/modelcontextprotocol/python-sdk/issues/3224#event-29749933937
Sign up for freehttps://github.com/signup?return_to=https://github.com/modelcontextprotocol/python-sdk/issues/3224
Sign in to commenthttps://github.com/login?return_to=https://github.com/modelcontextprotocol/python-sdk/issues/3224
P1Significant bug affecting many users, highly requested featurehttps://github.com/modelcontextprotocol/python-sdk/issues?q=state%3Aopen%20label%3A%22P1%22
v1Affects the v1.x maintenance linehttps://github.com/modelcontextprotocol/python-sdk/issues?q=state%3Aopen%20label%3A%22v1%22
v2Affects the v2 line (2.x on main)https://github.com/modelcontextprotocol/python-sdk/issues?q=state%3Aopen%20label%3A%22v2%22
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.