@modelcontextprotocol/sdk 1.21.2 → 1.23.0-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (242) hide show
  1. package/README.md +92 -11
  2. package/dist/cjs/client/auth.d.ts +11 -1
  3. package/dist/cjs/client/auth.d.ts.map +1 -1
  4. package/dist/cjs/client/auth.js +71 -19
  5. package/dist/cjs/client/auth.js.map +1 -1
  6. package/dist/cjs/client/index.d.ts +252 -1478
  7. package/dist/cjs/client/index.d.ts.map +1 -1
  8. package/dist/cjs/client/index.js +130 -0
  9. package/dist/cjs/client/index.js.map +1 -1
  10. package/dist/cjs/client/sse.d.ts +1 -0
  11. package/dist/cjs/client/sse.d.ts.map +1 -1
  12. package/dist/cjs/client/sse.js +5 -3
  13. package/dist/cjs/client/sse.js.map +1 -1
  14. package/dist/cjs/client/streamableHttp.d.ts +2 -1
  15. package/dist/cjs/client/streamableHttp.d.ts.map +1 -1
  16. package/dist/cjs/client/streamableHttp.js +35 -15
  17. package/dist/cjs/client/streamableHttp.js.map +1 -1
  18. package/dist/cjs/examples/client/elicitationUrlExample.d.ts +2 -0
  19. package/dist/cjs/examples/client/elicitationUrlExample.d.ts.map +1 -0
  20. package/dist/cjs/examples/client/elicitationUrlExample.js +693 -0
  21. package/dist/cjs/examples/client/elicitationUrlExample.js.map +1 -0
  22. package/dist/cjs/examples/client/simpleOAuthClient.js +13 -52
  23. package/dist/cjs/examples/client/simpleOAuthClient.js.map +1 -1
  24. package/dist/cjs/examples/client/simpleOAuthClientProvider.d.ts +26 -0
  25. package/dist/cjs/examples/client/simpleOAuthClientProvider.d.ts.map +1 -0
  26. package/dist/cjs/examples/client/simpleOAuthClientProvider.js +51 -0
  27. package/dist/cjs/examples/client/simpleOAuthClientProvider.js.map +1 -0
  28. package/dist/cjs/examples/client/simpleStreamableHttp.js +11 -6
  29. package/dist/cjs/examples/client/simpleStreamableHttp.js.map +1 -1
  30. package/dist/cjs/examples/server/demoInMemoryOAuthProvider.d.ts +4 -4
  31. package/dist/cjs/examples/server/demoInMemoryOAuthProvider.d.ts.map +1 -1
  32. package/dist/cjs/examples/server/demoInMemoryOAuthProvider.js +16 -0
  33. package/dist/cjs/examples/server/demoInMemoryOAuthProvider.js.map +1 -1
  34. package/dist/cjs/examples/server/elicitationFormExample.d.ts +2 -0
  35. package/dist/cjs/examples/server/elicitationFormExample.d.ts.map +1 -0
  36. package/dist/cjs/examples/server/{elicitationExample.js → elicitationFormExample.js} +16 -12
  37. package/dist/cjs/examples/server/elicitationFormExample.js.map +1 -0
  38. package/dist/cjs/examples/server/elicitationUrlExample.d.ts +2 -0
  39. package/dist/cjs/examples/server/elicitationUrlExample.d.ts.map +1 -0
  40. package/dist/cjs/examples/server/elicitationUrlExample.js +655 -0
  41. package/dist/cjs/examples/server/elicitationUrlExample.js.map +1 -0
  42. package/dist/cjs/examples/server/jsonResponseStreamableHttp.js +26 -3
  43. package/dist/cjs/examples/server/jsonResponseStreamableHttp.js.map +1 -1
  44. package/dist/cjs/examples/server/mcpServerOutputSchema.js +34 -11
  45. package/dist/cjs/examples/server/mcpServerOutputSchema.js.map +1 -1
  46. package/dist/cjs/examples/server/simpleSseServer.js +26 -3
  47. package/dist/cjs/examples/server/simpleSseServer.js.map +1 -1
  48. package/dist/cjs/examples/server/simpleStatelessStreamableHttp.js +27 -4
  49. package/dist/cjs/examples/server/simpleStatelessStreamableHttp.js.map +1 -1
  50. package/dist/cjs/examples/server/simpleStreamableHttp.js +34 -10
  51. package/dist/cjs/examples/server/simpleStreamableHttp.js.map +1 -1
  52. package/dist/cjs/examples/server/sseAndStreamableHttpCompatibleServer.js +26 -3
  53. package/dist/cjs/examples/server/sseAndStreamableHttpCompatibleServer.js.map +1 -1
  54. package/dist/cjs/examples/server/toolWithSampleServer.js +30 -8
  55. package/dist/cjs/examples/server/toolWithSampleServer.js.map +1 -1
  56. package/dist/cjs/server/auth/handlers/authorize.js +34 -11
  57. package/dist/cjs/server/auth/handlers/authorize.js.map +1 -1
  58. package/dist/cjs/server/auth/handlers/token.js +35 -12
  59. package/dist/cjs/server/auth/handlers/token.js.map +1 -1
  60. package/dist/cjs/server/auth/middleware/bearerAuth.d.ts.map +1 -1
  61. package/dist/cjs/server/auth/middleware/bearerAuth.js +13 -8
  62. package/dist/cjs/server/auth/middleware/bearerAuth.js.map +1 -1
  63. package/dist/cjs/server/auth/middleware/clientAuth.js +27 -4
  64. package/dist/cjs/server/auth/middleware/clientAuth.js.map +1 -1
  65. package/dist/cjs/server/auth/router.js +1 -1
  66. package/dist/cjs/server/auth/router.js.map +1 -1
  67. package/dist/cjs/server/completable.d.ts +30 -16
  68. package/dist/cjs/server/completable.d.ts.map +1 -1
  69. package/dist/cjs/server/completable.js +38 -55
  70. package/dist/cjs/server/completable.js.map +1 -1
  71. package/dist/cjs/server/index.d.ts +213 -71
  72. package/dist/cjs/server/index.d.ts.map +1 -1
  73. package/dist/cjs/server/index.js +61 -16
  74. package/dist/cjs/server/index.js.map +1 -1
  75. package/dist/cjs/server/mcp.d.ts +14 -16
  76. package/dist/cjs/server/mcp.d.ts.map +1 -1
  77. package/dist/cjs/server/mcp.js +105 -41
  78. package/dist/cjs/server/mcp.js.map +1 -1
  79. package/dist/cjs/server/zod-compat.d.ts +82 -0
  80. package/dist/cjs/server/zod-compat.d.ts.map +1 -0
  81. package/dist/cjs/server/zod-compat.js +252 -0
  82. package/dist/cjs/server/zod-compat.js.map +1 -0
  83. package/dist/cjs/server/zod-json-schema-compat.d.ts +12 -0
  84. package/dist/cjs/server/zod-json-schema-compat.d.ts.map +1 -0
  85. package/dist/cjs/server/zod-json-schema-compat.js +80 -0
  86. package/dist/cjs/server/zod-json-schema-compat.js.map +1 -0
  87. package/dist/cjs/shared/auth.d.ts +116 -502
  88. package/dist/cjs/shared/auth.d.ts.map +1 -1
  89. package/dist/cjs/shared/auth.js +133 -112
  90. package/dist/cjs/shared/auth.js.map +1 -1
  91. package/dist/cjs/shared/metadataUtils.d.ts +5 -1
  92. package/dist/cjs/shared/metadataUtils.d.ts.map +1 -1
  93. package/dist/cjs/shared/metadataUtils.js +2 -5
  94. package/dist/cjs/shared/metadataUtils.js.map +1 -1
  95. package/dist/cjs/shared/protocol.d.ts +7 -10
  96. package/dist/cjs/shared/protocol.d.ts.map +1 -1
  97. package/dist/cjs/shared/protocol.js +39 -16
  98. package/dist/cjs/shared/protocol.js.map +1 -1
  99. package/dist/cjs/shared/toolNameValidation.d.ts +31 -0
  100. package/dist/cjs/shared/toolNameValidation.d.ts.map +1 -0
  101. package/dist/cjs/shared/toolNameValidation.js +97 -0
  102. package/dist/cjs/shared/toolNameValidation.js.map +1 -0
  103. package/dist/cjs/shared/transport.d.ts +15 -1
  104. package/dist/cjs/shared/transport.d.ts.map +1 -1
  105. package/dist/cjs/shared/transport.js +40 -0
  106. package/dist/cjs/shared/transport.js.map +1 -1
  107. package/dist/cjs/shared/zodTestMatrix.d.ts +16 -0
  108. package/dist/cjs/shared/zodTestMatrix.d.ts.map +1 -0
  109. package/dist/cjs/shared/zodTestMatrix.js +43 -0
  110. package/dist/cjs/shared/zodTestMatrix.js.map +1 -0
  111. package/dist/cjs/spec.types.d.ts +823 -261
  112. package/dist/cjs/spec.types.d.ts.map +1 -1
  113. package/dist/cjs/spec.types.js +5 -8
  114. package/dist/cjs/spec.types.js.map +1 -1
  115. package/dist/cjs/types.d.ts +3828 -59205
  116. package/dist/cjs/types.d.ts.map +1 -1
  117. package/dist/cjs/types.js +817 -487
  118. package/dist/cjs/types.js.map +1 -1
  119. package/dist/esm/client/auth.d.ts +11 -1
  120. package/dist/esm/client/auth.d.ts.map +1 -1
  121. package/dist/esm/client/auth.js +71 -20
  122. package/dist/esm/client/auth.js.map +1 -1
  123. package/dist/esm/client/index.d.ts +252 -1478
  124. package/dist/esm/client/index.d.ts.map +1 -1
  125. package/dist/esm/client/index.js +130 -1
  126. package/dist/esm/client/index.js.map +1 -1
  127. package/dist/esm/client/sse.d.ts +1 -0
  128. package/dist/esm/client/sse.d.ts.map +1 -1
  129. package/dist/esm/client/sse.js +5 -3
  130. package/dist/esm/client/sse.js.map +1 -1
  131. package/dist/esm/client/streamableHttp.d.ts +2 -1
  132. package/dist/esm/client/streamableHttp.d.ts.map +1 -1
  133. package/dist/esm/client/streamableHttp.js +35 -15
  134. package/dist/esm/client/streamableHttp.js.map +1 -1
  135. package/dist/esm/examples/client/elicitationUrlExample.d.ts +2 -0
  136. package/dist/esm/examples/client/elicitationUrlExample.d.ts.map +1 -0
  137. package/dist/esm/examples/client/elicitationUrlExample.js +691 -0
  138. package/dist/esm/examples/client/elicitationUrlExample.js.map +1 -0
  139. package/dist/esm/examples/client/simpleOAuthClient.js +12 -51
  140. package/dist/esm/examples/client/simpleOAuthClient.js.map +1 -1
  141. package/dist/esm/examples/client/simpleOAuthClientProvider.d.ts +26 -0
  142. package/dist/esm/examples/client/simpleOAuthClientProvider.d.ts.map +1 -0
  143. package/dist/esm/examples/client/simpleOAuthClientProvider.js +47 -0
  144. package/dist/esm/examples/client/simpleOAuthClientProvider.js.map +1 -0
  145. package/dist/esm/examples/client/simpleStreamableHttp.js +12 -7
  146. package/dist/esm/examples/client/simpleStreamableHttp.js.map +1 -1
  147. package/dist/esm/examples/server/demoInMemoryOAuthProvider.d.ts +4 -4
  148. package/dist/esm/examples/server/demoInMemoryOAuthProvider.d.ts.map +1 -1
  149. package/dist/esm/examples/server/demoInMemoryOAuthProvider.js +16 -0
  150. package/dist/esm/examples/server/demoInMemoryOAuthProvider.js.map +1 -1
  151. package/dist/esm/examples/server/elicitationFormExample.d.ts +2 -0
  152. package/dist/esm/examples/server/elicitationFormExample.d.ts.map +1 -0
  153. package/dist/esm/examples/server/{elicitationExample.js → elicitationFormExample.js} +16 -12
  154. package/dist/esm/examples/server/elicitationFormExample.js.map +1 -0
  155. package/dist/esm/examples/server/elicitationUrlExample.d.ts +2 -0
  156. package/dist/esm/examples/server/elicitationUrlExample.d.ts.map +1 -0
  157. package/dist/esm/examples/server/elicitationUrlExample.js +650 -0
  158. package/dist/esm/examples/server/elicitationUrlExample.js.map +1 -0
  159. package/dist/esm/examples/server/jsonResponseStreamableHttp.js +1 -1
  160. package/dist/esm/examples/server/jsonResponseStreamableHttp.js.map +1 -1
  161. package/dist/esm/examples/server/mcpServerOutputSchema.js +1 -1
  162. package/dist/esm/examples/server/mcpServerOutputSchema.js.map +1 -1
  163. package/dist/esm/examples/server/simpleSseServer.js +1 -1
  164. package/dist/esm/examples/server/simpleSseServer.js.map +1 -1
  165. package/dist/esm/examples/server/simpleStatelessStreamableHttp.js +1 -1
  166. package/dist/esm/examples/server/simpleStatelessStreamableHttp.js.map +1 -1
  167. package/dist/esm/examples/server/simpleStreamableHttp.js +4 -3
  168. package/dist/esm/examples/server/simpleStreamableHttp.js.map +1 -1
  169. package/dist/esm/examples/server/sseAndStreamableHttpCompatibleServer.js +1 -1
  170. package/dist/esm/examples/server/sseAndStreamableHttpCompatibleServer.js.map +1 -1
  171. package/dist/esm/examples/server/toolWithSampleServer.js +6 -7
  172. package/dist/esm/examples/server/toolWithSampleServer.js.map +1 -1
  173. package/dist/esm/server/auth/handlers/authorize.js +1 -1
  174. package/dist/esm/server/auth/handlers/authorize.js.map +1 -1
  175. package/dist/esm/server/auth/handlers/token.js +1 -1
  176. package/dist/esm/server/auth/handlers/token.js.map +1 -1
  177. package/dist/esm/server/auth/middleware/bearerAuth.d.ts.map +1 -1
  178. package/dist/esm/server/auth/middleware/bearerAuth.js +13 -8
  179. package/dist/esm/server/auth/middleware/bearerAuth.js.map +1 -1
  180. package/dist/esm/server/auth/middleware/clientAuth.js +1 -1
  181. package/dist/esm/server/auth/middleware/clientAuth.js.map +1 -1
  182. package/dist/esm/server/auth/router.js +1 -1
  183. package/dist/esm/server/auth/router.js.map +1 -1
  184. package/dist/esm/server/completable.d.ts +30 -16
  185. package/dist/esm/server/completable.d.ts.map +1 -1
  186. package/dist/esm/server/completable.js +34 -53
  187. package/dist/esm/server/completable.js.map +1 -1
  188. package/dist/esm/server/index.d.ts +213 -71
  189. package/dist/esm/server/index.d.ts.map +1 -1
  190. package/dist/esm/server/index.js +61 -16
  191. package/dist/esm/server/index.js.map +1 -1
  192. package/dist/esm/server/mcp.d.ts +14 -16
  193. package/dist/esm/server/mcp.d.ts.map +1 -1
  194. package/dist/esm/server/mcp.js +107 -43
  195. package/dist/esm/server/mcp.js.map +1 -1
  196. package/dist/esm/server/zod-compat.d.ts +82 -0
  197. package/dist/esm/server/zod-compat.d.ts.map +1 -0
  198. package/dist/esm/server/zod-compat.js +217 -0
  199. package/dist/esm/server/zod-compat.js.map +1 -0
  200. package/dist/esm/server/zod-json-schema-compat.d.ts +12 -0
  201. package/dist/esm/server/zod-json-schema-compat.d.ts.map +1 -0
  202. package/dist/esm/server/zod-json-schema-compat.js +52 -0
  203. package/dist/esm/server/zod-json-schema-compat.js.map +1 -0
  204. package/dist/esm/shared/auth.d.ts +116 -502
  205. package/dist/esm/shared/auth.d.ts.map +1 -1
  206. package/dist/esm/shared/auth.js +17 -19
  207. package/dist/esm/shared/auth.js.map +1 -1
  208. package/dist/esm/shared/metadataUtils.d.ts +5 -1
  209. package/dist/esm/shared/metadataUtils.d.ts.map +1 -1
  210. package/dist/esm/shared/metadataUtils.js +2 -5
  211. package/dist/esm/shared/metadataUtils.js.map +1 -1
  212. package/dist/esm/shared/protocol.d.ts +7 -10
  213. package/dist/esm/shared/protocol.d.ts.map +1 -1
  214. package/dist/esm/shared/protocol.js +39 -16
  215. package/dist/esm/shared/protocol.js.map +1 -1
  216. package/dist/esm/shared/toolNameValidation.d.ts +31 -0
  217. package/dist/esm/shared/toolNameValidation.d.ts.map +1 -0
  218. package/dist/esm/shared/toolNameValidation.js +92 -0
  219. package/dist/esm/shared/toolNameValidation.js.map +1 -0
  220. package/dist/esm/shared/transport.d.ts +15 -1
  221. package/dist/esm/shared/transport.d.ts.map +1 -1
  222. package/dist/esm/shared/transport.js +38 -1
  223. package/dist/esm/shared/transport.js.map +1 -1
  224. package/dist/esm/shared/zodTestMatrix.d.ts +16 -0
  225. package/dist/esm/shared/zodTestMatrix.d.ts.map +1 -0
  226. package/dist/esm/shared/zodTestMatrix.js +17 -0
  227. package/dist/esm/shared/zodTestMatrix.js.map +1 -0
  228. package/dist/esm/spec.types.d.ts +823 -261
  229. package/dist/esm/spec.types.d.ts.map +1 -1
  230. package/dist/esm/spec.types.js +4 -7
  231. package/dist/esm/spec.types.js.map +1 -1
  232. package/dist/esm/types.d.ts +3828 -59205
  233. package/dist/esm/types.d.ts.map +1 -1
  234. package/dist/esm/types.js +664 -360
  235. package/dist/esm/types.js.map +1 -1
  236. package/package.json +13 -12
  237. package/dist/cjs/examples/server/elicitationExample.d.ts +0 -2
  238. package/dist/cjs/examples/server/elicitationExample.d.ts.map +0 -1
  239. package/dist/cjs/examples/server/elicitationExample.js.map +0 -1
  240. package/dist/esm/examples/server/elicitationExample.d.ts +0 -2
  241. package/dist/esm/examples/server/elicitationExample.d.ts.map +0 -1
  242. package/dist/esm/examples/server/elicitationExample.js.map +0 -1
@@ -0,0 +1,650 @@
1
+ // Run with: npx tsx src/examples/server/elicitationUrlExample.ts
2
+ //
3
+ // This example demonstrates how to use URL elicitation to securely collect
4
+ // *sensitive* user input in a remote (HTTP) server.
5
+ // URL elicitation allows servers to prompt the end-user to open a URL in their browser
6
+ // to collect sensitive information.
7
+ // Note: See also elicitationFormExample.ts for an example of using form (not URL) elicitation
8
+ // to collect *non-sensitive* user input with a structured schema.
9
+ import express from 'express';
10
+ import { randomUUID } from 'node:crypto';
11
+ import { z } from 'zod';
12
+ import { McpServer } from '../../server/mcp.js';
13
+ import { StreamableHTTPServerTransport } from '../../server/streamableHttp.js';
14
+ import { getOAuthProtectedResourceMetadataUrl, mcpAuthMetadataRouter } from '../../server/auth/router.js';
15
+ import { requireBearerAuth } from '../../server/auth/middleware/bearerAuth.js';
16
+ import { UrlElicitationRequiredError, isInitializeRequest } from '../../types.js';
17
+ import { InMemoryEventStore } from '../shared/inMemoryEventStore.js';
18
+ import { setupAuthServer } from './demoInMemoryOAuthProvider.js';
19
+ import { checkResourceAllowed } from '../../shared/auth-utils.js';
20
+ import cors from 'cors';
21
+ // Create an MCP server with implementation details
22
+ const getServer = () => {
23
+ const mcpServer = new McpServer({
24
+ name: 'url-elicitation-http-server',
25
+ version: '1.0.0'
26
+ }, {
27
+ capabilities: { logging: {} }
28
+ });
29
+ mcpServer.registerTool('payment-confirm', {
30
+ description: 'A tool that confirms a payment directly with a user',
31
+ inputSchema: {
32
+ cartId: z.string().describe('The ID of the cart to confirm')
33
+ }
34
+ }, async ({ cartId }, extra) => {
35
+ /*
36
+ In a real world scenario, there would be some logic here to check if the user has the provided cartId.
37
+ For the purposes of this example, we'll throw an error (-> elicits the client to open a URL to confirm payment)
38
+ */
39
+ const sessionId = extra.sessionId;
40
+ if (!sessionId) {
41
+ throw new Error('Expected a Session ID');
42
+ }
43
+ // Create and track the elicitation
44
+ const elicitationId = generateTrackedElicitation(sessionId, elicitationId => mcpServer.server.createElicitationCompletionNotifier(elicitationId));
45
+ throw new UrlElicitationRequiredError([
46
+ {
47
+ mode: 'url',
48
+ message: 'This tool requires a payment confirmation. Open the link to confirm payment!',
49
+ url: `http://localhost:${MCP_PORT}/confirm-payment?session=${sessionId}&elicitation=${elicitationId}&cartId=${encodeURIComponent(cartId)}`,
50
+ elicitationId
51
+ }
52
+ ]);
53
+ });
54
+ mcpServer.registerTool('third-party-auth', {
55
+ description: 'A demo tool that requires third-party OAuth credentials',
56
+ inputSchema: {
57
+ param1: z.string().describe('First parameter')
58
+ }
59
+ }, async (_, extra) => {
60
+ /*
61
+ In a real world scenario, there would be some logic here to check if we already have a valid access token for the user.
62
+ Auth info (with a subject or `sub` claim) can be typically be found in `extra.authInfo`.
63
+ If we do, we can just return the result of the tool call.
64
+ If we don't, we can throw an ElicitationRequiredError to request the user to authenticate.
65
+ For the purposes of this example, we'll throw an error (-> elicits the client to open a URL to authenticate).
66
+ */
67
+ const sessionId = extra.sessionId;
68
+ if (!sessionId) {
69
+ throw new Error('Expected a Session ID');
70
+ }
71
+ // Create and track the elicitation
72
+ const elicitationId = generateTrackedElicitation(sessionId, elicitationId => mcpServer.server.createElicitationCompletionNotifier(elicitationId));
73
+ // Simulate OAuth callback and token exchange after 5 seconds
74
+ // In a real app, this would be called from your OAuth callback handler
75
+ setTimeout(() => {
76
+ console.log(`Simulating OAuth token received for elicitation ${elicitationId}`);
77
+ completeURLElicitation(elicitationId);
78
+ }, 5000);
79
+ throw new UrlElicitationRequiredError([
80
+ {
81
+ mode: 'url',
82
+ message: 'This tool requires access to your example.com account. Open the link to authenticate!',
83
+ url: 'https://www.example.com/oauth/authorize',
84
+ elicitationId
85
+ }
86
+ ]);
87
+ });
88
+ return mcpServer;
89
+ };
90
+ const elicitationsMap = new Map();
91
+ // Clean up old elicitations after 1 hour to prevent memory leaks
92
+ const ELICITATION_TTL_MS = 60 * 60 * 1000; // 1 hour
93
+ const CLEANUP_INTERVAL_MS = 10 * 60 * 1000; // 10 minutes
94
+ function cleanupOldElicitations() {
95
+ const now = new Date();
96
+ for (const [id, metadata] of elicitationsMap.entries()) {
97
+ if (now.getTime() - metadata.createdAt.getTime() > ELICITATION_TTL_MS) {
98
+ elicitationsMap.delete(id);
99
+ console.log(`Cleaned up expired elicitation: ${id}`);
100
+ }
101
+ }
102
+ }
103
+ setInterval(cleanupOldElicitations, CLEANUP_INTERVAL_MS);
104
+ /**
105
+ * Elicitation IDs must be unique strings within the MCP session
106
+ * UUIDs are used in this example for simplicity
107
+ */
108
+ function generateElicitationId() {
109
+ return randomUUID();
110
+ }
111
+ /**
112
+ * Helper function to create and track a new elicitation.
113
+ */
114
+ function generateTrackedElicitation(sessionId, createCompletionNotifier) {
115
+ const elicitationId = generateElicitationId();
116
+ // Create a Promise and its resolver for tracking completion
117
+ let completeResolver;
118
+ const completedPromise = new Promise(resolve => {
119
+ completeResolver = resolve;
120
+ });
121
+ const completionNotifier = createCompletionNotifier ? createCompletionNotifier(elicitationId) : undefined;
122
+ // Store the elicitation in our map
123
+ elicitationsMap.set(elicitationId, {
124
+ status: 'pending',
125
+ completedPromise,
126
+ completeResolver: completeResolver,
127
+ createdAt: new Date(),
128
+ sessionId,
129
+ completionNotifier
130
+ });
131
+ return elicitationId;
132
+ }
133
+ /**
134
+ * Helper function to complete an elicitation.
135
+ */
136
+ function completeURLElicitation(elicitationId) {
137
+ const elicitation = elicitationsMap.get(elicitationId);
138
+ if (!elicitation) {
139
+ console.warn(`Attempted to complete unknown elicitation: ${elicitationId}`);
140
+ return;
141
+ }
142
+ if (elicitation.status === 'complete') {
143
+ console.warn(`Elicitation already complete: ${elicitationId}`);
144
+ return;
145
+ }
146
+ // Update metadata
147
+ elicitation.status = 'complete';
148
+ // Send completion notification to the client
149
+ if (elicitation.completionNotifier) {
150
+ console.log(`Sending notifications/elicitation/complete notification for elicitation ${elicitationId}`);
151
+ elicitation.completionNotifier().catch(error => {
152
+ console.error(`Failed to send completion notification for elicitation ${elicitationId}:`, error);
153
+ });
154
+ }
155
+ // Resolve the promise to unblock any waiting code
156
+ elicitation.completeResolver();
157
+ }
158
+ const MCP_PORT = process.env.MCP_PORT ? parseInt(process.env.MCP_PORT, 10) : 3000;
159
+ const AUTH_PORT = process.env.MCP_AUTH_PORT ? parseInt(process.env.MCP_AUTH_PORT, 10) : 3001;
160
+ const app = express();
161
+ app.use(express.json());
162
+ // Allow CORS all domains, expose the Mcp-Session-Id header
163
+ app.use(cors({
164
+ origin: '*', // Allow all origins
165
+ exposedHeaders: ['Mcp-Session-Id'],
166
+ credentials: true // Allow cookies to be sent cross-origin
167
+ }));
168
+ // Set up OAuth (required for this example)
169
+ let authMiddleware = null;
170
+ // Create auth middleware for MCP endpoints
171
+ const mcpServerUrl = new URL(`http://localhost:${MCP_PORT}/mcp`);
172
+ const authServerUrl = new URL(`http://localhost:${AUTH_PORT}`);
173
+ const oauthMetadata = setupAuthServer({ authServerUrl, mcpServerUrl, strictResource: true });
174
+ const tokenVerifier = {
175
+ verifyAccessToken: async (token) => {
176
+ const endpoint = oauthMetadata.introspection_endpoint;
177
+ if (!endpoint) {
178
+ throw new Error('No token verification endpoint available in metadata');
179
+ }
180
+ const response = await fetch(endpoint, {
181
+ method: 'POST',
182
+ headers: {
183
+ 'Content-Type': 'application/x-www-form-urlencoded'
184
+ },
185
+ body: new URLSearchParams({
186
+ token: token
187
+ }).toString()
188
+ });
189
+ if (!response.ok) {
190
+ throw new Error(`Invalid or expired token: ${await response.text()}`);
191
+ }
192
+ const data = await response.json();
193
+ if (!data.aud) {
194
+ throw new Error(`Resource Indicator (RFC8707) missing`);
195
+ }
196
+ if (!checkResourceAllowed({ requestedResource: data.aud, configuredResource: mcpServerUrl })) {
197
+ throw new Error(`Expected resource indicator ${mcpServerUrl}, got: ${data.aud}`);
198
+ }
199
+ // Convert the response to AuthInfo format
200
+ return {
201
+ token,
202
+ clientId: data.client_id,
203
+ scopes: data.scope ? data.scope.split(' ') : [],
204
+ expiresAt: data.exp
205
+ };
206
+ }
207
+ };
208
+ // Add metadata routes to the main MCP server
209
+ app.use(mcpAuthMetadataRouter({
210
+ oauthMetadata,
211
+ resourceServerUrl: mcpServerUrl,
212
+ scopesSupported: ['mcp:tools'],
213
+ resourceName: 'MCP Demo Server'
214
+ }));
215
+ authMiddleware = requireBearerAuth({
216
+ verifier: tokenVerifier,
217
+ requiredScopes: [],
218
+ resourceMetadataUrl: getOAuthProtectedResourceMetadataUrl(mcpServerUrl)
219
+ });
220
+ /**
221
+ * API Key Form Handling
222
+ *
223
+ * Many servers today require an API key to operate, but there's no scalable way to do this dynamically for remote servers within MCP protocol.
224
+ * URL-mode elicitation enables the server to host a simple form and get the secret data securely from the user without involving the LLM or client.
225
+ **/
226
+ async function sendApiKeyElicitation(sessionId, sender, createCompletionNotifier) {
227
+ if (!sessionId) {
228
+ console.error('No session ID provided');
229
+ throw new Error('Expected a Session ID to track elicitation');
230
+ }
231
+ console.log('🔑 URL elicitation demo: Requesting API key from client...');
232
+ const elicitationId = generateTrackedElicitation(sessionId, createCompletionNotifier);
233
+ try {
234
+ const result = await sender({
235
+ mode: 'url',
236
+ message: 'Please provide your API key to authenticate with this server',
237
+ // Host the form on the same server. In a real app, you might coordinate passing these state variables differently.
238
+ url: `http://localhost:${MCP_PORT}/api-key-form?session=${sessionId}&elicitation=${elicitationId}`,
239
+ elicitationId
240
+ });
241
+ switch (result.action) {
242
+ case 'accept':
243
+ console.log('🔑 URL elicitation demo: Client accepted the API key elicitation (now pending form submission)');
244
+ // Wait for the API key to be submitted via the form
245
+ // The form submission will complete the elicitation
246
+ break;
247
+ default:
248
+ console.log('🔑 URL elicitation demo: Client declined to provide an API key');
249
+ // In a real app, this might close the connection, but for the demo, we'll continue
250
+ break;
251
+ }
252
+ }
253
+ catch (error) {
254
+ console.error('Error during API key elicitation:', error);
255
+ }
256
+ }
257
+ // API Key Form endpoint - serves a simple HTML form
258
+ app.get('/api-key-form', (req, res) => {
259
+ const mcpSessionId = req.query.session;
260
+ const elicitationId = req.query.elicitation;
261
+ if (!mcpSessionId || !elicitationId) {
262
+ res.status(400).send('<h1>Error</h1><p>Missing required parameters</p>');
263
+ return;
264
+ }
265
+ // Check for user session cookie
266
+ // In production, this is often handled by some user auth middleware to ensure the user has a valid session
267
+ // This session is different from the MCP session.
268
+ // This userSession is the cookie that the MCP Server's Authorization Server sets for the user when they log in.
269
+ const userSession = getUserSessionCookie(req.headers.cookie);
270
+ if (!userSession) {
271
+ res.status(401).send('<h1>Error</h1><p>Unauthorized - please reconnect to login again</p>');
272
+ return;
273
+ }
274
+ // Serve a simple HTML form
275
+ res.send(`
276
+ <!DOCTYPE html>
277
+ <html>
278
+ <head>
279
+ <title>Submit Your API Key</title>
280
+ <style>
281
+ body { font-family: sans-serif; max-width: 400px; margin: 50px auto; padding: 20px; }
282
+ input[type="text"] { width: 100%; padding: 8px; margin: 10px 0; box-sizing: border-box; }
283
+ button { background: #007bff; color: white; padding: 10px 20px; border: none; cursor: pointer; }
284
+ button:hover { background: #0056b3; }
285
+ .user { background: #d1ecf1; padding: 8px; margin-bottom: 10px; }
286
+ .info { color: #666; font-size: 0.9em; margin-top: 20px; }
287
+ </style>
288
+ </head>
289
+ <body>
290
+ <h1>API Key Required</h1>
291
+ <div class="user">✓ Logged in as: <strong>${userSession.name}</strong></div>
292
+ <form method="POST" action="/api-key-form">
293
+ <input type="hidden" name="session" value="${mcpSessionId}" />
294
+ <input type="hidden" name="elicitation" value="${elicitationId}" />
295
+ <label>API Key:<br>
296
+ <input type="text" name="apiKey" required placeholder="Enter your API key" />
297
+ </label>
298
+ <button type="submit">Submit</button>
299
+ </form>
300
+ <div class="info">This is a demo showing how a server can securely elicit sensitive data from a user using a URL.</div>
301
+ </body>
302
+ </html>
303
+ `);
304
+ });
305
+ // Handle API key form submission
306
+ app.post('/api-key-form', express.urlencoded(), (req, res) => {
307
+ const { session: sessionId, apiKey, elicitation: elicitationId } = req.body;
308
+ if (!sessionId || !apiKey || !elicitationId) {
309
+ res.status(400).send('<h1>Error</h1><p>Missing required parameters</p>');
310
+ return;
311
+ }
312
+ // Check for user session cookie here too
313
+ const userSession = getUserSessionCookie(req.headers.cookie);
314
+ if (!userSession) {
315
+ res.status(401).send('<h1>Error</h1><p>Unauthorized - please reconnect to login again</p>');
316
+ return;
317
+ }
318
+ // A real app might store this API key to be used later for the user.
319
+ console.log(`🔑 Received API key \x1b[32m${apiKey}\x1b[0m for session ${sessionId}`);
320
+ // If we have an elicitationId, complete the elicitation
321
+ completeURLElicitation(elicitationId);
322
+ // Send a success response
323
+ res.send(`
324
+ <!DOCTYPE html>
325
+ <html>
326
+ <head>
327
+ <title>Success</title>
328
+ <style>
329
+ body { font-family: sans-serif; max-width: 400px; margin: 50px auto; padding: 20px; text-align: center; }
330
+ .success { background: #d4edda; color: #155724; padding: 20px; margin: 20px 0; }
331
+ </style>
332
+ </head>
333
+ <body>
334
+ <div class="success">
335
+ <h1>Success ✓</h1>
336
+ <p>API key received.</p>
337
+ </div>
338
+ <p>You can close this window and return to your MCP client.</p>
339
+ </body>
340
+ </html>
341
+ `);
342
+ });
343
+ // Helper to get the user session from the demo_session cookie
344
+ function getUserSessionCookie(cookieHeader) {
345
+ if (!cookieHeader)
346
+ return null;
347
+ const cookies = cookieHeader.split(';');
348
+ for (const cookie of cookies) {
349
+ const [name, value] = cookie.trim().split('=');
350
+ if (name === 'demo_session' && value) {
351
+ try {
352
+ return JSON.parse(decodeURIComponent(value));
353
+ }
354
+ catch (error) {
355
+ console.error('Failed to parse demo_session cookie:', error);
356
+ return null;
357
+ }
358
+ }
359
+ }
360
+ return null;
361
+ }
362
+ /**
363
+ * Payment Confirmation Form Handling
364
+ *
365
+ * This demonstrates how a server can use URL-mode elicitation to get user confirmation
366
+ * for sensitive operations like payment processing.
367
+ **/
368
+ // Payment Confirmation Form endpoint - serves a simple HTML form
369
+ app.get('/confirm-payment', (req, res) => {
370
+ const mcpSessionId = req.query.session;
371
+ const elicitationId = req.query.elicitation;
372
+ const cartId = req.query.cartId;
373
+ if (!mcpSessionId || !elicitationId) {
374
+ res.status(400).send('<h1>Error</h1><p>Missing required parameters</p>');
375
+ return;
376
+ }
377
+ // Check for user session cookie
378
+ // In production, this is often handled by some user auth middleware to ensure the user has a valid session
379
+ // This session is different from the MCP session.
380
+ // This userSession is the cookie that the MCP Server's Authorization Server sets for the user when they log in.
381
+ const userSession = getUserSessionCookie(req.headers.cookie);
382
+ if (!userSession) {
383
+ res.status(401).send('<h1>Error</h1><p>Unauthorized - please reconnect to login again</p>');
384
+ return;
385
+ }
386
+ // Serve a simple HTML form
387
+ res.send(`
388
+ <!DOCTYPE html>
389
+ <html>
390
+ <head>
391
+ <title>Confirm Payment</title>
392
+ <style>
393
+ body { font-family: sans-serif; max-width: 400px; margin: 50px auto; padding: 20px; }
394
+ button { background: #28a745; color: white; padding: 12px 24px; border: none; cursor: pointer; font-size: 16px; width: 100%; margin: 10px 0; }
395
+ button:hover { background: #218838; }
396
+ button.cancel { background: #6c757d; }
397
+ button.cancel:hover { background: #5a6268; }
398
+ .user { background: #d1ecf1; padding: 8px; margin-bottom: 10px; }
399
+ .cart-info { background: #f8f9fa; padding: 12px; margin: 15px 0; border-left: 4px solid #007bff; }
400
+ .info { color: #666; font-size: 0.9em; margin-top: 20px; }
401
+ .warning { background: #fff3cd; color: #856404; padding: 12px; margin: 15px 0; border-left: 4px solid #ffc107; }
402
+ </style>
403
+ </head>
404
+ <body>
405
+ <h1>Confirm Payment</h1>
406
+ <div class="user">✓ Logged in as: <strong>${userSession.name}</strong></div>
407
+ ${cartId ? `<div class="cart-info"><strong>Cart ID:</strong> ${cartId}</div>` : ''}
408
+ <div class="warning">
409
+ <strong>⚠️ Please review your order before confirming.</strong>
410
+ </div>
411
+ <form method="POST" action="/confirm-payment">
412
+ <input type="hidden" name="session" value="${mcpSessionId}" />
413
+ <input type="hidden" name="elicitation" value="${elicitationId}" />
414
+ ${cartId ? `<input type="hidden" name="cartId" value="${cartId}" />` : ''}
415
+ <button type="submit" name="action" value="confirm">Confirm Payment</button>
416
+ <button type="submit" name="action" value="cancel" class="cancel">Cancel</button>
417
+ </form>
418
+ <div class="info">This is a demo showing how a server can securely get user confirmation for sensitive operations using URL-mode elicitation.</div>
419
+ </body>
420
+ </html>
421
+ `);
422
+ });
423
+ // Handle Payment Confirmation form submission
424
+ app.post('/confirm-payment', express.urlencoded(), (req, res) => {
425
+ const { session: sessionId, elicitation: elicitationId, cartId, action } = req.body;
426
+ if (!sessionId || !elicitationId) {
427
+ res.status(400).send('<h1>Error</h1><p>Missing required parameters</p>');
428
+ return;
429
+ }
430
+ // Check for user session cookie here too
431
+ const userSession = getUserSessionCookie(req.headers.cookie);
432
+ if (!userSession) {
433
+ res.status(401).send('<h1>Error</h1><p>Unauthorized - please reconnect to login again</p>');
434
+ return;
435
+ }
436
+ if (action === 'confirm') {
437
+ // A real app would process the payment here
438
+ console.log(`💳 Payment confirmed for cart ${cartId || 'unknown'} by user ${userSession.name} (session ${sessionId})`);
439
+ // Complete the elicitation
440
+ completeURLElicitation(elicitationId);
441
+ // Send a success response
442
+ res.send(`
443
+ <!DOCTYPE html>
444
+ <html>
445
+ <head>
446
+ <title>Payment Confirmed</title>
447
+ <style>
448
+ body { font-family: sans-serif; max-width: 400px; margin: 50px auto; padding: 20px; text-align: center; }
449
+ .success { background: #d4edda; color: #155724; padding: 20px; margin: 20px 0; }
450
+ </style>
451
+ </head>
452
+ <body>
453
+ <div class="success">
454
+ <h1>Payment Confirmed ✓</h1>
455
+ <p>Your payment has been successfully processed.</p>
456
+ ${cartId ? `<p><strong>Cart ID:</strong> ${cartId}</p>` : ''}
457
+ </div>
458
+ <p>You can close this window and return to your MCP client.</p>
459
+ </body>
460
+ </html>
461
+ `);
462
+ }
463
+ else if (action === 'cancel') {
464
+ console.log(`💳 Payment cancelled for cart ${cartId || 'unknown'} by user ${userSession.name} (session ${sessionId})`);
465
+ // The client will still receive a notifications/elicitation/complete notification,
466
+ // which indicates that the out-of-band interaction is complete (but not necessarily successful)
467
+ completeURLElicitation(elicitationId);
468
+ res.send(`
469
+ <!DOCTYPE html>
470
+ <html>
471
+ <head>
472
+ <title>Payment Cancelled</title>
473
+ <style>
474
+ body { font-family: sans-serif; max-width: 400px; margin: 50px auto; padding: 20px; text-align: center; }
475
+ .info { background: #d1ecf1; color: #0c5460; padding: 20px; margin: 20px 0; }
476
+ </style>
477
+ </head>
478
+ <body>
479
+ <div class="info">
480
+ <h1>Payment Cancelled</h1>
481
+ <p>Your payment has been cancelled.</p>
482
+ </div>
483
+ <p>You can close this window and return to your MCP client.</p>
484
+ </body>
485
+ </html>
486
+ `);
487
+ }
488
+ else {
489
+ res.status(400).send('<h1>Error</h1><p>Invalid action</p>');
490
+ }
491
+ });
492
+ // Map to store transports by session ID
493
+ const transports = {};
494
+ const sessionsNeedingElicitation = {};
495
+ // MCP POST endpoint
496
+ const mcpPostHandler = async (req, res) => {
497
+ const sessionId = req.headers['mcp-session-id'];
498
+ console.debug(`Received MCP POST for session: ${sessionId || 'unknown'}`);
499
+ try {
500
+ let transport;
501
+ if (sessionId && transports[sessionId]) {
502
+ // Reuse existing transport
503
+ transport = transports[sessionId];
504
+ }
505
+ else if (!sessionId && isInitializeRequest(req.body)) {
506
+ const server = getServer();
507
+ // New initialization request
508
+ const eventStore = new InMemoryEventStore();
509
+ transport = new StreamableHTTPServerTransport({
510
+ sessionIdGenerator: () => randomUUID(),
511
+ eventStore, // Enable resumability
512
+ onsessioninitialized: sessionId => {
513
+ // Store the transport by session ID when session is initialized
514
+ // This avoids race conditions where requests might come in before the session is stored
515
+ console.log(`Session initialized with ID: ${sessionId}`);
516
+ transports[sessionId] = transport;
517
+ sessionsNeedingElicitation[sessionId] = {
518
+ elicitationSender: params => server.server.elicitInput(params),
519
+ createCompletionNotifier: elicitationId => server.server.createElicitationCompletionNotifier(elicitationId)
520
+ };
521
+ }
522
+ });
523
+ // Set up onclose handler to clean up transport when closed
524
+ transport.onclose = () => {
525
+ const sid = transport.sessionId;
526
+ if (sid && transports[sid]) {
527
+ console.log(`Transport closed for session ${sid}, removing from transports map`);
528
+ delete transports[sid];
529
+ delete sessionsNeedingElicitation[sid];
530
+ }
531
+ };
532
+ // Connect the transport to the MCP server BEFORE handling the request
533
+ // so responses can flow back through the same transport
534
+ await server.connect(transport);
535
+ await transport.handleRequest(req, res, req.body);
536
+ return; // Already handled
537
+ }
538
+ else {
539
+ // Invalid request - no session ID or not initialization request
540
+ res.status(400).json({
541
+ jsonrpc: '2.0',
542
+ error: {
543
+ code: -32000,
544
+ message: 'Bad Request: No valid session ID provided'
545
+ },
546
+ id: null
547
+ });
548
+ return;
549
+ }
550
+ // Handle the request with existing transport - no need to reconnect
551
+ // The existing transport is already connected to the server
552
+ await transport.handleRequest(req, res, req.body);
553
+ }
554
+ catch (error) {
555
+ console.error('Error handling MCP request:', error);
556
+ if (!res.headersSent) {
557
+ res.status(500).json({
558
+ jsonrpc: '2.0',
559
+ error: {
560
+ code: -32603,
561
+ message: 'Internal server error'
562
+ },
563
+ id: null
564
+ });
565
+ }
566
+ }
567
+ };
568
+ // Set up routes with auth middleware
569
+ app.post('/mcp', authMiddleware, mcpPostHandler);
570
+ // Handle GET requests for SSE streams (using built-in support from StreamableHTTP)
571
+ const mcpGetHandler = async (req, res) => {
572
+ const sessionId = req.headers['mcp-session-id'];
573
+ if (!sessionId || !transports[sessionId]) {
574
+ res.status(400).send('Invalid or missing session ID');
575
+ return;
576
+ }
577
+ // Check for Last-Event-ID header for resumability
578
+ const lastEventId = req.headers['last-event-id'];
579
+ if (lastEventId) {
580
+ console.log(`Client reconnecting with Last-Event-ID: ${lastEventId}`);
581
+ }
582
+ else {
583
+ console.log(`Establishing new SSE stream for session ${sessionId}`);
584
+ }
585
+ const transport = transports[sessionId];
586
+ await transport.handleRequest(req, res);
587
+ if (sessionsNeedingElicitation[sessionId]) {
588
+ const { elicitationSender, createCompletionNotifier } = sessionsNeedingElicitation[sessionId];
589
+ // Send an elicitation request to the client in the background
590
+ sendApiKeyElicitation(sessionId, elicitationSender, createCompletionNotifier)
591
+ .then(() => {
592
+ // Only delete on successful send for this demo
593
+ delete sessionsNeedingElicitation[sessionId];
594
+ console.log(`🔑 URL elicitation demo: Finished sending API key elicitation request for session ${sessionId}`);
595
+ })
596
+ .catch(error => {
597
+ console.error('Error sending API key elicitation:', error);
598
+ // Keep in map to potentially retry on next reconnect
599
+ });
600
+ }
601
+ };
602
+ // Set up GET route with conditional auth middleware
603
+ app.get('/mcp', authMiddleware, mcpGetHandler);
604
+ // Handle DELETE requests for session termination (according to MCP spec)
605
+ const mcpDeleteHandler = async (req, res) => {
606
+ const sessionId = req.headers['mcp-session-id'];
607
+ if (!sessionId || !transports[sessionId]) {
608
+ res.status(400).send('Invalid or missing session ID');
609
+ return;
610
+ }
611
+ console.log(`Received session termination request for session ${sessionId}`);
612
+ try {
613
+ const transport = transports[sessionId];
614
+ await transport.handleRequest(req, res);
615
+ }
616
+ catch (error) {
617
+ console.error('Error handling session termination:', error);
618
+ if (!res.headersSent) {
619
+ res.status(500).send('Error processing session termination');
620
+ }
621
+ }
622
+ };
623
+ // Set up DELETE route with auth middleware
624
+ app.delete('/mcp', authMiddleware, mcpDeleteHandler);
625
+ app.listen(MCP_PORT, error => {
626
+ if (error) {
627
+ console.error('Failed to start server:', error);
628
+ process.exit(1);
629
+ }
630
+ console.log(`MCP Streamable HTTP Server listening on port ${MCP_PORT}`);
631
+ });
632
+ // Handle server shutdown
633
+ process.on('SIGINT', async () => {
634
+ console.log('Shutting down server...');
635
+ // Close all active transports to properly clean up resources
636
+ for (const sessionId in transports) {
637
+ try {
638
+ console.log(`Closing transport for session ${sessionId}`);
639
+ await transports[sessionId].close();
640
+ delete transports[sessionId];
641
+ delete sessionsNeedingElicitation[sessionId];
642
+ }
643
+ catch (error) {
644
+ console.error(`Error closing transport for session ${sessionId}:`, error);
645
+ }
646
+ }
647
+ console.log('Server shutdown complete');
648
+ process.exit(0);
649
+ });
650
+ //# sourceMappingURL=elicitationUrlExample.js.map