Implement IOptionsFormatter on McpOptions for improved serviceability #111
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: mathewc <[email protected]>
Copilot
AI
changed the title
Copilot finished work on behalf of
mathewc
September 30, 2025 18:00
Copilot finished work on behalf of
mathewc
September 30, 2025 18:21
Copilot finished work on behalf of
mathewc
September 30, 2025 18:23
|
@copilot Please address the PR comments I've made up to this point |
Copilot finished work on behalf of
mathewc
September 30, 2025 18:46
mathewc
requested changes
Sep 30, 2025
|
@copilot act on the feedback provided. |
mathewc
reviewed
Sep 30, 2025
| [EditorBrowsable(EditorBrowsableState.Never)] | ||
| string IOptionsFormatter.Format() | ||
| { | ||
| JObject options = new JObject |
There was a problem hiding this comment.
Use System.Text.Json rather than Newtonsoft
| { | ||
| { nameof(ServerName), ServerName }, | ||
| { nameof(ServerVersion), ServerVersion }, | ||
| { nameof(Instructions), Instructions }, |
There was a problem hiding this comment.
Let's omit Instructions, since this may contain customer sensitive info
|
|
||
| Assert.NotNull(formatted); | ||
|
|
||
| var json = JObject.Parse(formatted); |
There was a problem hiding this comment.
Also do an assertion on the number of properties to make the test stronger
|
|
||
| var json = JObject.Parse(formatted); | ||
|
|
||
| Assert.Contains(nameof(options.ServerName), json.Properties().Select(p => p.Name)); |
There was a problem hiding this comment.
Same here - do an assertion on the number of properties logged
mathewc
requested changes
Sep 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR implements the
IOptionsFormatterinterface on theMcpOptionsclass, following the pattern established by other Azure WebJobs SDK extensions (e.g., HttpOptions) to improve serviceability and diagnostics.Changes
McpOptions.cs
IOptionsFormatterinterfaceFormat()method that returns a formatted JSON string containing configuration valuesServerNameServerVersionInstructionsEncryptClientStateMessageOptions.UseAbsoluteUriForEndpointTesting
McpOptionsTests.csto verify the Format() implementationFormat_ReturnsExpectedJson()validates correct JSON output with custom valuesFormat_IncludesAllNonSensitiveProperties()ensures all expected properties are presentBenefits
This implementation allows the Azure Functions runtime to log configuration values for diagnostic purposes, making it easier to troubleshoot configuration-related issues in production environments. The formatted output follows the same pattern as other extensions, providing a consistent experience across the WebJobs SDK ecosystem.
Fixes #<issue_number>
Original prompt
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.