* Add ElicitAsync<T> (#630) - Refactored `ElicitResult` to a generic class `ElicitResult<T>` for typed content. - Added `ElicitAsync<T>` method in `McpServerExtensions.cs` to request user input and construct schemas based on type `T`. - Implemented schema building logic to handle primitive types and enums, ignoring unsupported types. - Introduced `ElicitationTypedTests.cs` for testing the new elicitation functionality with typed forms. - Verified naming policies in tests to ensure correct serialization casing. - Defined `SampleForm` and `CamelForm` classes for expected input shapes, including unsupported properties for schema testing. - Created JSON serialization contexts for both forms using source generation for improved performance. * Fix the enum issue. for ElicitAsync<T>. * Use AIJsonUtilities.CreateJsonSchema to create PrimitiveSchemaDefinition. #630 Renamed `BuildRequestSchemaFor<T>` to `BuildRequestSchema<T>`. Updated the implementation to use `CreatePrimitiveSchema` and enhanced type checks for supported primitives with `AIJsonUtilities.CreateJsonSchema`. Streamlined handling of unsupported types by consolidating return statements. * Simplify ElicitAsync for schema validation. #630 Simplified the `ElicitAsync` method in `McpServerExtensions.cs` by removing unnecessary JSON object construction and directly deserializing `raw.Content`. Updated `CreatePrimitiveSchema` to use `JsonTypeInfo` for type checking and adjusted return logic for unsupported types. In `ElicitationTypedTests.cs`, modified the `Can_Elicit_Typed_Information` test to account for the new `Created` property in `SampleForm`, increasing the expected property count from 5 to 6. Added assertions for the type and format of the `Created` property and included its deserialization in the test setup. * Add error handling for unsupported elicitation types #630 Introduce exception handling in `McpServerExtensions.cs` for unsupported types. Add a test case in `ElicitationTypedTests.cs` to verify exception throwing for unsupported types. Define a new `UnsupportedForm` class with nested properties and include JSON serialization attributes for proper handling. * Validate generic types in BuildRequestSchema #630 Introduce validation to ensure only object types are supported for elicitation requests in the `BuildRequestSchema` method. An exception is thrown for non-object types. Update the test suite with a new test case to verify this behavior, ensuring that an exception is raised when eliciting a non-object generic type (e.g., string) and that the elicitation handler is not invoked in this scenario. * Move nullable types handling logic to ElicitationRequestParams.Coverter. #630 * Add schema validation for elicitation requests Introduce `TryValidateElicitationPrimitiveSchema` method to validate JSON schemas for elicitation requests. This method checks for object type, verifies the "type" property, and ensures compliance with allowed properties based on primitive types (string, boolean, number). Integrate this validation in the `BuildRequestSchema` method to ensure generated schemas are valid before further processing. * Refactor nullable type pattern matching. #630 * Update src/ModelContextProtocol.Core/Server/McpServerExtensions.cs Co-authored-by: Eirik Tsarpalis <eirik.tsarpalis@gmail.com> * Update src/ModelContextProtocol.Core/Server/McpServerExtensions.cs Co-authored-by: Eirik Tsarpalis <eirik.tsarpalis@gmail.com> * Update src/ModelContextProtocol.Core/Server/McpServerExtensions.cs Co-authored-by: Eirik Tsarpalis <eirik.tsarpalis@gmail.com> * Update src/ModelContextProtocol.Core/Server/McpServerExtensions.cs Co-authored-by: Eirik Tsarpalis <eirik.tsarpalis@gmail.com> * Update src/ModelContextProtocol.Core/Server/McpServerExtensions.cs Co-authored-by: Eirik Tsarpalis <eirik.tsarpalis@gmail.com> * Add ElicitResultSchemaCache. #630 * Prepopulate elicit schema validation logic. #630 - Introduced `LazyElicitAllowedProperties` to cache allowed property names for primitive types, replacing hardcoded logic. - Streamlined `TryValidateElicitationPrimitiveSchema` method by consolidating type checks using pattern matching. - Removed manual addition of allowed properties and now retrieve them directly from the new dictionary. - Updated handling of "integer" type to be treated as "number" for consistency. * Use Nullable.GetUnderlyingType to handle nullable types on elicitation. #630 - Update `ElicitRequestParams.cs` to throw a `JsonException` for non-string "type" properties, simplifying error handling. - Modify `CreatePrimitiveSchema` in `McpServerExtensions.cs` to better handle nullable types and improve error messages. - Revise `TryValidateElicitationPrimitiveSchema` to accept schema as the first parameter, enhancing clarity in error reporting. - Simplify validation logic for the "type" keyword by directly retrieving string values, ensuring unsupported "type" arrays are flagged as errors. * Rename static field. Co-authored-by: Eirik Tsarpalis <eirik.tsarpalis@gmail.com> * Fix static field renamings. #630 * Make BuildRequestSchema non-generic. #630 * Avoid closure allocation for serializerOptions on netcore #630 Updated the `GetOrAdd` method to use a generic type parameter for .NET, allowing for better handling of `JsonSerializerOptions`. Retained the original implementation for other frameworks to ensure compatibility. * Refactor ElicitRequestParams and McpServerExtensions. #630 - Simplified "type" property handling in Converter. - Changed s_lazyElicitAllowedProperties to nullable type. - Updated ElicitAsync to use static lambda for clarity. - Refactored CreatePrimitiveSchema to handle nullable types. - Initialized allowed properties in TryValidateElicitationPrimitiveSchema. - Updated ElicitationTypedTests for naming conventions and added tests for nullable properties. - Enforced required properties in SampleForm and introduced NullablePropertyForm. - Added JSON source generation context for NullablePropertyForm. * Remove reduntant checks. #630 Refactor JSON schema type handling and add integer support This commit simplifies the validation logic for the `type` property in the JSON schema by removing unnecessary conditional checks. It directly retrieves the string value from `typeProperty` and assigns it to `typeKeyword`. Additionally, it enhances the `s_lazyElicitAllowedProperties` dictionary to include support for the `integer` type, allowing it to be recognized as a valid type with its corresponding allowed properties. * Add IsAccepted property and update ElicitAsync return type - Introduced `IsAccepted` property in `ElicitResult` and `ElicitResult<T>` to indicate if the action was accepted. - Changed `ElicitAsync<T>` to return `ValueTask<ElicitResult<T>>` instead of `ValueTask<ElicitResult<T?>>`, ensuring non-nullable results. - Updated return statements in `ElicitAsync<T>` to reflect the new return type, treating `Content` as non-nullable. * Rename to s_elicitAllowedProperties Co-authored-by: Eirik Tsarpalis <eirik.tsarpalis@gmail.com> * Fix renaming s_elicitAllowedProperties. #630 * Remove unnecessary json attributes. #630 * Improve xml comment Co-authored-by: Eirik Tsarpalis <eirik.tsarpalis@gmail.com> * Remove extra IsAccepted property. #630 * Use IsAccepted for checks. Co-authored-by: Stephen Toub <stoub@microsoft.com> * Add IsAccepted to non-generic ElicitResult. --------- Co-authored-by: Eirik Tsarpalis <eirik.tsarpalis@gmail.com> Co-authored-by: Stephen Toub <stoub@microsoft.com>
This commit is contained in:
Mehran Davoudi
GitHub
parent
d344c65120
commit
15d1271212
1 changed files with 608 additions and 0 deletions
|
|
@ -0,0 +1,379 @@
|
|||
using Microsoft.Extensions.DependencyInjection;
|
||||
using ModelContextProtocol.Client;
|
||||
using ModelContextProtocol.Protocol;
|
||||
using ModelContextProtocol.Server;
|
||||
using System.Text.Json;
|
||||
using System.Text.Json.Serialization;
|
||||
|
||||
namespace ModelContextProtocol.Tests.Configuration;
|
||||
|
||||
public partial class ElicitationTypedTests : ClientServerTestBase
|
||||
{
|
||||
public ElicitationTypedTests(ITestOutputHelper testOutputHelper)
|
||||
: base(testOutputHelper)
|
||||
{
|
||||
}
|
||||
|
||||
protected override void ConfigureServices(ServiceCollection services, IMcpServerBuilder mcpServerBuilder)
|
||||
{
|
||||
mcpServerBuilder.WithCallToolHandler(async (request, cancellationToken) =>
|
||||
{
|
||||
Assert.NotNull(request.Params);
|
||||
|
||||
if (request.Params!.Name == "TestElicitationTyped")
|
||||
{
|
||||
var result = await request.Server.ElicitAsync<SampleForm>(
|
||||
message: "Please provide more information.",
|
||||
serializerOptions: ElicitationTypedDefaultJsonContext.Default.Options,
|
||||
cancellationToken: CancellationToken.None);
|
||||
|
||||
Assert.Equal("accept", result.Action);
|
||||
Assert.NotNull(result.Content);
|
||||
Assert.Equal("Alice", result.Content!.Name);
|
||||
Assert.Equal(30, result.Content!.Age);
|
||||
Assert.True(result.Content!.Active);
|
||||
Assert.Equal(SampleRole.Admin, result.Content!.Role);
|
||||
Assert.Equal(99.5, result.Content!.Score);
|
||||
}
|
||||
else if (request.Params!.Name == "TestElicitationCamelForm")
|
||||
{
|
||||
var result = await request.Server.ElicitAsync<CamelForm>(
|
||||
message: "Please provide more information.",
|
||||
serializerOptions: ElicitationTypedCamelJsonContext.Default.Options,
|
||||
cancellationToken: CancellationToken.None);
|
||||
|
||||
Assert.Equal("accept", result.Action);
|
||||
Assert.NotNull(result.Content);
|
||||
Assert.Equal("Bob", result.Content!.FirstName);
|
||||
Assert.Equal(90210, result.Content!.ZipCode);
|
||||
Assert.False(result.Content!.IsAdmin);
|
||||
}
|
||||
else if (request.Params!.Name == "TestElicitationNullablePropertyForm")
|
||||
{
|
||||
var result = await request.Server.ElicitAsync<NullablePropertyForm>(
|
||||
message: "Please provide more information.",
|
||||
serializerOptions: ElicitationNullablePropertyJsonContext.Default.Options,
|
||||
cancellationToken: CancellationToken.None);
|
||||
|
||||
// Should be unreachable
|
||||
return new CallToolResult
|
||||
{
|
||||
Content = [new TextContentBlock { Text = "unexpected" }],
|
||||
};
|
||||
}
|
||||
else if (request.Params!.Name == "TestElicitationUnsupportedType")
|
||||
{
|
||||
await request.Server.ElicitAsync<UnsupportedForm>(
|
||||
message: "Please provide more information.",
|
||||
serializerOptions: ElicitationUnsupportedJsonContext.Default.Options,
|
||||
cancellationToken: CancellationToken.None);
|
||||
|
||||
// Should be unreachable
|
||||
return new CallToolResult
|
||||
{
|
||||
Content = [new TextContentBlock { Text = "unexpected" }],
|
||||
};
|
||||
}
|
||||
else if (request.Params!.Name == "TestElicitationNonObjectGenericType")
|
||||
{
|
||||
// This should throw because T is not an object type with properties (string primitive)
|
||||
await request.Server.ElicitAsync<string>(
|
||||
message: "Any message",
|
||||
serializerOptions: McpJsonUtilities.DefaultOptions,
|
||||
cancellationToken: CancellationToken.None);
|
||||
|
||||
return new CallToolResult
|
||||
{
|
||||
Content = [new TextContentBlock { Text = "unexpected" }],
|
||||
};
|
||||
}
|
||||
else
|
||||
{
|
||||
Assert.Fail($"Unexpected tool name: {request.Params!.Name}");
|
||||
}
|
||||
|
||||
return new CallToolResult
|
||||
{
|
||||
Content = [new TextContentBlock { Text = "success" }],
|
||||
};
|
||||
});
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task Can_Elicit_Typed_Information()
|
||||
{
|
||||
await using IMcpClient client = await CreateMcpClientForServer(new McpClientOptions
|
||||
{
|
||||
Capabilities = new()
|
||||
{
|
||||
Elicitation = new()
|
||||
{
|
||||
ElicitationHandler = async (request, cancellationToken) =>
|
||||
{
|
||||
Assert.NotNull(request);
|
||||
Assert.Equal("Please provide more information.", request.Message);
|
||||
|
||||
Assert.Equal(6, request.RequestedSchema.Properties.Count);
|
||||
|
||||
foreach (var entry in request.RequestedSchema.Properties)
|
||||
{
|
||||
var key = entry.Key;
|
||||
var value = entry.Value;
|
||||
switch (key)
|
||||
{
|
||||
case nameof(SampleForm.Name):
|
||||
var stringSchema = Assert.IsType<ElicitRequestParams.StringSchema>(value);
|
||||
Assert.Equal("string", stringSchema.Type);
|
||||
break;
|
||||
|
||||
case nameof(SampleForm.Age):
|
||||
var intSchema = Assert.IsType<ElicitRequestParams.NumberSchema>(value);
|
||||
Assert.Equal("integer", intSchema.Type);
|
||||
break;
|
||||
|
||||
case nameof(SampleForm.Active):
|
||||
var boolSchema = Assert.IsType<ElicitRequestParams.BooleanSchema>(value);
|
||||
Assert.Equal("boolean", boolSchema.Type);
|
||||
break;
|
||||
|
||||
case nameof(SampleForm.Role):
|
||||
var enumSchema = Assert.IsType<ElicitRequestParams.EnumSchema>(value);
|
||||
Assert.Equal("string", enumSchema.Type);
|
||||
Assert.Equal([nameof(SampleRole.User), nameof(SampleRole.Admin)], enumSchema.Enum);
|
||||
break;
|
||||
|
||||
case nameof(SampleForm.Score):
|
||||
var numSchema = Assert.IsType<ElicitRequestParams.NumberSchema>(value);
|
||||
Assert.Equal("number", numSchema.Type);
|
||||
break;
|
||||
|
||||
case nameof(SampleForm.Created):
|
||||
var dateTimeSchema = Assert.IsType<ElicitRequestParams.StringSchema>(value);
|
||||
Assert.Equal("string", dateTimeSchema.Type);
|
||||
Assert.Equal("date-time", dateTimeSchema.Format);
|
||||
|
||||
break;
|
||||
|
||||
default:
|
||||
Assert.Fail($"Unexpected property in schema: {key}");
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
return new ElicitResult
|
||||
{
|
||||
Action = "accept",
|
||||
Content = new Dictionary<string, JsonElement>
|
||||
{
|
||||
[nameof(SampleForm.Name)] = (JsonElement)JsonSerializer.Deserialize("""
|
||||
"Alice"
|
||||
""", McpJsonUtilities.DefaultOptions.GetTypeInfo(typeof(JsonElement)))!,
|
||||
[nameof(SampleForm.Age)] = (JsonElement)JsonSerializer.Deserialize("""
|
||||
30
|
||||
""", McpJsonUtilities.DefaultOptions.GetTypeInfo(typeof(JsonElement)))!,
|
||||
[nameof(SampleForm.Active)] = (JsonElement)JsonSerializer.Deserialize("""
|
||||
true
|
||||
""", McpJsonUtilities.DefaultOptions.GetTypeInfo(typeof(JsonElement)))!,
|
||||
[nameof(SampleForm.Role)] = (JsonElement)JsonSerializer.Deserialize("""
|
||||
"Admin"
|
||||
""", McpJsonUtilities.DefaultOptions.GetTypeInfo(typeof(JsonElement)))!,
|
||||
[nameof(SampleForm.Score)] = (JsonElement)JsonSerializer.Deserialize("""
|
||||
99.5
|
||||
""", McpJsonUtilities.DefaultOptions.GetTypeInfo(typeof(JsonElement)))!,
|
||||
[nameof(SampleForm.Created)] = (JsonElement)JsonSerializer.Deserialize("""
|
||||
"2023-08-27T03:05:00"
|
||||
""", McpJsonUtilities.DefaultOptions.GetTypeInfo(typeof(JsonElement)))!,
|
||||
},
|
||||
};
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
var result = await client.CallToolAsync("TestElicitationTyped", cancellationToken: TestContext.Current.CancellationToken);
|
||||
|
||||
Assert.Equal("success", (result.Content[0] as TextContentBlock)?.Text);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task Elicit_Typed_Respects_NamingPolicy()
|
||||
{
|
||||
await using IMcpClient client = await CreateMcpClientForServer(new McpClientOptions
|
||||
{
|
||||
Capabilities = new()
|
||||
{
|
||||
Elicitation = new()
|
||||
{
|
||||
ElicitationHandler = async (request, cancellationToken) =>
|
||||
{
|
||||
Assert.NotNull(request);
|
||||
Assert.Equal("Please provide more information.", request.Message);
|
||||
|
||||
// Expect camelCase names based on serializer options
|
||||
Assert.Contains("firstName", request.RequestedSchema.Properties.Keys);
|
||||
Assert.Contains("zipCode", request.RequestedSchema.Properties.Keys);
|
||||
Assert.Contains("isAdmin", request.RequestedSchema.Properties.Keys);
|
||||
|
||||
return new ElicitResult
|
||||
{
|
||||
Action = "accept",
|
||||
Content = new Dictionary<string, JsonElement>
|
||||
{
|
||||
["firstName"] = (JsonElement)JsonSerializer.Deserialize("""
|
||||
"Bob"
|
||||
""", McpJsonUtilities.DefaultOptions.GetTypeInfo(typeof(JsonElement)))!,
|
||||
["zipCode"] = (JsonElement)JsonSerializer.Deserialize("""
|
||||
90210
|
||||
""", McpJsonUtilities.DefaultOptions.GetTypeInfo(typeof(JsonElement)))!,
|
||||
["isAdmin"] = (JsonElement)JsonSerializer.Deserialize("""
|
||||
false
|
||||
""", McpJsonUtilities.DefaultOptions.GetTypeInfo(typeof(JsonElement)))!,
|
||||
},
|
||||
};
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
var result = await client.CallToolAsync("TestElicitationCamelForm", cancellationToken: TestContext.Current.CancellationToken);
|
||||
Assert.Equal("success", (result.Content[0] as TextContentBlock)?.Text);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task Elicit_Typed_With_Unsupported_Property_Type_Throws()
|
||||
{
|
||||
await using IMcpClient client = await CreateMcpClientForServer(new McpClientOptions
|
||||
{
|
||||
Capabilities = new()
|
||||
{
|
||||
Elicitation = new()
|
||||
{
|
||||
// Handler should never be invoked because the exception occurs before the request is sent.
|
||||
ElicitationHandler = async (req, ct) =>
|
||||
{
|
||||
Assert.Fail("Elicitation handler should not be called for unsupported schema test.");
|
||||
return new ElicitResult { Action = "cancel" };
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
var ex = await Assert.ThrowsAsync<McpException>(async() =>
|
||||
await client.CallToolAsync("TestElicitationUnsupportedType", cancellationToken: TestContext.Current.CancellationToken));
|
||||
|
||||
Assert.Contains(typeof(UnsupportedForm.Nested).FullName!, ex.Message);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task Elicit_Typed_With_Nullable_Property_Type_Throws()
|
||||
{
|
||||
await using IMcpClient client = await CreateMcpClientForServer(new McpClientOptions
|
||||
{
|
||||
Capabilities = new()
|
||||
{
|
||||
Elicitation = new()
|
||||
{
|
||||
// Handler should never be invoked because the exception occurs before the request is sent.
|
||||
ElicitationHandler = async (req, ct) =>
|
||||
{
|
||||
Assert.Fail("Elicitation handler should not be called for unsupported schema test.");
|
||||
return new ElicitResult { Action = "cancel" };
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
var ex = await Assert.ThrowsAsync<McpException>(async () =>
|
||||
await client.CallToolAsync("TestElicitationNullablePropertyForm", cancellationToken: TestContext.Current.CancellationToken));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task Elicit_Typed_With_NonObject_Generic_Type_Throws()
|
||||
{
|
||||
await using IMcpClient client = await CreateMcpClientForServer(new McpClientOptions
|
||||
{
|
||||
Capabilities = new()
|
||||
{
|
||||
Elicitation = new()
|
||||
{
|
||||
// Should not be invoked
|
||||
ElicitationHandler = async (req, ct) =>
|
||||
{
|
||||
Assert.Fail("Elicitation handler should not be called for non-object generic type test.");
|
||||
return new ElicitResult { Action = "cancel" };
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
var ex = await Assert.ThrowsAsync<McpException>(async () =>
|
||||
await client.CallToolAsync("TestElicitationNonObjectGenericType", cancellationToken: TestContext.Current.CancellationToken));
|
||||
|
||||
Assert.Contains(typeof(string).FullName!, ex.Message);
|
||||
}
|
||||
|
||||
[JsonConverter(typeof(CustomizableJsonStringEnumConverter<SampleRole>))]
|
||||
|
||||
public enum SampleRole
|
||||
{
|
||||
User,
|
||||
Admin,
|
||||
}
|
||||
|
||||
public sealed class SampleForm
|
||||
{
|
||||
public required string Name { get; set; }
|
||||
public int Age { get; set; }
|
||||
public bool Active { get; set; }
|
||||
public SampleRole Role { get; set; }
|
||||
public double Score { get; set; }
|
||||
|
||||
|
||||
public DateTime Created { get; set; }
|
||||
}
|
||||
|
||||
public sealed class CamelForm
|
||||
{
|
||||
public required string FirstName { get; set; }
|
||||
public int ZipCode { get; set; }
|
||||
public bool IsAdmin { get; set; }
|
||||
}
|
||||
|
||||
public sealed class NullablePropertyForm
|
||||
{
|
||||
public string? FirstName { get; set; }
|
||||
public int ZipCode { get; set; }
|
||||
public bool IsAdmin { get; set; }
|
||||
}
|
||||
|
||||
[JsonSerializable(typeof(SampleForm))]
|
||||
[JsonSerializable(typeof(SampleRole))]
|
||||
[JsonSerializable(typeof(JsonElement))]
|
||||
internal partial class ElicitationTypedDefaultJsonContext : JsonSerializerContext;
|
||||
|
||||
[JsonSourceGenerationOptions(PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase)]
|
||||
[JsonSerializable(typeof(CamelForm))]
|
||||
[JsonSerializable(typeof(JsonElement))]
|
||||
internal partial class ElicitationTypedCamelJsonContext : JsonSerializerContext;
|
||||
|
||||
|
||||
[JsonSourceGenerationOptions(PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase)]
|
||||
[JsonSerializable(typeof(NullablePropertyForm))]
|
||||
[JsonSerializable(typeof(JsonElement))]
|
||||
internal partial class ElicitationNullablePropertyJsonContext : JsonSerializerContext;
|
||||
|
||||
public sealed class UnsupportedForm
|
||||
{
|
||||
public string? Name { get; set; }
|
||||
public Nested? NestedProperty { get; set; } // Triggers unsupported (complex object)
|
||||
public sealed class Nested
|
||||
{
|
||||
public string? Value { get; set; }
|
||||
}
|
||||
}
|
||||
|
||||
[JsonSerializable(typeof(UnsupportedForm))]
|
||||
[JsonSerializable(typeof(UnsupportedForm.Nested))]
|
||||
[JsonSerializable(typeof(JsonElement))]
|
||||
internal partial class ElicitationUnsupportedJsonContext : JsonSerializerContext;
|
||||
}
|
||||
Loading…
Reference in a new issue