[dev-v5] Add version compatibility tools and documentation updates#4527
Conversation
…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.
There was a problem hiding this comment.
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
GetVersionInfoandCheckProjectVersiontools to automate version compatibility checking - Introduced the
add_package_referenceprompt 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.
examples/Demo/FluentUI.Demo.Client/Documentation/GetStarted/Mcp/GetStarted.md
Outdated
Show resolved
Hide resolved
examples/Demo/FluentUI.Demo.Client/Documentation/GetStarted/Mcp/GetStarted.md
Show resolved
Hide resolved
examples/Demo/FluentUI.Demo.Client/Documentation/GetStarted/Mcp/Prompts.md
Outdated
Show resolved
Hide resolved
|
@dvoituron this is good now :-) |
vnbaaij
left a comment
There was a problem hiding this comment.
I tagged all 5.xalpha occurences. Now that we have the rc1 version number, we should use that consitently
examples/Demo/FluentUI.Demo.Client/Documentation/GetStarted/Mcp/GetStarted.md
Outdated
Show resolved
Hide resolved
examples/Demo/FluentUI.Demo.Client/Documentation/GetStarted/Mcp/VersionCompatibility.md
Outdated
Show resolved
Hide resolved
examples/Demo/FluentUI.Demo.Client/Documentation/GetStarted/Mcp/VersionCompatibility.md
Outdated
Show resolved
Hide resolved
examples/Demo/FluentUI.Demo.Client/Documentation/GetStarted/Mcp/VersionCompatibility.md
Outdated
Show resolved
Hide resolved
examples/Demo/FluentUI.Demo.Client/Documentation/GetStarted/Mcp/VersionCompatibility.md
Outdated
Show resolved
Hide resolved
|
@vnbaaij I fixed your suggestions 👍 |
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
Version Compatibilitydocumentation 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.csprojexamples, tool usage, and upgrade instructions.GetStarted,Installation,Prompts,Tools) to reference version compatibility, the new tools, and the importance of matching versions. [1] [2] [3] [4] [5]2. New Built-in Prompt for Package Reference Management
add_package_referenceprompt inAddPackageReferencePrompts.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.3. Automated Version Checking Tools
GetVersionInfoandCheckProjectVersiontools, 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]4. Documentation and Tooling Consistency
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
Component-specific
⏭ Next Steps