Rebuild elicitInput() with overloads

Author: nbarbettini

README.md

@@ -1207,7 +1207,8 @@ server.registerTool(
 
         if (!available) {
             // Ask user if they want to try alternative dates
-            const result = await server.server.elicitFormInput({
+            const result = await server.server.elicitInput({
+                mode: 'form',
                 message: `No tables available at ${restaurant} on ${date}. Would you like to check alternative dates?`,
                 requestedSchema: {
                     type: 'object',
@@ -1299,6 +1300,8 @@ client.setRequestHandler(ElicitRequestSchema, async request => {
 });
 ```
 
+When calling `server.elicitInput`, prefer to explicitly set `mode: 'form'` for new code. Omitting the mode continues to work for backwards compatibility and defaults to form elicitation.
+
 Elicitation is a client capability. Clients must declare the `elicitation` capability during initialization:
 
 ```typescript
@@ -1325,7 +1328,8 @@ MCP servers can prompt the user to perform a URL-based action through URL elicit
 
 ```typescript
 // Server-side: Prompt the user to navigate to a URL
-const result = await server.server.elicitURLInput({
+const result = await server.server.elicitInput({
+    mode: 'url',
     message: 'Please enter your API key',
     elicitationId: '550e8400-e29b-41d4-a716-446655440000',
     url: 'http://localhost:3000/api-key'

src/client/index.test.ts

@@ -643,7 +643,8 @@ test('should accept form-mode elicitation request when client advertises empty e
     // Server should be able to send form-mode elicitation request
     // This works because getSupportedElicitationModes defaults to form mode
     // when neither form nor url are explicitly declared
-    const result = await server.elicitFormInput({
+    const result = await server.elicitInput({
+        mode: 'form',
         message: 'Please provide your username',
         requestedSchema: {
             type: 'object',
@@ -883,7 +884,8 @@ test('should apply defaults for form-mode elicitation when applyDefaults is enab
 
     await Promise.all([client.connect(clientTransport), server.connect(serverTransport)]);
 
-    const result = await server.elicitFormInput({
+    const result = await server.elicitInput({
+        mode: 'form',
         message: 'Please confirm your preferences',
         requestedSchema: {
             type: 'object',

src/examples/server/elicitationFormExample.ts

@@ -39,7 +39,8 @@ mcpServer.registerTool(
     async () => {
         try {
             // Request user information through form elicitation
-            const result = await mcpServer.server.elicitFormInput({
+            const result = await mcpServer.server.elicitInput({
+                mode: 'form',
                 message: 'Please provide your registration information:',
                 requestedSchema: {
                     type: 'object',
@@ -137,7 +138,8 @@ mcpServer.registerTool(
     async () => {
         try {
             // Step 1: Collect basic event information
-            const basicInfo = await mcpServer.server.elicitFormInput({
+            const basicInfo = await mcpServer.server.elicitInput({
+                mode: 'form',
                 message: 'Step 1: Enter basic event information',
                 requestedSchema: {
                     type: 'object',
@@ -165,7 +167,8 @@ mcpServer.registerTool(
             }
 
             // Step 2: Collect date and time
-            const dateTime = await mcpServer.server.elicitFormInput({
+            const dateTime = await mcpServer.server.elicitInput({
+                mode: 'form',
                 message: 'Step 2: Enter date and time',
                 requestedSchema: {
                     type: 'object',
@@ -239,7 +242,8 @@ mcpServer.registerTool(
     },
     async () => {
         try {
-            const result = await mcpServer.server.elicitFormInput({
+            const result = await mcpServer.server.elicitInput({
+                mode: 'form',
                 message: 'Please provide your shipping address:',
                 requestedSchema: {
                     type: 'object',

src/examples/server/elicitationUrlExample.ts

@@ -623,7 +623,7 @@ const mcpPostHandler = async (req: Request, res: Response) => {
                     console.log(`Session initialized with ID: ${sessionId}`);
                     transports[sessionId] = transport;
                     sessionsNeedingElicitation[sessionId] = {
-                        elicitationSender: server.server.elicitUrl.bind(server.server),
+                        elicitationSender: params => server.server.elicitInput(params),
                         createCompletionNotifier: elicitationId => server.server.createElicitationCompletionNotifier(elicitationId)
                     };
                 }

src/examples/server/simpleStreamableHttp.ts

@@ -215,7 +215,8 @@ const getServer = () => {
 
             try {
                 // Use the underlying server instance to elicit input from the client
-                const result = await server.server.elicitFormInput({
+                const result = await server.server.elicitInput({
+                    mode: 'form',
                     message,
                     requestedSchema
                 });