Skip to content

Support C# union return values in tools, prompts, and resources #2015

Open

Description

@halter73

Description

When a tool, prompt, or resource method returns a C# union, its active case is not handled like the same value returned directly. The SDK's result conversion sees the boxed union rather than the active value.

Reproduction

Run this with the .NET 11 SDK, targeting net11.0 with LangVersion set to preview:

using System;
using System.IO;
using ModelContextProtocol.Protocol;
using ModelContextProtocol.Server;

await using var server = McpServer.Create(
    new StreamServerTransport(Stream.Null, Stream.Null),
    new McpServerOptions());

var tool = McpServerTool.Create(
    () => (TextOrImage)"hello",
    new() { Name = "example" });

var request = new RequestContext<CallToolRequestParams>(
    server,
    new JsonRpcRequest { Method = "tools/call" },
    new CallToolRequestParams { Name = "example" });

var result = await tool.InvokeAsync(request);
Console.WriteLine(((TextContentBlock)result.Content[0]).Text);

public union TextOrImage(string, ImageContentBlock);

The text contains "hello", including the quote characters. Returning "hello" directly produces hello without those characters. An ImageContentBlock case is similarly serialized into a text block instead of being returned as image content. A CallToolResult case is serialized into text rather than passed through, so properties such as IsError are not propagated as result properties.

Prompts and resources have the same underlying issue, but throw instead of falling back to JSON serialization. For example, a prompt returning the string case of union TextOrPrompt(string, PromptMessage) throws InvalidOperationException: Unknown result type 'TextOrPrompt' returned from prompt function. A resource returning the string case of union TextOrResource(string, ResourceContents) throws InvalidOperationException: Unsupported result type 'TextOrResource' returned from resource function.

Expected behavior

Handle a union's active case as the corresponding directly returned value for tools, prompts, and resources. Preserve the existing handling of ordinary return values, structured content and output schemas, including compatibility with older protocol versions.

Investigation

The result switches in AIFunctionMcpServerTool, AIFunctionMcpServerPrompt, and AIFunctionMcpServerResource match the boxed union rather than its active case. Compiler-generated unions implement System.Runtime.CompilerServices.IUnion on .NET 11; the SDK also targets older frameworks, so compatibility and Native AOT need consideration.

Reproduced against the SDK at commit 64cfd66b147553d8cf953f9e2a374aae96014968, using its net10.0 Core build in a .NET 11 application.

Note

This issue was drafted with GitHub Copilot.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions