[v1.x] Move the v1.x docs to /v1/ and mark v1.x as the maintenance line (#3177)
Some checks failed
Main branch checks / checks (push) Has been cancelled
Some checks failed
Main branch checks / checks (push) Has been cancelled
This commit is contained in:
parent
c0c5a9d642
commit
98b7159cb8
2 changed files with 58 additions and 153 deletions
|
|
@ -1,7 +1,9 @@
|
|||
# MCP Python SDK
|
||||
|
||||
!!! tip "Looking for the upcoming v2?"
|
||||
See the [v2 development documentation](https://py.sdk.modelcontextprotocol.io/v2/).
|
||||
!!! tip "You are viewing the v1.x maintenance-line documentation"
|
||||
v2 is the current stable release: its documentation is at
|
||||
<https://py.sdk.modelcontextprotocol.io/>. Staying on v1.x for now? Pin `mcp<2`
|
||||
(for example `mcp>=1.28,<2`) so an unpinned install doesn't move you to 2.x.
|
||||
|
||||
The **Model Context Protocol (MCP)** allows applications to provide context for LLMs in a standardized way, separating the concerns of providing context from the actual LLM interaction.
|
||||
|
||||
|
|
@ -48,7 +50,7 @@ if __name__ == "__main__":
|
|||
Run the server:
|
||||
|
||||
```bash
|
||||
uv run --with mcp server.py
|
||||
uv run --with "mcp<2" server.py
|
||||
```
|
||||
|
||||
Then open the [MCP Inspector](https://github.com/modelcontextprotocol/inspector) and connect to `http://localhost:8000/mcp`:
|
||||
|
|
@ -74,5 +76,5 @@ Full API documentation is available in the [API Reference](api.md).
|
|||
## llms.txt
|
||||
|
||||
Reading with an LLM? This documentation is also published in the [llms.txt](https://llmstxt.org/) format:
|
||||
[llms.txt](https://py.sdk.modelcontextprotocol.io/llms.txt) is an index of the pages, and
|
||||
[llms-full.txt](https://py.sdk.modelcontextprotocol.io/llms-full.txt) contains every page in a single file.
|
||||
[llms.txt](https://py.sdk.modelcontextprotocol.io/v1/llms.txt) is an index of the pages, and
|
||||
[llms-full.txt](https://py.sdk.modelcontextprotocol.io/v1/llms-full.txt) contains every page in a single file.
|
||||
|
|
|
|||
|
|
@ -1,16 +1,18 @@
|
|||
# Installation
|
||||
|
||||
The Python SDK is available on PyPI as [`mcp`](https://pypi.org/project/mcp/) so installation is as simple as:
|
||||
The Python SDK is available on PyPI as [`mcp`](https://pypi.org/project/mcp/). These docs describe the **v1.x maintenance line**;
|
||||
the `<2` bound keeps you on it now that `pip install mcp` selects the 2.x stable release by default (the
|
||||
[v2 documentation](https://py.sdk.modelcontextprotocol.io/) covers that line):
|
||||
|
||||
=== "pip"
|
||||
|
||||
```bash
|
||||
pip install mcp
|
||||
pip install "mcp<2"
|
||||
```
|
||||
=== "uv"
|
||||
|
||||
```bash
|
||||
uv add mcp
|
||||
uv add "mcp<2"
|
||||
```
|
||||
|
||||
The following dependencies are automatically installed:
|
||||
|
|
|
|||
Loading…
Reference in a new issue