Add deepwiki mcp tool to bit Boilerplate (#11026)#11027
Add deepwiki mcp tool to bit Boilerplate (#11026)#11027yasmoradi merged 12 commits intobitfoundation:developfrom yasmoradi:deepwiki-mcp-tool
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughA new configuration file for the DeepWiki MCP tool was added to the Bit Boilerplate template, along with documentation updates describing its usage. Package versions for several dependencies were incremented, and minor documentation structure changes were made in related markdown files. Changes
Assessment against linked issues
Poem
✨ Finishing Touches🧪 Generate Unit Tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Pull Request Overview
This PR adds the DeepWiki MCP tool to the Bit Boilerplate by updating configuration files and documentation to integrate DeepWiki support.
- Added a new "copilot-instructions.md" heading reference in the WikiDocs README.
- Updated package versions for libphonenumber-csharp and Sentry packages.
- Added a new MCP configuration file for DeepWiki and revised copilot instructions with DeepWiki usage guidelines.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/Websites/WikiDocs/README.md | Added a heading for copilot instructions. |
| src/Templates/Boilerplate/Bit.Boilerplate/src/Directory.Packages.props | Updated dependency versions for libphonenumber-csharp and Sentry packages. |
| src/Templates/Boilerplate/Bit.Boilerplate/.vscode/mcp.json | Introduced a new MCP configuration file for DeepWiki. |
| src/Templates/Boilerplate/Bit.Boilerplate/.github/copilot-instructions.md | Revised documentation layout and added DeepWiki tool usage guidelines. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
src/Templates/Boilerplate/Bit.Boilerplate/.github/copilot-instructions.md (3)
3-3: Fix markdown heading level increment.The heading level jumps from H1 to H3, which violates markdown best practices. Consider using H2 (##) instead or adding an intermediate H2 heading.
-### Architecture & Project Structure +## Architecture & Project Structure
67-67: Fix markdown heading level increment.Similar to the previous heading, this jumps to H3 without an intermediate H2.
-### Best Practices +## Best Practices
87-88: Standardize list bullet style.The markdown uses asterisks (*) for list items while the rest of the document uses dashes (-). Maintain consistency throughout the document.
-* **User Prompt:** "How do I make a BitButton disabled?" -* **Your Action:** First, run `deepwiki fetch bitfoundation/bitplatform to search for How do I make a BitButton disabled?`. Then, use the documentation to answer the user. +- **User Prompt:** "How do I make a BitButton disabled?" +- **Your Action:** First, run `deepwiki fetch bitfoundation/bitplatform to search for How do I make a BitButton disabled?`. Then, use the documentation to answer the user.src/Websites/WikiDocs/README.md (1)
42-44: Consider adding descriptive content under the new section.While the section header addition is appropriate, consider adding a brief description of what the copilot-instructions.md contains and how it relates to the wiki's documentation scope.
## copilot-instructions.md + +Developer guidance and instructions for using AI tools like GitHub Copilot with the BitPlatform ecosystem, including specialized tool usage for documentation queries.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Knowledge Base: Disabled due to Reviews > Disable Knowledge Base setting
📒 Files selected for processing (4)
src/Templates/Boilerplate/Bit.Boilerplate/.github/copilot-instructions.md(2 hunks)src/Templates/Boilerplate/Bit.Boilerplate/.vscode/mcp.json(1 hunks)src/Templates/Boilerplate/Bit.Boilerplate/src/Directory.Packages.props(2 hunks)src/Websites/WikiDocs/README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
src/Templates/Boilerplate/Bit.Boilerplate/.github/copilot-instructions.md
3-3: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
87-87: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
88-88: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build and test
🔇 Additional comments (4)
src/Templates/Boilerplate/Bit.Boilerplate/src/Directory.Packages.props (2)
16-16: Verify the libphonenumber-csharp package version exists.Ensure that version 9.0.8 of the libphonenumber-csharp package is available and check for any associated security advisories.
#!/bin/bash # Description: Verify libphonenumber-csharp version 9.0.8 exists and check for security advisories # Check NuGet for the specific version curl -s "https://api.nuget.org/v3-flatcontainer/libphonenumber-csharp/index.json" | jq '.versions[] | select(. == "9.0.8")' # Check for latest version curl -s "https://api.nuget.org/v3-flatcontainer/libphonenumber-csharp/index.json" | jq '.versions[-1]'
43-45: ```shell
#!/usr/bin/env bashAttempt decompression to properly parse vulnerabilities
for pkg in "sentry.aspnetcore" "sentry.extensions.logging" "sentry.maui"; do
echo "Checking vulnerabilities for $pkg@5.11.2"
curl --compressed -s "https://api.nuget.org/v3/registration5-gz-semver2/$pkg/index.json" |
jq '.items[]
| .items[]
| select(.catalogEntry.version=="5.11.2")
| .catalogEntry.vulnerabilities // []'
echo "---"
done</details> <details> <summary>src/Templates/Boilerplate/Bit.Boilerplate/.vscode/mcp.json (1)</summary> `1-8`: **LGTM! Valid MCP configuration.** The JSON configuration is syntactically correct and properly defines the DeepWiki MCP server with SSE (Server-Sent Events) transport. The structure aligns with MCP protocol specifications. </details> <details> <summary>src/Templates/Boilerplate/Bit.Boilerplate/.github/copilot-instructions.md (1)</summary> `77-88`: **LGTM! Comprehensive DeepWiki tool usage instructions.** The new section provides clear, actionable instructions for using the DeepWiki tool, including mandatory usage rules, command syntax, and practical examples. This will help ensure consistent usage of the BitPlatform documentation tool. </details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
closes #11026
Summary by CodeRabbit
Documentation
Chores
Bug Fixes