|
| 1 | +/** |
| 2 | + * `ClientOptions.extensions`: an extension is advertised under the client's |
| 3 | + * `capabilities.extensions[id]` — in `initialize` on a legacy connection, in |
| 4 | + * every request's `_meta` client-capabilities envelope on a 2026-07-28 |
| 5 | + * connection — and installed at construction, where it can register |
| 6 | + * handlers for server-to-client requests. |
| 7 | + */ |
| 8 | +import type { JSONRPCMessage } from '@modelcontextprotocol/core-internal'; |
| 9 | +import { CLIENT_CAPABILITIES_META_KEY, InMemoryTransport, LATEST_PROTOCOL_VERSION } from '@modelcontextprotocol/core-internal'; |
| 10 | +import { describe, expect, it } from 'vitest'; |
| 11 | +import * as z from 'zod/v4'; |
| 12 | + |
| 13 | +import { Client } from '../../src/client/client'; |
| 14 | +import type { ClientExtension } from '../../src/client/extension'; |
| 15 | + |
| 16 | +const MODERN = '2026-07-28'; |
| 17 | +const EXT_ID = 'com.example/gate'; |
| 18 | + |
| 19 | +const flush = () => new Promise(resolve => setTimeout(resolve, 20)); |
| 20 | + |
| 21 | +function gateExtension(log: string[]): ClientExtension { |
| 22 | + return { |
| 23 | + id: EXT_ID, |
| 24 | + install(client) { |
| 25 | + log.push('installed'); |
| 26 | + client.registerCapabilities({ extensions: { [EXT_ID]: { exampleData: true } } }); |
| 27 | + client.setRequestHandler('gate/ping', { params: z.looseObject({}) }, () => ({ pong: true })); |
| 28 | + client.acceptResultType('tools/call', 'task'); |
| 29 | + } |
| 30 | + }; |
| 31 | +} |
| 32 | + |
| 33 | +/** A scripted server side: answers the handshake for the requested era and records everything the client writes. */ |
| 34 | +async function scriptedServer(era: 'modern' | 'legacy') { |
| 35 | + const [clientTx, serverTx] = InMemoryTransport.createLinkedPair(); |
| 36 | + const written: JSONRPCMessage[] = []; |
| 37 | + serverTx.onmessage = message => { |
| 38 | + written.push(message); |
| 39 | + const request = message as { id?: number | string; method?: string }; |
| 40 | + if (request.id === undefined) return; |
| 41 | + if (request.method === 'server/discover') { |
| 42 | + void serverTx.send( |
| 43 | + era === 'modern' |
| 44 | + ? { |
| 45 | + jsonrpc: '2.0', |
| 46 | + id: request.id, |
| 47 | + result: { |
| 48 | + resultType: 'complete', |
| 49 | + supportedVersions: [MODERN], |
| 50 | + capabilities: { tools: {} }, |
| 51 | + _meta: { 'io.modelcontextprotocol/serverInfo': { name: 'scripted', version: '1.0.0' } } |
| 52 | + } |
| 53 | + } |
| 54 | + : { jsonrpc: '2.0', id: request.id, error: { code: -32_601, message: 'Method not found' } } |
| 55 | + ); |
| 56 | + } else if (request.method === 'initialize') { |
| 57 | + void serverTx.send({ |
| 58 | + jsonrpc: '2.0', |
| 59 | + id: request.id, |
| 60 | + result: { |
| 61 | + protocolVersion: LATEST_PROTOCOL_VERSION, |
| 62 | + capabilities: { tools: {} }, |
| 63 | + serverInfo: { name: 'scripted', version: '1.0.0' } |
| 64 | + } |
| 65 | + }); |
| 66 | + } else if (request.method === 'tools/call') { |
| 67 | + void serverTx.send({ |
| 68 | + jsonrpc: '2.0', |
| 69 | + id: request.id, |
| 70 | + result: { resultType: 'task', taskId: 't-1', status: 'working', createdAt: 'now', lastUpdatedAt: 'now', ttlMs: null } |
| 71 | + }); |
| 72 | + } else if (request.method === 'tools/list') { |
| 73 | + void serverTx.send({ |
| 74 | + jsonrpc: '2.0', |
| 75 | + id: request.id, |
| 76 | + result: era === 'modern' ? { resultType: 'complete', tools: [], ttlMs: 0, cacheScope: 'public' } : { tools: [] } |
| 77 | + }); |
| 78 | + } |
| 79 | + }; |
| 80 | + await serverTx.start(); |
| 81 | + return { clientTx, serverTx, written }; |
| 82 | +} |
| 83 | + |
| 84 | +const paramsOf = (message: JSONRPCMessage): Record<string, unknown> => (message as { params?: Record<string, unknown> }).params ?? {}; |
| 85 | + |
| 86 | +describe('ClientOptions.extensions', () => { |
| 87 | + it('installs the extension at construction', () => { |
| 88 | + const log: string[] = []; |
| 89 | + new Client({ name: 'c', version: '1' }, { extensions: [gateExtension(log)] }); |
| 90 | + expect(log).toEqual(['installed']); |
| 91 | + }); |
| 92 | + |
| 93 | + it('advertises {} when install sets no settings', async () => { |
| 94 | + const { clientTx, written } = await scriptedServer('legacy'); |
| 95 | + const client = new Client({ name: 'c', version: '1' }, { extensions: [{ id: 'com.example/plain', install: () => {} }] }); |
| 96 | + await client.connect(clientTx); |
| 97 | + const initialize = written.find(message => (message as { method?: string }).method === 'initialize'); |
| 98 | + expect(paramsOf(initialize as JSONRPCMessage)['capabilities']).toMatchObject({ extensions: { 'com.example/plain': {} } }); |
| 99 | + await client.close(); |
| 100 | + }); |
| 101 | + |
| 102 | + it('sends the extension in initialize on a legacy connection', async () => { |
| 103 | + const { clientTx, written } = await scriptedServer('legacy'); |
| 104 | + const client = new Client({ name: 'c', version: '1' }, { extensions: [gateExtension([])] }); |
| 105 | + await client.connect(clientTx); |
| 106 | + const initialize = written.find(message => (message as { method?: string }).method === 'initialize'); |
| 107 | + expect(paramsOf(initialize as JSONRPCMessage)['capabilities']).toMatchObject({ extensions: { [EXT_ID]: { exampleData: true } } }); |
| 108 | + await client.close(); |
| 109 | + }); |
| 110 | + |
| 111 | + it('stamps the extension into every request envelope on a 2026-07-28 connection', async () => { |
| 112 | + const { clientTx, written } = await scriptedServer('modern'); |
| 113 | + const client = new Client({ name: 'c', version: '1' }, { versionNegotiation: { mode: 'auto' }, extensions: [gateExtension([])] }); |
| 114 | + await client.connect(clientTx); |
| 115 | + await client.listTools(); |
| 116 | + await flush(); |
| 117 | + const toolsList = written.find(message => (message as { method?: string }).method === 'tools/list'); |
| 118 | + const meta = paramsOf(toolsList as JSONRPCMessage)['_meta'] as Record<string, unknown>; |
| 119 | + expect(meta[CLIENT_CAPABILITIES_META_KEY]).toMatchObject({ extensions: { [EXT_ID]: { exampleData: true } } }); |
| 120 | + await client.close(); |
| 121 | + }); |
| 122 | + |
| 123 | + it('receives an extension result kind the extension accepted, discriminator included', async () => { |
| 124 | + const { clientTx } = await scriptedServer('modern'); |
| 125 | + const client = new Client({ name: 'c', version: '1' }, { versionNegotiation: { mode: 'auto' }, extensions: [gateExtension([])] }); |
| 126 | + await client.connect(clientTx); |
| 127 | + const taskSchema = z.looseObject({ resultType: z.literal('task'), taskId: z.string(), status: z.string() }); |
| 128 | + const result = await client.request({ method: 'tools/call', params: { name: 'slow', arguments: {} } }, taskSchema); |
| 129 | + expect(result).toMatchObject({ resultType: 'task', taskId: 't-1', status: 'working' }); |
| 130 | + // callTool validates against CallToolResultSchema, which a task handle does not satisfy. |
| 131 | + await expect(client.callTool({ name: 'slow', arguments: {} })).rejects.toThrow(/Invalid result for tools\/call/); |
| 132 | + await client.close(); |
| 133 | + }); |
| 134 | + |
| 135 | + it('serves the handler the extension installed for a server-to-client request', async () => { |
| 136 | + const { clientTx, serverTx, written } = await scriptedServer('legacy'); |
| 137 | + const client = new Client({ name: 'c', version: '1' }, { extensions: [gateExtension([])] }); |
| 138 | + await client.connect(clientTx); |
| 139 | + await serverTx.send({ jsonrpc: '2.0', id: 'srv-1', method: 'gate/ping', params: {} }); |
| 140 | + await flush(); |
| 141 | + const response = written.find(message => 'id' in message && message.id === 'srv-1'); |
| 142 | + expect((response as { result?: unknown }).result).toEqual({ pong: true }); |
| 143 | + await client.close(); |
| 144 | + }); |
| 145 | +}); |
0 commit comments