Skip to content

[dev-v5] Add version compatibility tools and documentation updates#4527

Merged
dvoituron merged 11 commits intomicrosoft:dev-v5from
AClerbois:users/aclerbois/dev-v5/add-version-tool
Feb 20, 2026
Merged

[dev-v5] Add version compatibility tools and documentation updates#4527
dvoituron merged 11 commits intomicrosoft:dev-v5from
AClerbois:users/aclerbois/dev-v5/add-version-tool

Conversation

@AClerbois
Copy link
Copy Markdown
Collaborator

Pull Request

📖 Description

This pull request introduces comprehensive improvements to version compatibility guidance and automation for Fluent UI Blazor MCP users. It adds a new built-in prompt and documentation for ensuring that projects reference the correct NuGet package versions, describes new version-checking tools, and updates documentation to make version matching and upgrade workflows clear and actionable.

Key changes:

1. Version Compatibility Guidance and Documentation

  • Added a new Version Compatibility documentation page explaining why MCP server and NuGet package versions must match, how to check compatibility, and best practices for keeping versions in sync. Includes CLI and .csproj examples, tool usage, and upgrade instructions.
  • Updated all relevant documentation pages (GetStarted, Installation, Prompts, Tools) to reference version compatibility, the new tools, and the importance of matching versions. [1] [2] [3] [4] [5]
  • Added cross-links to the new version compatibility page throughout the docs for discoverability. [1] [2] [3] [4] [5]

2. New Built-in Prompt for Package Reference Management

  • Implemented the add_package_reference prompt in AddPackageReferencePrompts.cs, which generates step-by-step instructions for adding the correct Fluent UI Blazor NuGet packages (including Icons and Emoji) to a project, always matching the MCP server version.
  • Documented this prompt and its parameters in the prompts documentation, making it easy for users and AI assistants to invoke. [1] [2]

3. Automated Version Checking Tools

  • Described and documented the GetVersionInfo and CheckProjectVersion tools, which allow the AI assistant (or user) to verify that the project’s component library version matches the MCP server, and to guide upgrades if needed. [1] [2] [3]
  • Added workflow examples and best practices for using these tools in both user and AI assistant contexts. [1] [2]

4. Documentation and Tooling Consistency

  • Updated the MCP server README to include the new tools, their purpose, and recommended agent workflows for version validation and upgrade guidance. [1] [2]

These changes significantly improve the user experience by making it easier to keep documentation and code in sync, reducing confusion and support issues caused by version mismatches.

👩‍💻 Reviewer Notes

✅ Checklist

General

  • I have added tests for my changes.
  • I have tested my changes.
  • I have updated the project documentation to reflect my changes.
  • I have read the CONTRIBUTING documentation and followed the standards for this project.

Component-specific

  • I have added a new MCP component prompt and tools
  • I have added Unit Tests for my new component
  • I have modified existing documentations
  • I have validated the Unit Tests for an existing component

⏭ Next Steps

…r MCP server

- Introduced `GetVersionInfo` and `CheckProjectVersion` tools to ensure version compatibility between MCP server and Fluent UI Blazor components.
- Added detailed documentation on version compatibility, including usage examples and best practices.
- Enhanced prompts for adding package references to include version checks and installation instructions.
- Created tests for new tools and prompts to ensure functionality and accuracy.
Copilot AI review requested due to automatic review settings February 16, 2026 19:52
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds comprehensive version compatibility tooling and documentation to help users ensure their Fluent UI Blazor projects reference the correct NuGet package versions that match the MCP server. This is critical because the MCP server provides documentation for a specific version of the component library, and version mismatches can lead to inaccurate documentation, compilation errors, and runtime issues.

Changes:

  • Added GetVersionInfo and CheckProjectVersion tools to automate version compatibility checking
  • Introduced the add_package_reference prompt to guide users through adding NuGet packages with correct versions
  • Created a comprehensive "Version Compatibility" documentation page explaining why version matching matters and how to use the new tools
  • Updated all relevant documentation pages (GetStarted, Installation, Prompts, Tools, README) with cross-references to version compatibility guidance

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
src/Tools/McpServer/Tools/VersionTools.cs New tool class providing version information retrieval and compatibility checking
tests/Tools/McpServer.Tests/Tools/VersionToolsTests.cs Comprehensive unit tests for VersionTools covering happy paths and edge cases
src/Tools/McpServer/Prompts/AddPackageReferencePrompts.cs New prompt for guiding users through package installation with correct versions
tests/Tools/McpServer.Tests/Prompts/AddPackageReferencePromptsTests.cs Unit tests verifying the add_package_reference prompt behavior
examples/Demo/FluentUI.Demo.Client/Documentation/GetStarted/Mcp/VersionCompatibility.md New documentation page explaining version compatibility requirements and workflow
examples/Demo/FluentUI.Demo.Client/Documentation/GetStarted/Mcp/GetStarted.md Added Step 5 for package installation and cross-reference to version compatibility
examples/Demo/FluentUI.Demo.Client/Documentation/GetStarted/Mcp/Installation.md Added link to version compatibility in Next Steps section
examples/Demo/FluentUI.Demo.Client/Documentation/GetStarted/Mcp/Prompts.md Documented the add_package_reference prompt with parameters and usage
examples/Demo/FluentUI.Demo.Client/Documentation/GetStarted/Mcp/Tools.md Added documentation for GetVersionInfo and CheckProjectVersion tools with examples
src/Tools/McpServer/README.md Added Version Compatibility section with workflow examples and tool descriptions

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@AClerbois AClerbois requested a review from dvoituron February 16, 2026 21:13
@AClerbois
Copy link
Copy Markdown
Collaborator Author

@dvoituron this is good now :-)

@vnbaaij vnbaaij added this to the v5.0-RC2 milestone Feb 18, 2026
Copy link
Copy Markdown
Collaborator

@vnbaaij vnbaaij left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tagged all 5.xalpha occurences. Now that we have the rc1 version number, we should use that consitently

@AClerbois
Copy link
Copy Markdown
Collaborator Author

@vnbaaij I fixed your suggestions 👍

@AClerbois AClerbois requested a review from vnbaaij February 19, 2026 09:47
@dvoituron dvoituron merged commit 2dbcc5d into microsoft:dev-v5 Feb 20, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants