Refine the interaction and type definitions for the elicitation

Author: aiqlcom

src/main/IPCs.ts

@@ -26,7 +26,7 @@ import { closeCommandPicker } from './aid/commands'
 
 import { commandSelectionInvoke, mcpServersCallback } from './index'
 import { getCachedText } from './aid/utils'
-import { SamplingResponse } from './types'
+import { McpClientResponse } from './types'
 
 const handlerRegistry = new Map<string, Function>()
 
@@ -290,11 +290,11 @@ export default class IPCs {
   }
 }
 
-export function listenOnceForSamplingResponse(
+export function listenOnceForRendererResponse(
   responseChannel: string,
-  resolve: (_value: SamplingResponse) => void
+  resolve: (_value: McpClientResponse) => void
 ) {
-  ipcMain.once(responseChannel, (_event, response: SamplingResponse) => {
+  ipcMain.once(responseChannel, (_event, response: McpClientResponse) => {
     resolve(response)
   })
 }

src/main/index.ts

@@ -5,21 +5,22 @@ import { createErrorWindow, createMainWindow } from './MainRunner'
 
 import {
   SamplingRequest,
-  IpcElicitationEvents,
+  SamplingResponse,
+  ElicitRequest,
+  ElicitResponse,
   IpcCommandEvents,
-  IpcMcpEvents,
-  SamplingResponse
+  IpcMcpEvents
 } from './types'
 
-import { listenOnceForSamplingResponse } from './IPCs'
+import { IpcSamplingRequest, IpcElicitRequest } from '@/types/ipc'
+
+import { listenOnceForRendererResponse } from './IPCs'
 
 import * as shortcuts from './aid/shortcuts'
 import Commander from './aid/commander'
 
 import { showWindow } from './tray'
 
-import { McpClientResult, IpcSamplingRequest } from '@/types/ipc'
-
 let mainWindow: BrowserWindow
 let errorWindow: BrowserWindow
 
@@ -117,7 +118,7 @@ process.on('uncaughtException', async () => {
 
 const msgSamplingTransferResultChannel = 'msgSamplingTransferResult'
 
-export function samplingTransferInvoke(request: SamplingRequest): Promise<McpClientResult> {
+export function samplingTransferInvoke(request: SamplingRequest): Promise<SamplingResponse> {
   return new Promise<SamplingResponse>((resolve) => {
     if (!mainWindow || mainWindow.isDestroyed()) {
       resolve(null)
@@ -126,7 +127,7 @@ export function samplingTransferInvoke(request: SamplingRequest): Promise<McpCli
 
     const responseChannel = `${msgSamplingTransferResultChannel}-${uuidv4()}`
 
-    listenOnceForSamplingResponse(responseChannel, resolve)
+    listenOnceForRendererResponse(responseChannel, resolve)
 
     mainWindow.webContents.send('msgSamplingTransferInvoke', {
       request,
@@ -137,9 +138,7 @@ export function samplingTransferInvoke(request: SamplingRequest): Promise<McpCli
 
 const msgElicitationTransferResultChannel = 'msgElicitationTransferResult'
 
-export function elicitationTransferInvoke<T extends keyof IpcElicitationEvents>(
-  ...args: Parameters<IpcElicitationEvents[T]>
-): Promise<any> {
+export function elicitationTransferInvoke(request: ElicitRequest): Promise<ElicitResponse> {
   return new Promise((resolve) => {
     if (!mainWindow || mainWindow.isDestroyed()) {
       resolve(null)
@@ -148,12 +147,12 @@ export function elicitationTransferInvoke<T extends keyof IpcElicitationEvents>(
 
     const responseChannel = `${msgElicitationTransferResultChannel}-${uuidv4()}`
 
-    listenOnceForSamplingResponse(responseChannel, resolve)
+    listenOnceForRendererResponse(responseChannel, resolve)
 
     mainWindow.webContents.send('msgElicitationTransferInvoke', {
-      args,
+      request,
       responseChannel
-    })
+    } as IpcElicitRequest)
   })
 }
 

src/main/types.ts

@@ -1,12 +1,14 @@
 import {
+  ClientResult as McpClientResponse,
   CreateMessageRequest as SamplingRequest,
   CreateMessageResult as SamplingResponse,
-  ElicitRequest
+  ElicitRequest,
+  ElicitResult as ElicitResponse
 } from '@modelcontextprotocol/sdk/types.js'
 
 import { McpCallback } from './mcp/types'
 
-export { SamplingRequest, SamplingResponse }
+export { McpClientResponse, SamplingRequest, SamplingResponse, ElicitRequest, ElicitResponse }
 
 type CommandRequest = {
   prompt: string

src/renderer/components/common/ElicitationCard.vue

@@ -1,7 +1,7 @@
 <script setup lang="ts">
-import { ref, toRaw } from 'vue'
+import { ref, toRaw, computed } from 'vue'
 import { ElicitationTransfer } from '@/renderer/utils'
-import type { ElicitRequest, ElicitResult } from '@modelcontextprotocol/sdk/types'
+import { IpcElicitRequestCallback, ElicitRequest, ElicitResponse } from '@/types/ipc'
 import { validateNumberRange } from '@/renderer/store/dxt'
 import { useI18n } from 'vue-i18n'
 const { t } = useI18n()
@@ -20,6 +20,14 @@ const elicitationParams = ref<ElicitRequestParams | {}>({})
 
 const elicitationChannel = ref('')
 
+const normalizedProperties = computed(() => {
+  const props = (elicitationParams.value as ElicitRequestParams).requestedSchema.properties
+  return Object.keys(props).map((key) => ({
+    key,
+    para: props[key]
+  }))
+})
+
 const getConfigAttribute = (name: string) => {
   return elicitationResults.value[name] ?? null
 }
@@ -34,7 +42,7 @@ const dynamicModel = (name: string) => ({
 })
 
 const declineElicitation = () => {
-  const response: ElicitResult = {
+  const response: ElicitResponse = {
     action: 'decline'
   }
   ElicitationTransfer.response(elicitationChannel.value, response)
@@ -43,7 +51,7 @@ const declineElicitation = () => {
 }
 
 // const cancelElicitation = () => {
-//   const response: ElicitResult = {
+//   const response: ElicitResponse = {
 //     "action": "cancel"
 //   }
 //   ElicitationTransfer.response(elicitationChannel.value, response)
@@ -52,7 +60,7 @@ const declineElicitation = () => {
 // }
 
 const acceptElicitation = () => {
-  const response: ElicitResult = {
+  const response: ElicitResponse = {
     action: 'accept',
     content: toRaw(elicitationResults.value)
   }
@@ -110,10 +118,10 @@ const validateStringLength = (
   }
 }
 
-const handleProgress = (_event, progress) => {
+const handleProgress: IpcElicitRequestCallback = (_event, progress) => {
   console.log('Elicitation', progress)
   elicitationDialog.value = true
-  elicitationParams.value = progress.args[0].params
+  elicitationParams.value = progress.request.params as ElicitRequestParams
   elicitationChannel.value = progress.responseChannel
 }
 
@@ -137,11 +145,7 @@ ElicitationTransfer.request(handleProgress)
           'properties' in elicitationParams.requestedSchema
         "
       >
-        <v-row
-          v-for="(para, key) in elicitationParams.requestedSchema.properties"
-          :key="key"
-          class="mx-3 mb-3"
-        >
+        <v-row v-for="{ para, key } in normalizedProperties" :key="key" class="mx-3 mb-3">
           <v-select
             v-if="para.enum"
             prepend-icon="mdi-list-box-outline"

src/renderer/components/common/SamplingCard.vue

@@ -8,12 +8,9 @@ import { useMessageStore } from '@/renderer/store/message'
 import { createCompletion } from '@/renderer/composables/chatCompletions'
 import ConfigJsonCard from './ConfigJsonCard.vue'
 
-import type {
-  ChatCompletionResponseMessage,
-  McpSamplingResponseMessage
-} from '@/renderer/types/message'
+import type { ChatCompletionResponseMessage } from '@/renderer/types/message'
 
-import { IpcSamplingRequestCallback, SamplingRequest } from '@/types/ipc'
+import { IpcSamplingRequestCallback, SamplingRequest, SamplingResponse } from '@/types/ipc'
 
 type SamplingRequestParams = SamplingRequest['params']
 
@@ -64,7 +61,7 @@ const clearSampling = () => {
 
 const finishSampling = (index: number) => {
   const bestResponse: ChatCompletionResponseMessage = samplingResults.value[index]
-  const response: McpSamplingResponseMessage = {
+  const response: SamplingResponse = {
     model: chatbotStore.model,
     role: bestResponse?.role || 'assistant',
     content: {
@@ -81,7 +78,7 @@ const finishSampling = (index: number) => {
 }
 
 const rejectSampling = () => {
-  const response: McpSamplingResponseMessage = {
+  const response: SamplingResponse = {
     model: 'N/A',
     role: 'assistant',
     stopReason: 'Reject by user',

src/renderer/components/pages/ChatPage.vue

@@ -15,7 +15,7 @@ import 'katex/dist/katex.min.css'
 
 import mermaid from 'mermaid'
 
-import * as echarts from 'echarts';
+import * as echarts from 'echarts'
 
 import highlight from 'highlight.js'
 import 'highlight.js/styles/atom-one-dark.css'

src/renderer/composables/chatCompletions.ts

@@ -128,22 +128,6 @@ export const createCompletion = async (
 
   console.log(chatbotConfig)
 
-  const conversation = rawconversation.reduce((newConversation, item) => {
-    if (item.role === 'assistant') {
-      const { reasoning_content, ...rest } = item
-      void reasoning_content
-      newConversation.push(rest)
-    }
-    // (item.role === "user" && item.content[0].type === "image_url") {
-    //     // Image is too large, only latest query could be kept
-    //     newConversation = [item];
-    // }
-    else {
-      newConversation.push(item)
-    }
-    return newConversation
-  }, [] as RequestMessageType[])
-  // const conversation = rawconversation
   try {
     // Create a completion (axios is not used here because it does not support streaming)
 
@@ -186,6 +170,22 @@ export const createCompletion = async (
     let target: ChatConversationMessage[]
 
     if (!sampling) {
+      const conversation = rawconversation.reduce((newConversation, item) => {
+        if (item.role === 'assistant') {
+          const { reasoning_content, ...rest } = item
+          void reasoning_content
+          newConversation.push(rest)
+        }
+        // (item.role === "user" && item.content[0].type === "image_url") {
+        //     // Image is too large, only latest query could be kept
+        //     newConversation = [item];
+        // }
+        else {
+          newConversation.push(item)
+        }
+        return newConversation
+      }, [] as RequestMessageType[])
+
       target = messageStore.conversation
 
       body.messages = promptMessage(

src/renderer/utils/index.ts

@@ -1,7 +1,8 @@
 import type { McpServerApi } from '@/renderer/store/mcp'
 import { useDxtStore } from '@/renderer/store/dxt'
 
-import { IpcSamplingRequestCallback } from '@/types/ipc'
+import { IpcSamplingRequestCallback, IpcElicitRequestCallback } from '@/types/ipc'
+import { SamplingResponse, ElicitResponse } from '@/types/ipc'
 
 function isValidValue(value: any): boolean {
   if (value === null || value === undefined) return false
@@ -76,7 +77,11 @@ class Sampling {
   }
 
   // Channel format: "msgSamplingTransferResult-uuid4()"
-  static async msgSamplingTransferResult(channel: string, response: any): Promise<void> {
+  static async msgSamplingTransferResult(
+    channel: string,
+    response: SamplingResponse
+  ): Promise<void> {
+    console.log(response)
     await window.mainApi.send(channel, response)
   }
 }
@@ -87,12 +92,15 @@ export const SamplingTransfer = {
 }
 
 class Elicitation {
-  static async msgElicitationTransferInvoke(callback: any): Promise<any> {
+  static async msgElicitationTransferInvoke(callback: IpcElicitRequestCallback): Promise<void> {
     return window.mainApi.on('msgElicitationTransferInvoke', callback)
   }
 
   // Channel format: "msgElicitationTransferResult-uuid4()"
-  static async msgElicitationTransferResult(channel: string, response: any): Promise<void> {
+  static async msgElicitationTransferResult(
+    channel: string,
+    response: ElicitResponse
+  ): Promise<void> {
     await window.mainApi.send(channel, response)
   }
 }

src/types/ipc.d.ts

@@ -1,12 +1,17 @@
-import type { ClientResult as McpClientResult } from '@modelcontextprotocol/sdk/types'
+import type { SamplingRequest, SamplingResponse, ElicitRequest, ElicitResponse } from '@/main/types'
 
-import type { SamplingRequest } from '@/main/types'
-
-export type { McpClientResult, SamplingRequest }
+export type { SamplingRequest, SamplingResponse, ElicitRequest, ElicitResponse }
 
 export type IpcSamplingRequest = {
   request: SamplingRequest
   responseChannel: string
 }
 
-export type IpcSamplingRequestCallback = (_event: Event, _progress: IpcSamplingProgress) => void
+export type IpcSamplingRequestCallback = (_event: Event, _progress: IpcSamplingRequest) => void
+
+export type IpcElicitRequest = {
+  request: ElicitRequest
+  responseChannel: string
+}
+
+export type IpcElicitRequestCallback = (_event: Event, _progress: IpcElicitRequest) => void