Skip to content

Rename ResourceReference to ResourceTemplateReference #947

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 4 commits into from
Jun 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/mcp/client/session.py
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ async def get_prompt(self, name: str, arguments: dict[str, str] | None = None) -

async def complete(
self,
ref: types.ResourceReference | types.PromptReference,
ref: types.ResourceTemplateReference | types.PromptReference,
argument: dict[str, str],
) -> types.CompleteResult:
"""Send a completion/complete request."""
Expand Down
2 changes: 1 addition & 1 deletion src/mcp/server/lowlevel/server.py
Original file line number Diff line number Diff line change
Expand Up @@ -431,7 +431,7 @@ def completion(self):
def decorator(
func: Callable[
[
types.PromptReference | types.ResourceReference,
types.PromptReference | types.ResourceTemplateReference,
types.CompletionArgument,
],
Awaitable[types.Completion | None],
Expand Down
10 changes: 8 additions & 2 deletions src/mcp/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

from pydantic import BaseModel, ConfigDict, Field, FileUrl, RootModel
from pydantic.networks import AnyUrl, UrlConstraints
from typing_extensions import deprecated

"""
Model Context Protocol bindings for Python
Expand Down Expand Up @@ -961,7 +962,7 @@ class CreateMessageResult(Result):
"""The reason why sampling stopped, if known."""


class ResourceReference(BaseModel):
class ResourceTemplateReference(BaseModel):
"""A reference to a resource or resource template definition."""

type: Literal["ref/resource"]
Expand All @@ -970,6 +971,11 @@ class ResourceReference(BaseModel):
model_config = ConfigDict(extra="allow")


@deprecated("`ResourceReference` is deprecated, you should use `ResourceTemplateReference`.")
class ResourceReference(ResourceTemplateReference):
pass


class PromptReference(BaseModel):
"""Identifies a prompt."""

Expand All @@ -992,7 +998,7 @@ class CompletionArgument(BaseModel):
class CompleteRequestParams(RequestParams):
"""Parameters for completion requests."""

ref: ResourceReference | PromptReference
ref: ResourceTemplateReference | PromptReference
argument: CompletionArgument
model_config = ConfigDict(extra="allow")

Expand Down
Loading