Skip to content

Clarify installation for FastMCP 3.0 beta#2953

Merged
jlowin merged 2 commits intomainfrom
docs/clarify-beta-installation
Jan 20, 2026
Merged

Clarify installation for FastMCP 3.0 beta#2953
jlowin merged 2 commits intomainfrom
docs/clarify-beta-installation

Conversation

@jlowin
Copy link
Copy Markdown
Member

@jlowin jlowin commented Jan 20, 2026

The v3 docs show install commands that would install the stable 2.x release, not the 3.0 beta. Since users reading the 3.0 docs want 3.0, the default instructions should include the pre-release flags.

Changes:

  • Add --pre (pip) and --prerelease=allow (uv) to all install commands
  • Add a note explaining that 3.0 is in beta and requires explicit opt-in
  • Add a tip to the Background Tasks doc pointing to installation instructions

Add pre-release flags to all install commands since 3.0 is in beta.
Users must explicitly opt in with --pre (pip) or --prerelease=allow (uv).
@marvin-context-protocol marvin-context-protocol Bot added the documentation Updates to docs, examples, or guides. Primary change is documentation-related. label Jan 20, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jan 20, 2026

Walkthrough

This pull request updates installation documentation for FastMCP 3.0, which is currently in beta and requires explicit prerelease handling. The changes modify installation instructions across multiple package managers (uv add, uv pip install, and pip install) to include appropriate prerelease flags. Additionally, the documentation clarifies optional dependency installation, specifically for the background tasks extra, and adds informational notes about feature requirements in the tasks documentation.

Possibly related PRs

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The description provides clear context about the problem (install commands defaulting to 2.x), explains the specific changes made (prerelease flags, beta note, background tasks tip), but lacks the required checklist items from the template. Complete the Contributors Checklist and Review Checklist by checking off the relevant items and confirming issue closure, testing, and self-review status.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main objective: updating documentation to clarify installation steps for the FastMCP 3.0 beta release with prerelease flags.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@jlowin jlowin merged commit c14ef13 into main Jan 20, 2026
10 checks passed
@jlowin jlowin deleted the docs/clarify-beta-installation branch January 20, 2026 04:24
gfortaine pushed a commit to gfortaine/fastmcp that referenced this pull request Jan 30, 2026
gfortaine pushed a commit to gfortaine/fastmcp that referenced this pull request Feb 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Updates to docs, examples, or guides. Primary change is documentation-related.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant