Skip to content

Align subscriptions/listen result naming and add response envelope #3158

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
localden merged 2 commits into from
Jul 28, 2026
Merged

Align subscriptions/listen result naming and add response envelope #3158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f7e99af
schema(draft): align subscriptions/listen with envelope and _meta nam…
JaynouOliver Jul 3, 2026
271ecc9
fix(schema): apply subscriptions/listen envelope and MetaObject renam…
claude Jul 28, 2026
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
19 changes: 14 additions & 5 deletions docs/specification/2026-07-28/schema.mdx
View file
Open in desktop

Large diffs are not rendered by default.

19 changes: 14 additions & 5 deletions docs/specification/draft/schema.mdx
View file
Open in desktop

Large diffs are not rendered by default.

10 changes: 10 additions & 0 deletions schema/2026-07-28/examples/SubscriptionsListenResultResponse/listen-closed-response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"jsonrpc": "2.0",
"id": "listen-1",
"result": {
"resultType": "complete",
"_meta": {
"io.modelcontextprotocol/subscriptionId": "listen-1"
}
}
}
25 changes: 23 additions & 2 deletions schema/2026-07-28/schema.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 15 additions & 2 deletions schema/2026-07-28/schema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1323,7 +1323,7 @@ export interface SubscriptionsListenRequest extends JSONRPCRequest {
* @see {@link MetaObject} for key naming rules and reserved prefixes.
* @category `subscriptions/listen`
*/
export interface SubscriptionsListenResultMeta extends ResultMetaObject {
export interface SubscriptionsListenResultMetaObject extends ResultMetaObject {
/**
* Identifies the subscription stream this response closes, so the client can
* correlate it with the originating subscription — mirroring the same key on
Expand All @@ -1347,7 +1347,20 @@ export interface SubscriptionsListenResultMeta extends ResultMetaObject {
* @category `subscriptions/listen`
*/
export interface SubscriptionsListenResult extends Result {
_meta: SubscriptionsListenResultMeta;
_meta: SubscriptionsListenResultMetaObject;
}

/**
* A successful response from the server for a {@link SubscriptionsListenRequest | subscriptions/listen}
* request, sent when the server tears the subscription down gracefully.
*
* @example Subscription closed gracefully response
* {@includeCode ./examples/SubscriptionsListenResultResponse/listen-closed-response.json}
*
* @category `subscriptions/listen`
*/
export interface SubscriptionsListenResultResponse extends JSONRPCResultResponse {
result: SubscriptionsListenResult;
}

/**
Expand Down
10 changes: 10 additions & 0 deletions schema/draft/examples/SubscriptionsListenResultResponse/listen-closed-response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"jsonrpc": "2.0",
"id": "listen-1",
"result": {
"resultType": "complete",
"_meta": {
"io.modelcontextprotocol/subscriptionId": "listen-1"
}
}
}
25 changes: 23 additions & 2 deletions schema/draft/schema.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 15 additions & 2 deletions schema/draft/schema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1323,7 +1323,7 @@ export interface SubscriptionsListenRequest extends JSONRPCRequest {
* @see {@link MetaObject} for key naming rules and reserved prefixes.
* @category `subscriptions/listen`
*/
export interface SubscriptionsListenResultMeta extends ResultMetaObject {
export interface SubscriptionsListenResultMetaObject extends ResultMetaObject {
/**
* Identifies the subscription stream this response closes, so the client can
* correlate it with the originating subscription — mirroring the same key on
Expand All @@ -1347,7 +1347,20 @@ export interface SubscriptionsListenResultMeta extends ResultMetaObject {
* @category `subscriptions/listen`
*/
export interface SubscriptionsListenResult extends Result {
_meta: SubscriptionsListenResultMeta;
_meta: SubscriptionsListenResultMetaObject;
}

/**
* A successful response from the server for a {@link SubscriptionsListenRequest | subscriptions/listen}
* request, sent when the server tears the subscription down gracefully.
*
* @example Subscription closed gracefully response
* {@includeCode ./examples/SubscriptionsListenResultResponse/listen-closed-response.json}
*
* @category `subscriptions/listen`
*/
export interface SubscriptionsListenResultResponse extends JSONRPCResultResponse {
result: SubscriptionsListenResult;
}

/**
Expand Down
2 changes: 1 addition & 1 deletion scripts/generate-schemas.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ const execAsync = promisify(exec);
const LEGACY_SCHEMAS = ['2024-11-05', '2025-03-26', '2025-06-18'];

// Modern schema versions that use JSON Schema 2020-12
const MODERN_SCHEMAS = ['2025-11-25', 'draft'];
const MODERN_SCHEMAS = ['2025-11-25', '2026-07-28', 'draft'];

// All schema versions to generate
const ALL_SCHEMAS = [...LEGACY_SCHEMAS, ...MODERN_SCHEMAS];
Expand Down
Loading