File size: 10,166 Bytes
064bfd6 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 | import type { Client } from '@modelcontextprotocol/sdk/client/index.js'
import {
ElicitationCompleteNotificationSchema,
type ElicitRequestParams,
ElicitRequestSchema,
type ElicitResult,
} from '@modelcontextprotocol/sdk/types.js'
import type { AppState } from '../../state/AppState.js'
import {
executeElicitationHooks,
executeElicitationResultHooks,
executeNotificationHooks,
} from '../../utils/hooks.js'
import { logMCPDebug, logMCPError } from '../../utils/log.js'
import { jsonStringify } from '../../utils/slowOperations.js'
import {
type AnalyticsMetadata_I_VERIFIED_THIS_IS_NOT_CODE_OR_FILEPATHS,
logEvent,
} from '../analytics/index.js'
/** Configuration for the waiting state shown after the user opens a URL. */
export type ElicitationWaitingState = {
/** Button label, e.g. "Retry now" or "Skip confirmation" */
actionLabel: string
/** Whether to show a visible Cancel button (e.g. for error-based retry flow) */
showCancel?: boolean
}
export type ElicitationRequestEvent = {
serverName: string
/** The JSON-RPC request ID, unique per server connection. */
requestId: string | number
params: ElicitRequestParams
signal: AbortSignal
/**
* Resolves the elicitation. For explicit elicitations, all actions are
* meaningful. For error-based retry (-32042), 'accept' is a no-op —
* the retry is driven by onWaitingDismiss instead.
*/
respond: (response: ElicitResult) => void
/** For URL elicitations: shown after user opens the browser. */
waitingState?: ElicitationWaitingState
/** Called when phase 2 (waiting) is dismissed by user action or completion. */
onWaitingDismiss?: (action: 'dismiss' | 'retry' | 'cancel') => void
/** Set to true by the completion notification handler when the server confirms completion. */
completed?: boolean
}
function getElicitationMode(params: ElicitRequestParams): 'form' | 'url' {
return params.mode === 'url' ? 'url' : 'form'
}
/** Find a queued elicitation event by server name and elicitationId. */
function findElicitationInQueue(
queue: ElicitationRequestEvent[],
serverName: string,
elicitationId: string,
): number {
return queue.findIndex(
e =>
e.serverName === serverName &&
e.params.mode === 'url' &&
'elicitationId' in e.params &&
e.params.elicitationId === elicitationId,
)
}
export function registerElicitationHandler(
client: Client,
serverName: string,
setAppState: (f: (prevState: AppState) => AppState) => void,
): void {
// Register the elicitation request handler.
// Wrapped in try/catch because setRequestHandler throws if the client wasn't
// created with elicitation capability declared.
try {
client.setRequestHandler(ElicitRequestSchema, async (request, extra) => {
logMCPDebug(
serverName,
`Received elicitation request: ${jsonStringify(request)}`,
)
const mode = getElicitationMode(request.params)
logEvent('tengu_mcp_elicitation_shown', {
mode: mode as AnalyticsMetadata_I_VERIFIED_THIS_IS_NOT_CODE_OR_FILEPATHS,
})
try {
// Run elicitation hooks first - they can provide a response programmatically
const hookResponse = await runElicitationHooks(
serverName,
request.params,
extra.signal,
)
if (hookResponse) {
logMCPDebug(
serverName,
`Elicitation resolved by hook: ${jsonStringify(hookResponse)}`,
)
logEvent('tengu_mcp_elicitation_response', {
mode: mode as AnalyticsMetadata_I_VERIFIED_THIS_IS_NOT_CODE_OR_FILEPATHS,
action:
hookResponse.action as AnalyticsMetadata_I_VERIFIED_THIS_IS_NOT_CODE_OR_FILEPATHS,
})
return hookResponse
}
const elicitationId =
mode === 'url' && 'elicitationId' in request.params
? (request.params.elicitationId as string | undefined)
: undefined
const response = new Promise<ElicitResult>(resolve => {
const onAbort = () => {
resolve({ action: 'cancel' })
}
if (extra.signal.aborted) {
onAbort()
return
}
const waitingState: ElicitationWaitingState | undefined =
elicitationId ? { actionLabel: 'Skip confirmation' } : undefined
setAppState(prev => ({
...prev,
elicitation: {
queue: [
...prev.elicitation.queue,
{
serverName,
requestId: extra.requestId,
params: request.params,
signal: extra.signal,
waitingState,
respond: (result: ElicitResult) => {
extra.signal.removeEventListener('abort', onAbort)
logEvent('tengu_mcp_elicitation_response', {
mode: mode as AnalyticsMetadata_I_VERIFIED_THIS_IS_NOT_CODE_OR_FILEPATHS,
action:
result.action as AnalyticsMetadata_I_VERIFIED_THIS_IS_NOT_CODE_OR_FILEPATHS,
})
resolve(result)
},
},
],
},
}))
extra.signal.addEventListener('abort', onAbort, { once: true })
})
const rawResult = await response
logMCPDebug(
serverName,
`Elicitation response: ${jsonStringify(rawResult)}`,
)
const result = await runElicitationResultHooks(
serverName,
rawResult,
extra.signal,
mode,
elicitationId,
)
return result
} catch (error) {
logMCPError(serverName, `Elicitation error: ${error}`)
return { action: 'cancel' as const }
}
})
// Register handler for elicitation completion notifications (URL mode).
// Sets `completed: true` on the matching queue event; the dialog reacts to this flag.
client.setNotificationHandler(
ElicitationCompleteNotificationSchema,
notification => {
const { elicitationId } = notification.params
logMCPDebug(
serverName,
`Received elicitation completion notification: ${elicitationId}`,
)
void executeNotificationHooks({
message: `MCP server "${serverName}" confirmed elicitation ${elicitationId} complete`,
notificationType: 'elicitation_complete',
})
let found = false
setAppState(prev => {
const idx = findElicitationInQueue(
prev.elicitation.queue,
serverName,
elicitationId,
)
if (idx === -1) return prev
found = true
const queue = [...prev.elicitation.queue]
queue[idx] = { ...queue[idx]!, completed: true }
return { ...prev, elicitation: { queue } }
})
if (!found) {
logMCPDebug(
serverName,
`Ignoring completion notification for unknown elicitation: ${elicitationId}`,
)
}
},
)
} catch {
// Client wasn't created with elicitation capability - nothing to register
return
}
}
export async function runElicitationHooks(
serverName: string,
params: ElicitRequestParams,
signal: AbortSignal,
): Promise<ElicitResult | undefined> {
try {
const mode = params.mode === 'url' ? 'url' : 'form'
const url = 'url' in params ? (params.url as string) : undefined
const elicitationId =
'elicitationId' in params
? (params.elicitationId as string | undefined)
: undefined
const { elicitationResponse, blockingError } =
await executeElicitationHooks({
serverName,
message: params.message,
requestedSchema:
'requestedSchema' in params
? (params.requestedSchema as Record<string, unknown>)
: undefined,
signal,
mode,
url,
elicitationId,
})
if (blockingError) {
return { action: 'decline' }
}
if (elicitationResponse) {
return {
action: elicitationResponse.action,
content: elicitationResponse.content,
}
}
return undefined
} catch (error) {
logMCPError(serverName, `Elicitation hook error: ${error}`)
return undefined
}
}
/**
* Run ElicitationResult hooks after the user has responded, then fire a
* `elicitation_response` notification. Returns a (potentially modified)
* ElicitResult — hooks may override the action/content or block the response.
*/
export async function runElicitationResultHooks(
serverName: string,
result: ElicitResult,
signal: AbortSignal,
mode?: 'form' | 'url',
elicitationId?: string,
): Promise<ElicitResult> {
try {
const { elicitationResultResponse, blockingError } =
await executeElicitationResultHooks({
serverName,
action: result.action,
content: result.content as Record<string, unknown> | undefined,
signal,
mode,
elicitationId,
})
if (blockingError) {
void executeNotificationHooks({
message: `Elicitation response for server "${serverName}": decline`,
notificationType: 'elicitation_response',
})
return { action: 'decline' }
}
const finalResult = elicitationResultResponse
? {
action: elicitationResultResponse.action,
content: elicitationResultResponse.content ?? result.content,
}
: result
// Fire a notification for observability
void executeNotificationHooks({
message: `Elicitation response for server "${serverName}": ${finalResult.action}`,
notificationType: 'elicitation_response',
})
return finalResult
} catch (error) {
logMCPError(serverName, `ElicitationResult hook error: ${error}`)
// Fire notification even on error
void executeNotificationHooks({
message: `Elicitation response for server "${serverName}": ${result.action}`,
notificationType: 'elicitation_response',
})
return result
}
}
|