Improve bit BlazorUI mcp (#12439)#12440
Merged
Merged
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
WalkthroughAdds DTOs and three server controllers (icons, enums, components) that use reflection and merged XML docs, exposes MainLayout.NavItems publicly, registers HtmlRenderer and a RenderForMcpClient cascading flag, updates demo components to render compact markup for MCP clients, and updates MCP prompts/config. ChangesComponent Metadata & Navigation Exposure
Sequence Diagram(s)sequenceDiagram
participant Client
participant ComponentsController
participant MainLayout
participant XmlDocLoader
Client->>ComponentsController: GetBitBlazorUIComponentsList()
ComponentsController->>MainLayout: Read NavItems
MainLayout-->>ComponentsController: NavItem list
ComponentsController->>XmlDocLoader: LoadSummariesXmlDocumentAsync()
XmlDocLoader-->>ComponentsController: merged XDocument
ComponentsController-->>Client: ComponentListDetailsDto[]
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes Poem
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the Bit.BlazorUI MCP experience by wiring a dedicated Bit.BlazorUI MCP server into the Boilerplate template and by adding/adjusting MCP tool endpoints in the BlazorUI Demo server to enable component discovery and API inspection.
Changes:
- Added a new
bitBlazorUIMCP server entry to the Boilerplate template and updated agent/prompt guidance to use new MCP tools for component discovery and parameter lookup. - Exposed the Demo navigation catalog as
MainLayout.NavItemsand introduced a new MCP tool endpoint to return a component catalog derived from those nav items. - Added new MCP tool endpoints for enum details and Bit icon names; renamed the existing component-parameters MCP tool to
GetComponentParameters.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| src/Templates/Boilerplate/Bit.Boilerplate/AGENTS.md | Updates agent instructions to reference new Bit.BlazorUI MCP tools for discovery and API details. |
| src/Templates/Boilerplate/Bit.Boilerplate/.vscode/mcp.json | Adds the bitBlazorUI MCP server URL to the template’s MCP configuration. |
| src/Templates/Boilerplate/Bit.Boilerplate/.github/prompts/bitify.prompt.md | Rewrites the “Bitify” agent prompt to explicitly use MCP tools and fetched demo examples instead of guessing APIs. |
| src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Shared/MainLayout.razor.NavItems.cs | Exposes nav items as a static list for reuse by server-side MCP endpoints. |
| src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Shared/MainLayout.razor | Switches nav panel binding to the new NavItems static. |
| src/BlazorUI/Demo/Bit.BlazorUI.Demo.Shared/Dtos/EnumValueDetailsDto.cs | Adds a DTO for enum value details returned by MCP tools. |
| src/BlazorUI/Demo/Bit.BlazorUI.Demo.Shared/Dtos/ComponentListDetailsDto.cs | Adds a DTO for the component catalog returned by MCP tools. |
| src/BlazorUI/Demo/Bit.BlazorUI.Demo.Server/Controllers/ComponentsController.cs | Adds an MCP tool endpoint to list Bit.BlazorUI components (name/url/aliases/summary). |
| src/BlazorUI/Demo/Bit.BlazorUI.Demo.Server/Controllers/ComponentEnumsController.cs | Adds an MCP tool endpoint to return enum value names and XML-doc summaries. |
| src/BlazorUI/Demo/Bit.BlazorUI.Demo.Server/Controllers/ComponentDetailsController.cs | Renames the MCP tool/method from GetParameters to GetComponentParameters. |
| src/BlazorUI/Demo/Bit.BlazorUI.Demo.Server/Controllers/BitIconNamesController.cs | Adds an MCP tool endpoint to list available BitIconName constants. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
src/BlazorUI/Demo/Bit.BlazorUI.Demo.Server/Controllers/ComponentEnumsController.cs (1)
25-28: ⚡ Quick winPrefer an empty array over
nullfor “no enum values” responses.Returning
nullhere forces extra client null-branching;[]keeps the contract predictable and aligns better with list-style MCP endpoints.Suggested refactor
-public async Task<EnumValueDetailsDto[]?> GetEnumDetails(string enumName) +public async Task<EnumValueDetailsDto[]> GetEnumDetails(string enumName) { if (string.IsNullOrWhiteSpace(enumName)) - return null; + return []; @@ if (enumType is null) - return null; + return [];Also applies to: 35-37
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@src/BlazorUI/Demo/Bit.BlazorUI.Demo.Server/Controllers/ComponentEnumsController.cs` around lines 25 - 28, In GetEnumDetails change the early return for an empty or whitespace enumName to return an empty EnumValueDetailsDto[] instead of null so the method always returns an array; update the same pattern in the related branch around the Enum lookup (the other return-null at lines 35-37) so both the GetEnumDetails method and its enum-not-found branch consistently return an empty EnumValueDetailsDto[] rather than null, keeping the response contract as a list.src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Shared/MainLayout.razor.NavItems.cs (1)
6-185: ⚡ Quick winKeep
NavItemsread-only.This exposes process-wide mutable state. Any caller can add/remove items and silently change the navigation tree for every request.
♻️ Suggested change
-public static readonly List<BitNavItem> NavItems = +public static IReadOnlyList<BitNavItem> NavItems =🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Shared/MainLayout.razor.NavItems.cs` around lines 6 - 185, NavItems is a public static mutable List exposing process-wide state; change its declaration to a read-only collection (e.g., static readonly IReadOnlyList<BitNavItem> NavItems) and initialize it with an immutable/read-only instance (for example build the List<BitNavItem> and assign NavItems = list.AsReadOnly() or use System.Collections.Immutable.ImmutableList.CreateRange(list)); also ensure nested mutable collections on BitNavItem (e.g., ChildItems, AdditionalUrls) are created as immutable/read-only collections so callers cannot mutate the tree after initialization.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@src/BlazorUI/Demo/Bit.BlazorUI.Demo.Server/Controllers/ComponentEnumsController.cs`:
- Around line 62-66: GetEnumDetails currently assumes the XML docs exist and
contain a <members> node; guard the File.OpenRead call by checking
File.Exists(path) (or catch FileNotFoundException) and return a safe response
(e.g., NotFound or empty details) if missing, and after loading XDocument (doc)
verify doc.Root is not null and locate the <members> element before calling
Elements/Descendants; if <members> is absent, handle gracefully (return empty
enum docs) instead of dereferencing a null node. Ensure you update the code
around the variables path, stream, doc and the members lookup in GetEnumDetails
to perform these null/exists checks.
In `@src/Templates/Boilerplate/Bit.Boilerplate/.github/prompts/bitify.prompt.md`:
- Around line 40-42: Add explicit language tags to the plain fenced code blocks
in the prompt so markdownlint's fenced-code-language rule passes: locate the two
examples containing the raw URL
"https://blazorui-ai.bitplatform.dev/components/{component-name-lowercase}" and
the DeepWiki_ask_question snippet and change their opening fences from ``` to
```text (apply the same change for both blocks referenced in the diff and also
the similar block at lines 55-60).
---
Nitpick comments:
In
`@src/BlazorUI/Demo/Bit.BlazorUI.Demo.Server/Controllers/ComponentEnumsController.cs`:
- Around line 25-28: In GetEnumDetails change the early return for an empty or
whitespace enumName to return an empty EnumValueDetailsDto[] instead of null so
the method always returns an array; update the same pattern in the related
branch around the Enum lookup (the other return-null at lines 35-37) so both the
GetEnumDetails method and its enum-not-found branch consistently return an empty
EnumValueDetailsDto[] rather than null, keeping the response contract as a list.
In
`@src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Shared/MainLayout.razor.NavItems.cs`:
- Around line 6-185: NavItems is a public static mutable List exposing
process-wide state; change its declaration to a read-only collection (e.g.,
static readonly IReadOnlyList<BitNavItem> NavItems) and initialize it with an
immutable/read-only instance (for example build the List<BitNavItem> and assign
NavItems = list.AsReadOnly() or use
System.Collections.Immutable.ImmutableList.CreateRange(list)); also ensure
nested mutable collections on BitNavItem (e.g., ChildItems, AdditionalUrls) are
created as immutable/read-only collections so callers cannot mutate the tree
after initialization.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 67668f8a-719c-47f8-a60d-e7c0f72b2144
📒 Files selected for processing (11)
src/BlazorUI/Demo/Bit.BlazorUI.Demo.Server/Controllers/BitIconNamesController.cssrc/BlazorUI/Demo/Bit.BlazorUI.Demo.Server/Controllers/ComponentDetailsController.cssrc/BlazorUI/Demo/Bit.BlazorUI.Demo.Server/Controllers/ComponentEnumsController.cssrc/BlazorUI/Demo/Bit.BlazorUI.Demo.Server/Controllers/ComponentsController.cssrc/BlazorUI/Demo/Bit.BlazorUI.Demo.Shared/Dtos/ComponentListDetailsDto.cssrc/BlazorUI/Demo/Bit.BlazorUI.Demo.Shared/Dtos/EnumValueDetailsDto.cssrc/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Shared/MainLayout.razorsrc/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Shared/MainLayout.razor.NavItems.cssrc/Templates/Boilerplate/Bit.Boilerplate/.github/prompts/bitify.prompt.mdsrc/Templates/Boilerplate/Bit.Boilerplate/.vscode/mcp.jsonsrc/Templates/Boilerplate/Bit.Boilerplate/AGENTS.md
Member
Author
|
@coderabbitai review again! |
|
✅ Action performedReview finished.
|
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@src/BlazorUI/Demo/Bit.BlazorUI.Demo.Server/Controllers/ComponentDetailsController.cs`:
- Around line 86-88: The lookup for demoPageType currently matches t.Name
exactly, causing case-sensitive failures; update the SingleOrDefault predicate
to compare t.Name to $"{componentName}Demo" using a case-insensitive comparison
(e.g. StringComparison.OrdinalIgnoreCase) so it behaves the same as
GetComponentParameters and accepts componentName case-insensitively.
In `@src/BlazorUI/Demo/Bit.BlazorUI.Demo.Server/Startup/Services.cs`:
- Around line 55-59: The current AddCascadingValue that sets
AppComponentBase.RenderForMcpClient also checks the "showallcodes" query and
therefore incorrectly aliases the legacy showallcodes flag to
RenderForMcpClient; change the lambda used by
services.AddCascadingValue(nameof(AppComponentBase.RenderForMcpClient), ...) so
it returns only the HttpContext.Items-based flag (check
nameof(AppComponentBase.RenderForMcpClient) in HttpContext.Items) and remove the
Query.ContainsKey("showallcodes") portion, and then add a separate cascading
value (e.g., services.AddCascadingValue("ShowAllCodes", sp =>
sp.GetRequiredService<IHttpContextAccessor>().HttpContext?.Request?.Query?.ContainsKey("showallcodes")
is true)) so the legacy showallcodes remains a distinct UI-only flag.
In
`@src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Components/DemoExample.razor`:
- Around line 3-6: The MCP branch currently outputs raw HTML by casting to
MarkupString in the RenderForMcpClient block; remove the MarkupString cast and
stop injecting RazorCode and CsharpCode as raw markup. Instead render Title,
RazorCode and CsharpCode as plain/encoded text (for example show them inside a
pre/code block or output them normally so Blazor HTML-encodes them) in the
RenderForMcpClient branch (update the conditional that checks RenderForMcpClient
in DemoExample.razor and stop using MarkupString for RazorCode/CsharpCode).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 7e7f6a4d-f733-4443-b596-a7d298efd5a7
📒 Files selected for processing (20)
src/BlazorUI/Demo/Bit.BlazorUI.Demo.Server/Controllers/ComponentDetailsController.cssrc/BlazorUI/Demo/Bit.BlazorUI.Demo.Server/Controllers/ComponentsController.cssrc/BlazorUI/Demo/Bit.BlazorUI.Demo.Server/Startup/Services.cssrc/BlazorUI/Demo/Bit.BlazorUI.Demo.Shared/Dtos/ComponentListDetailsDto.cssrc/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Components/AppComponentBase.cssrc/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Components/DemoExample.razorsrc/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Components/DemoExample.razor.cssrc/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Components/DemoPage.razorsrc/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Components/DemoPage.razor.cssrc/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Buttons/ButtonGroup/BitButtonGroupDemo.razorsrc/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Buttons/MenuButton/BitMenuButtonDemo.razorsrc/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Extras/AccordionList/BitAccordionListDemo.razorsrc/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Inputs/ChoiceGroup/BitChoiceGroupDemo.razorsrc/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Inputs/Dropdown/BitDropdownDemo.razorsrc/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Lists/Timeline/BitTimelineDemo.razorsrc/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Navs/Breadcrumb/BitBreadcrumbDemo.razorsrc/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Navs/Nav/BitNavDemo.razorsrc/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Navs/NavBar/BitNavBarDemo.razorsrc/Templates/Boilerplate/Bit.Boilerplate/.github/prompts/bitify.prompt.mdsrc/Templates/Boilerplate/Bit.Boilerplate/AGENTS.md
💤 Files with no reviewable changes (3)
- src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Components/DemoPage.razor.cs
- src/BlazorUI/Demo/Bit.BlazorUI.Demo.Shared/Dtos/ComponentListDetailsDto.cs
- src/BlazorUI/Demo/Bit.BlazorUI.Demo.Server/Controllers/ComponentsController.cs
✅ Files skipped from review due to trivial changes (2)
- src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Buttons/MenuButton/BitMenuButtonDemo.razor
- src/Templates/Boilerplate/Bit.Boilerplate/AGENTS.md
🚧 Files skipped from review as they are similar to previous changes (1)
- src/Templates/Boilerplate/Bit.Boilerplate/.github/prompts/bitify.prompt.md
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
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.
closes #12439
Summary by CodeRabbit
New Features
Chores