-
Notifications
You must be signed in to change notification settings - Fork 2k
Overhaul v3.0 upgrade guide #3205
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
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
7910d62
Overhaul v3.0 upgrade guide
jlowin 87ac3b4
Address CodeRabbit review feedback on upgrade guide
jlowin d496e36
Move decorator change under Breaking Changes in prose
jlowin 8ef25c9
Add before/after pattern to auth provider section
jlowin 4da83dc
Add Warning callout, WSTransport and OpenAPI migration examples
jlowin 57b0185
Add missing imports to FastMCPOpenAPI migration example
jlowin File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
🏁 Script executed:
Repository: jlowin/fastmcp
Length of output: 5068
🏁 Script executed:
Repository: jlowin/fastmcp
Length of output: 4756
🏁 Script executed:
Repository: jlowin/fastmcp
Length of output: 2349
🏁 Script executed:
Repository: jlowin/fastmcp
Length of output: 2853
🏁 Script executed:
Repository: jlowin/fastmcp
Length of output: 2863
🏁 Script executed:
Repository: jlowin/fastmcp
Length of output: 658
🏁 Script executed:
Repository: jlowin/fastmcp
Length of output: 4343
🏁 Script executed:
Repository: jlowin/fastmcp
Length of output: 253
🏁 Script executed:
Repository: jlowin/fastmcp
Length of output: 1999
🏁 Script executed:
Repository: jlowin/fastmcp
Length of output: 319
🌐 Web query:
Mintlify custom components guide documentation💡 Result:
Key Mintlify docs for custom components (React/JSX in MDX):
.mdxpage, plus rules around importing reusable components from thesnippets/folder). [1].mdxsnippets and reusable.jsx“JSX snippets” insnippets/, then import and render them in pages). [2]styleprop). [4]Typical pattern: put reusable React components in
snippets/*.jsx, export them, thenimport { MyComponent } from '/snippets/MyComponent.jsx'and render<MyComponent />in your MDX page. [1][2]Sources: [1][2][3][4]
Replace
<Prompt>with a standard callout component (e.g.,<Note>or<Info>), verify ToolTransform API usage, and add missing imports and code examples.The
<Prompt>component used on line 15 is not defined in the Mintlify component registry or anywhere in the project. It will fail to build or render as unstyled text, causing lines 15–69 to display incorrectly. Use a standard Mintlify callout like<Note>instead.The
add_tool_transformation()→add_transform()deprecation code is incorrect. The example showsToolTransform({"name": config})but the actual constructor signature isToolTransform(transforms: dict[str, ToolTransformConfig]), where keys are original tool names and values areToolTransformConfigobjects. Correct it to:The WSTransport removed section (lines 192–194) provides only text description with no code example. Add a before/after block showing the removal.
The OpenAPI
timeoutparameter removed code example (lines 200–207) useshttpx.AsyncClientandOpenAPIProviderwithout importing them. Add imports at the top:Add a warning callout in the OAUTH STORAGE section (line 102) when mentioning
pip install 'py-key-value-aio[disk]'to re-introduce the vulnerable diskcache package.🤖 Prompt for AI Agents