Hey @Kehrlann, here's the design I'm proposing. Happy to iterate.

Context: The TypeScript SDK already implements URL mode elicitation. The Java SDK has the capability plumbing (#731) but not the actual protocol flow.

Approach: Flat record (matching TypeScript runtime behavior)

I considered two options:

Sealed interface (ElicitRequestFormParams | ElicitRequestURLParams with @JsonTypeInfo) — gives compile-time type safety but breaks the existing handler signature Function<ElicitRequest, Mono<ElicitResult>> and every createElicitation() call site. The Content interface uses this pattern, but it was designed that way from the start.
Flat record (add mode, url, elicitationId to existing ElicitRequest) — zero breaking changes, matches how the TypeScript SDK actually works at runtime (elicitInput() takes the union and switches on mode). Tradeoff: no compile-time enforcement that URL mode can't have requestedSchema, but the builder validates at runtime.

I went with option 2. The TypeScript SDK doesn't break its handler signature either — it keeps one handler that receives ElicitRequest and branches on params.mode.

Changes :

McpSchema.ElicitRequest — added mode, url, elicitationId fields. Backward-compat constructors preserved. Builder validates mode="url" requires url+elicitationId.
McpSchema.ElicitationCompleteNotification — new record for notifications/elicitation/complete
McpSchema.ErrorCodes.URL_ELICITATION_REQUIRED = -32042
McpAsyncServerExchange.createElicitation() — now checks URL capability when mode="url"
McpAsyncServerExchange.sendElicitationComplete() — new method
McpSyncServerExchange — sync wrapper
Client side: elicitationCompleteConsumer on builder, notification handler in McpAsyncClient

Open questions for you:

Are you OK with the flat record approach, or do you prefer the sealed interface despite the breaking change?
Should the builder throw on mode="url" + requestedSchema, or silently ignore requestedSchema?
Any naming preferences? (sendElicitationComplete vs notifyElicitationComplete)

SEP-1036: URL Mode Elicitation for secure out-of-band interactions #692

Description

Metadata

Metadata

Assignees

Labels

Type

Fields

Projects

Milestone

Relationships

Development

Issue actions