Skip to content

Commit ab0f8d8

Browse files
committed
fix(apps): match extension protocol properties case-sensitively
Signed-off-by: FenjuFu <[email protected]>
1 parent 084c987 commit ab0f8d8

3 files changed

Lines changed: 75 additions & 1 deletion

File tree

‎docs/concepts/apps/apps.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,12 @@ The key concepts are:
3232
- **UI resources** — HTML content served with the MIME type `text/html;profile=mcp-app`
3333
- **Tool UI metadata** — Tools declare their associated UI resource in `_meta.ui`
3434

35+
### JSON property matching
36+
37+
`McpApps.SerializerOptions` matches extension-defined property names case-sensitively, using `McpJsonUtilities.ProtocolOptions` together with the Apps source-generated metadata. For example, `resourceUri` and `mimeTypes` bind their respective properties, while `ResourceUri` and `MimeTypes` are ignored. When both spellings occur, the canonical spelling is used regardless of their order. This agrees with `McpApps.GetUiCapability`.
38+
39+
This changes the behavior of applications that previously deserialized alternate-cased JSON through the Apps preset. Correctly cased JSON, serialization output, and strongly typed C# usage are unchanged. `McpJsonUtilities.DefaultOptions` continues to match user-defined data case-insensitively, and callers can still supply their own serializer options.
40+
3541
## Associating tools with UI resources
3642

3743
### Using the builder extension (recommended)

‎src/ModelContextProtocol.Extensions.Apps/Server/McpApps.cs‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,14 @@ public static class McpApps
5555
/// <remarks>
5656
/// Use these options when serializing or deserializing MCP Apps types such as
5757
/// <see cref="McpUiToolMeta"/>, <see cref="McpUiClientCapabilities"/>, and <see cref="McpUiResourceMeta"/>.
58+
/// Property names are matched case-sensitively, as with <see cref="McpJsonUtilities.ProtocolOptions"/>.
59+
/// Alternate spellings such as <c>ResourceUri</c> do not bind the protocol's <c>resourceUri</c> property.
5860
/// </remarks>
5961
public static JsonSerializerOptions SerializerOptions { get; } = CreateSerializerOptions();
6062

6163
private static JsonSerializerOptions CreateSerializerOptions()
6264
{
63-
var options = new JsonSerializerOptions(McpJsonUtilities.DefaultOptions);
65+
var options = new JsonSerializerOptions(McpJsonUtilities.ProtocolOptions);
6466
options.TypeInfoResolverChain.Insert(0, McpAppsJsonContext.Default);
6567
options.MakeReadOnly();
6668
return options;

‎tests/ModelContextProtocol.Tests/Server/McpAppsTests.cs‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,72 @@ public void McpUiToolVisibility_Constants_HaveExpectedValues()
3737

3838
#region F2: Typed Metadata Models
3939

40+
[Theory]
41+
[InlineData("""{"resourceUri":"ui://app"}""", "ui://app")]
42+
[InlineData("""{"ResourceUri":"ui://other"}""", null)]
43+
[InlineData("""{"resourceUri":"ui://app","ResourceUri":"ui://other"}""", "ui://app")]
44+
[InlineData("""{"ResourceUri":"ui://other","resourceUri":"ui://app"}""", "ui://app")]
45+
public void SerializerOptions_MatchesToolMetadataCaseSensitively(string json, string? expectedUri)
46+
{
47+
var meta = JsonSerializer.Deserialize<McpUiToolMeta>(json, McpApps.SerializerOptions);
48+
49+
Assert.NotNull(meta);
50+
Assert.Equal(expectedUri, meta.ResourceUri);
51+
}
52+
53+
[Theory]
54+
[InlineData("""{"mimeTypes":["text/html"]}""", "text/html")]
55+
[InlineData("""{"MimeTypes":["text/plain"]}""", null)]
56+
[InlineData("""{"mimeTypes":["text/html"],"MimeTypes":["text/plain"]}""", "text/html")]
57+
[InlineData("""{"MimeTypes":["text/plain"],"mimeTypes":["text/html"]}""", "text/html")]
58+
public void SerializerOptions_AgreesWithGetUiCapability(string json, string? expectedMimeType)
59+
{
60+
var deserialized = JsonSerializer.Deserialize<McpUiClientCapabilities>(json, McpApps.SerializerOptions);
61+
using var document = JsonDocument.Parse(json);
62+
#pragma warning disable MCPEXP001
63+
var capabilities = new ClientCapabilities
64+
{
65+
Extensions = new Dictionary<string, object>
66+
{
67+
[McpApps.ExtensionId] = document.RootElement,
68+
},
69+
};
70+
#pragma warning restore MCPEXP001
71+
72+
var capability = McpApps.GetUiCapability(capabilities);
73+
74+
Assert.NotNull(deserialized);
75+
Assert.NotNull(capability);
76+
if (expectedMimeType is null)
77+
{
78+
Assert.Null(deserialized.MimeTypes);
79+
Assert.Null(capability.MimeTypes);
80+
}
81+
else
82+
{
83+
Assert.Equal(expectedMimeType, Assert.Single(deserialized.MimeTypes!));
84+
Assert.Equal(expectedMimeType, Assert.Single(capability.MimeTypes!));
85+
}
86+
}
87+
88+
[Fact]
89+
public void SerializerOptions_DoesNotChangeDefaultOrCallerOptions()
90+
{
91+
var options = new JsonSerializerOptions(McpApps.SerializerOptions)
92+
{
93+
PropertyNameCaseInsensitive = true,
94+
};
95+
96+
var meta = JsonSerializer.Deserialize<McpUiToolMeta>("""{"ResourceUri":"ui://app"}""", options);
97+
98+
Assert.NotNull(meta);
99+
Assert.Equal("ui://app", meta.ResourceUri);
100+
Assert.True(options.PropertyNameCaseInsensitive);
101+
Assert.True(McpJsonUtilities.DefaultOptions.PropertyNameCaseInsensitive);
102+
Assert.False(McpApps.SerializerOptions.PropertyNameCaseInsensitive);
103+
Assert.True(McpApps.SerializerOptions.IsReadOnly);
104+
}
105+
40106
[Fact]
41107
public void McpUiToolMeta_DefaultsToNull()
42108
{

0 commit comments

Comments
 (0)