Skip to content

Commit 4d14107

Browse files
committed
docs: document removal of deprecated cursor parameter and ResourceReference
Update migration guide with breaking changes: - cursor parameter removed from ClientSession list methods (list_resources, list_resource_templates, list_prompts, list_tools) - ResourceReference class removed in favor of ResourceTemplateReference
1 parent 024d759 commit 4d14107

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

docs/migration.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,49 @@ result = await session_group.call_tool("my_tool", args={"key": "value"})
8484
result = await session_group.call_tool("my_tool", arguments={"key": "value"})
8585
```
8686

87+
### `cursor` parameter removed from `ClientSession` list methods
88+
89+
The deprecated `cursor` parameter has been removed from the following `ClientSession` methods:
90+
91+
- `list_resources()`
92+
- `list_resource_templates()`
93+
- `list_prompts()`
94+
- `list_tools()`
95+
96+
Use `params=PaginatedRequestParams(cursor=...)` instead.
97+
98+
**Before (v1):**
99+
100+
```python
101+
result = await session.list_resources(cursor="next_page_token")
102+
result = await session.list_tools(cursor="next_page_token")
103+
```
104+
105+
**After (v2):**
106+
107+
```python
108+
from mcp.types import PaginatedRequestParams
109+
110+
result = await session.list_resources(params=PaginatedRequestParams(cursor="next_page_token"))
111+
result = await session.list_tools(params=PaginatedRequestParams(cursor="next_page_token"))
112+
```
113+
114+
### `ResourceReference` class removed
115+
116+
The deprecated `ResourceReference` class has been removed. Use `ResourceTemplateReference` directly instead.
117+
118+
**Before (v1):**
119+
120+
```python
121+
from mcp.types import ResourceReference
122+
```
123+
124+
**After (v2):**
125+
126+
```python
127+
from mcp.types import ResourceTemplateReference
128+
```
129+
87130
## Deprecations
88131

89132
<!-- Add deprecations below -->

0 commit comments

Comments
 (0)