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.

Sign up for GitHub

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

Rename ResourceReference to ResourceTemplateReference #947

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0071b0f
Rename ResourceReference to ResourceTemplateReference
ihrpr Jun 12, 2025
b3ece15
use @deprecated
ihrpr Jun 13, 2025
8872ef9
ruff
ihrpr Jun 13, 2025
d96be59
Merge branch 'main' into ihrpr/916
ihrpr Jun 13, 2025
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
View file
Open in desktop
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
View file
Open in desktop
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
8 changes: 6 additions & 2 deletions src/mcp/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -953,7 +953,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 @@ -962,6 +962,10 @@ class ResourceReference(BaseModel):
model_config = ConfigDict(extra="allow")


# Deprecated: Use ResourceTemplateReference instead
ResourceReference = ResourceTemplateReference
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You want something like this:

Suggested change
# Deprecated: Use ResourceTemplateReference instead
ResourceReference = ResourceTemplateReference
@deprecated("`ResourceReference` is deprecated, you should use `ResourceTemplateReference`.")
class ResourceReference(ResourceTemplateReference):
"""A reference to a resource or resource template definition."""

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, thank you!



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

Expand All @@ -984,7 +988,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