|
| 1 | +import { afterEach, describe, expect, it } from 'vitest'; |
| 2 | +import { Client } from '@modelcontextprotocol/sdk/client/index.js'; |
| 3 | +import { InMemoryTransport } from '@modelcontextprotocol/sdk/inMemory.js'; |
| 4 | +import { LATEST_PROTOCOL_VERSION } from '@modelcontextprotocol/sdk/types.js'; |
| 5 | +import { SERVER_NAME, SERVER_VERSION } from '../constants.js'; |
| 6 | +import { setupCoreServer, teardownServer, type ServerHandle } from '../core/setup.js'; |
| 7 | +import { setupAllianceServer } from '../alliance/setup.js'; |
| 8 | +import { resolveAllianceConfig } from '../alliance/config.js'; |
| 9 | +import { createIsolatedContext } from '../core/server/server-context.js'; |
| 10 | +import { |
| 11 | + createTestServerContext, |
| 12 | + isolateFromDefaultContext, |
| 13 | + makeMockPineconeClient, |
| 14 | +} from '../core/server/tools/test-helpers.js'; |
| 15 | + |
| 16 | +/** |
| 17 | + * End-to-end MCP verification harness (#202). |
| 18 | + * |
| 19 | + * Drives the real `McpServer` over an in-memory transport with the SDK's own |
| 20 | + * `Client`, so a future SDK bump (the 2026-07-28 RC protocol revision, once it |
| 21 | + * ships) is verified in one place: the initialize handshake and protocol |
| 22 | + * negotiation, the full registered tool surface, and a round-trip tool call. |
| 23 | + * The protocol assertions key off the SDK's `LATEST_PROTOCOL_VERSION`, so when |
| 24 | + * the RC SDK is pinned they re-check the server against the new revision with no |
| 25 | + * edits here. If the RC is not published in time, this still guards the current |
| 26 | + * pinned SDK. |
| 27 | + */ |
| 28 | + |
| 29 | +const CORE_TOOLS = [ |
| 30 | + 'list_namespaces', |
| 31 | + 'namespace_router', |
| 32 | + 'count', |
| 33 | + 'query', |
| 34 | + 'keyword_search', |
| 35 | + 'query_documents', |
| 36 | + 'generate_urls', |
| 37 | + 'guided_query', |
| 38 | +].sort(); |
| 39 | + |
| 40 | +/** A fresh, isolated core server (own context + mock client) so several can coexist. */ |
| 41 | +async function freshCoreServer(namespaces: string[] = ['ns']): Promise<ServerHandle> { |
| 42 | + const ctx = createTestServerContext({ client: makeMockPineconeClient(namespaces) as never }); |
| 43 | + return setupCoreServer({ context: ctx }); |
| 44 | +} |
| 45 | + |
| 46 | +/** Link the SDK Client to a live server over paired in-memory transports. */ |
| 47 | +async function connectClient(server: ServerHandle): Promise<Client> { |
| 48 | + const [clientTransport, serverTransport] = InMemoryTransport.createLinkedPair(); |
| 49 | + await server.connect(serverTransport); |
| 50 | + const client = new Client({ name: 'rc-readiness-harness', version: '0.0.0' }); |
| 51 | + await client.connect(clientTransport); |
| 52 | + return client; |
| 53 | +} |
| 54 | + |
| 55 | +/** Send a raw JSON-RPC initialize and return the negotiated result. */ |
| 56 | +async function rawInitialize( |
| 57 | + server: ServerHandle, |
| 58 | + requestedProtocolVersion: string |
| 59 | +): Promise<{ protocolVersion: string; serverInfo: { name: string; version: string } }> { |
| 60 | + const [clientTransport, serverTransport] = InMemoryTransport.createLinkedPair(); |
| 61 | + await server.connect(serverTransport); |
| 62 | + const result = await new Promise<{ |
| 63 | + protocolVersion: string; |
| 64 | + serverInfo: { name: string; version: string }; |
| 65 | + }>((resolve, reject) => { |
| 66 | + // eslint-disable-next-line @typescript-eslint/no-explicit-any |
| 67 | + clientTransport.onmessage = (message: any) => { |
| 68 | + if (message?.id !== 1) return; |
| 69 | + if (message.error) reject(new Error(message.error.message)); |
| 70 | + else resolve(message.result); |
| 71 | + }; |
| 72 | + void clientTransport |
| 73 | + .start() |
| 74 | + .then(() => |
| 75 | + clientTransport.send({ |
| 76 | + jsonrpc: '2.0', |
| 77 | + id: 1, |
| 78 | + method: 'initialize', |
| 79 | + params: { |
| 80 | + protocolVersion: requestedProtocolVersion, |
| 81 | + capabilities: {}, |
| 82 | + clientInfo: { name: 'raw-harness', version: '0.0.0' }, |
| 83 | + }, |
| 84 | + }) |
| 85 | + ) |
| 86 | + .catch(reject); |
| 87 | + }); |
| 88 | + return result; |
| 89 | +} |
| 90 | + |
| 91 | +describe('MCP RC-readiness harness (#202)', () => { |
| 92 | + afterEach(() => { |
| 93 | + teardownServer(); |
| 94 | + isolateFromDefaultContext(); |
| 95 | + }); |
| 96 | + |
| 97 | + it('initializes over the transport and round-trips server metadata', async () => { |
| 98 | + const server = await freshCoreServer(); |
| 99 | + const client = await connectClient(server); |
| 100 | + |
| 101 | + // A resolved connect proves the initialize handshake and protocol |
| 102 | + // negotiation succeeded: the SDK Client throws if the server answers with a |
| 103 | + // protocolVersion outside SUPPORTED_PROTOCOL_VERSIONS. |
| 104 | + expect(client.getServerVersion()).toEqual({ name: SERVER_NAME, version: SERVER_VERSION }); |
| 105 | + expect(client.getServerCapabilities()?.tools).toBeDefined(); |
| 106 | + expect(client.getInstructions()).toBeTruthy(); |
| 107 | + |
| 108 | + await client.close(); |
| 109 | + }); |
| 110 | + |
| 111 | + it('exposes the full core tool surface through tools/list', async () => { |
| 112 | + const server = await freshCoreServer(); |
| 113 | + const client = await connectClient(server); |
| 114 | + |
| 115 | + const names = (await client.listTools()).tools.map((t) => t.name).sort(); |
| 116 | + expect(names).toEqual(CORE_TOOLS); |
| 117 | + |
| 118 | + await client.close(); |
| 119 | + }); |
| 120 | + |
| 121 | + it('registers the Alliance suggest_query_params tool on top of the core surface', async () => { |
| 122 | + const ctx = createIsolatedContext( |
| 123 | + resolveAllianceConfig({ apiKey: 'sk-test', indexName: 'test-index' }), |
| 124 | + { client: makeMockPineconeClient(['ns']) as never } |
| 125 | + ); |
| 126 | + const server = await setupAllianceServer({ context: ctx }); |
| 127 | + const client = await connectClient(server); |
| 128 | + |
| 129 | + const names = (await client.listTools()).tools.map((t) => t.name); |
| 130 | + for (const core of CORE_TOOLS) expect(names).toContain(core); |
| 131 | + expect(names).toContain('suggest_query_params'); |
| 132 | + |
| 133 | + await client.close(); |
| 134 | + }); |
| 135 | + |
| 136 | + it('round-trips a tool call over the transport', async () => { |
| 137 | + const server = await freshCoreServer(['alpha', 'beta']); |
| 138 | + const client = await connectClient(server); |
| 139 | + |
| 140 | + const res = await client.callTool({ name: 'list_namespaces', arguments: {} }); |
| 141 | + expect(res.isError ?? false).toBe(false); |
| 142 | + // The seeded namespaces must round-trip through the handler and transport, |
| 143 | + // not just any array, so a regression returning empty/garbage content fails. |
| 144 | + const text = (res.content as Array<{ type: string; text: string }>)[0]?.text ?? ''; |
| 145 | + expect(text).toContain('alpha'); |
| 146 | + expect(text).toContain('beta'); |
| 147 | + |
| 148 | + await client.close(); |
| 149 | + }); |
| 150 | + |
| 151 | + it('negotiates the SDK latest protocol version and falls back for an unknown request', async () => { |
| 152 | + // A server connects to one transport for its lifetime, so use a fresh one per probe. |
| 153 | + const negotiated = await rawInitialize(await freshCoreServer(), LATEST_PROTOCOL_VERSION); |
| 154 | + expect(negotiated.protocolVersion).toBe(LATEST_PROTOCOL_VERSION); |
| 155 | + expect(negotiated.serverInfo).toMatchObject({ name: SERVER_NAME, version: SERVER_VERSION }); |
| 156 | + |
| 157 | + // An unsupported request must not error; the server falls back to its latest. |
| 158 | + const fallback = await rawInitialize(await freshCoreServer(), 'not-a-real-protocol-version'); |
| 159 | + expect(fallback.protocolVersion).toBe(LATEST_PROTOCOL_VERSION); |
| 160 | + }); |
| 161 | +}); |
0 commit comments