-
Notifications
You must be signed in to change notification settings - Fork 640
Encourage title properties/usage for objects/resources likely t… #663
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
Encourage title properties/usage for objects/resources likely t… #663
Conversation
d7801b2
to
7340d98
Compare
Hi @ZachGerman - interested in your thoughts on a couple of things, just thinking out loud:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
MCP already uses the title
for the "displayName" in ToolAnnotations.title
. Could we normalize one direction or the other?
@@ -264,6 +267,7 @@ Example tool with output schema: | |||
```json | |||
{ | |||
"name": "get_weather_data", | |||
"displayName": "Weather Data Retriever", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This doesn't appear to be represented in the spec change and is duplicative with existing ToolAnnotations.title
Hi @ZachGerman - this is definitely a useful addition and we'd like to add it to the draft spec, but with the following changes:
Realize this is a nontrivial set of edits and we're on a fairly tight schedule for the spec release, so if you don't have time/bandwidth in the next day or so we're happy to make the changes. Just LMK! |
All reactions
Sorry, something went wrong.
6b634a1
to
f00ada8
Compare
Done. Please let me know if anything else needs changed. I'm on-call this week, so I won't finish the server transport until next week, but this PR is small enough to keep up with during my on-call. |
All reactions
Sorry, something went wrong.
…epresented in a UI
f00ada8
to
1c54a77
Compare
Awesome! Will review shortly but also please fix the merge conflicts when you have a chance. Thanks for the quick turnaround! |
All reactions
-
👍 1 reaction
Sorry, something went wrong.
Ugh sorry to do this to you but it looks like you need to rerun |
All reactions
Sorry, something went wrong.
Should be fixed now. |
All reactions
Sorry, something went wrong.
Hi @ZachGerman - had to make one change, Having pushed the change I can't merge it, but it should go in shortly. Thanks again for doing this! |
All reactions
Sorry, something went wrong.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Sorry, something went wrong.
All reactions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we also need to update PromptReference
?
Sorry, something went wrong.
All reactions
schema/draft/schema.ts
Outdated
@@ -264,10 +264,29 @@ export interface ServerCapabilities { | |||
} | |||
|
|||
/** | |||
* Describes the name and version of an MCP implementation. | |||
* Base interface for metadata with name and title (display name) properties. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we hint that name is an identifier?
* Base interface for metadata with name and title (display name) properties. | |
* Base interface for metadata with name (identifier) and title (display name) properties. |
Sorry, something went wrong.
All reactions
-
👍 1 reaction
yes! thanks for catching |
All reactions
Sorry, something went wrong.
[edited] back to plan A, will land this as-is + @ihrpr suggestion (I'll push it shortly) |
All reactions
-
👍 1 reaction
Sorry, something went wrong.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Sorry, something went wrong.
All reactions
connor4312
ihrpr
bhosmer-ant
dsp-ant
Successfully merging this pull request may close these issues.
Encourage UI-friendly naming by introducing a dedicated optional
title
property across the specification and updating all related examples to include it.title
field toresource
,tool
,prompt
,clientInfo
, andserverInfo
definitions in the spec.title
entries where they're likely to be used.Motivation and Context
By introducing
title
as a dedicated property, we ensure clarity and consistency in how data is surfaced to end users, improving both developer experience and user-facing usability as the protocol evolves.Breaking Changes
Will users need to update their code or configurations? No. According to the language added to the spec, "if no
title
is provided,name
should be used for display purposes". Thus, implementations currently leveragingname
variables for display will be preserved.Types of changes
Checklist
To be added to docs if/when this PR is published to an official spec version:
Naming conventions:
name
andtitle
. Thename
is intended for programmatic or logical use, whiletitle
is intended for UI and end-user contexts — optimized to be human-readable and easily understood, even by those unfamiliar with domain-specific terminology.