Spaces:
Running
Running
Jeremiah Lowin commited on
Commit ·
6586502
1
Parent(s): f8721ad
Add versioning note to docs
Browse files
docs/getting-started/installation.mdx
CHANGED
|
@@ -60,6 +60,18 @@ mcp = FastMCP("My MCP Server")
|
|
| 60 |
Prior to `fastmcp==2.3.0` and `mcp==1.8.0`, the 2.x API always mirrored the 1.0 API. However, as the projects diverge, this can not be guaranteed. You may see deprecation warnings if you attempt to use 1.0 APIs in FastMCP 2.x. Please refer to this documentation for details on new capabilities.
|
| 61 |
</Warning>
|
| 62 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 63 |
## Installing for Development
|
| 64 |
|
| 65 |
If you plan to contribute to FastMCP, you should begin by cloning the repository and using uv to install all dependencies (development dependencies are installed automatically):
|
|
|
|
| 60 |
Prior to `fastmcp==2.3.0` and `mcp==1.8.0`, the 2.x API always mirrored the 1.0 API. However, as the projects diverge, this can not be guaranteed. You may see deprecation warnings if you attempt to use 1.0 APIs in FastMCP 2.x. Please refer to this documentation for details on new capabilities.
|
| 61 |
</Warning>
|
| 62 |
|
| 63 |
+
## Versioning and Breaking Changes
|
| 64 |
+
|
| 65 |
+
While we make every effort not to introduce backwards incompatible changes to our public APIs and behavior, FastMCP exists in a rapidly evolving MCP landscape. We're committed to bringing the most cutting-edge features to our users, which occasionally necessitates changes to existing functionality.
|
| 66 |
+
|
| 67 |
+
As a practice, breaking changes will only occur on minor version changes (e.g., 2.3.x to 2.4.0). A minor version change indicates either:
|
| 68 |
+
- A new feature set significant enough to deserve a new line of features
|
| 69 |
+
- An implementation of breaking changes that could affect behavior if users upgrade blindly
|
| 70 |
+
|
| 71 |
+
For users concerned about stability in production environments, we recommend pinning FastMCP to a specific version in your dependencies.
|
| 72 |
+
|
| 73 |
+
Note that the "public API" includes the core functionality of the `FastMCP` server and its methods. It does not include private methods or objects that are stored as private attributes, as we do not expect users to rely on those implementation details.
|
| 74 |
+
|
| 75 |
## Installing for Development
|
| 76 |
|
| 77 |
If you plan to contribute to FastMCP, you should begin by cloning the repository and using uv to install all dependencies (development dependencies are installed automatically):
|