Skip to content

ROB-1292 mcp docs#1824

Merged
arikalon1 merged 6 commits intomasterfrom
ROB-1292-mcp-docs
May 27, 2025
Merged

ROB-1292 mcp docs#1824
arikalon1 merged 6 commits intomasterfrom
ROB-1292-mcp-docs

Conversation

@RoiGlinik
Copy link
Copy Markdown
Contributor

@RoiGlinik RoiGlinik commented May 21, 2025

Summary by CodeRabbit

  • Documentation
    • Added a new section on connecting HolmesGPT to remote MCP servers, highlighting that support is in Tech Preview and providing configuration guidance.
    • Introduced a dedicated guide detailing how to configure and connect HolmesGPT with remote MCP servers using Helm values and SSE mode.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 21, 2025

"""

Walkthrough

The documentation was updated to include a new section on configuring remote MCP servers, referencing a dedicated guide. No code or API changes were made.

Changes

File(s) Change Summary
docs/configuration/holmesgpt/index.rst Added a new section "Remote MCP servers" with warning and reference to setup guide.
docs/configuration/holmesgpt/remote_mcp_servers.rst Created a new documentation file detailing configuration of remote MCP servers via Helm, including examples.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Documentation
    participant Helm
    participant HolmesGPT

    User->>Documentation: Reads guide on remote MCP server configuration
    User->>Helm: Updates values.yaml with MCP server config
    User->>Helm: Runs helm upgrade to apply changes
    Helm->>HolmesGPT: Deploys with new MCP server settings
    HolmesGPT->>Remote MCP Servers: Connects via SSE for data/tool access
Loading

"""


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a4b3f6d and 8997f7f.

📒 Files selected for processing (1)
  • docs/configuration/holmesgpt/remote_mcp_servers.rst (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/configuration/holmesgpt/remote_mcp_servers.rst
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: run_tests
  • GitHub Check: run_tests
  • GitHub Check: Deploy docs

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (3)
docs/configuration/holmesgpt/index.rst (1)

375-381: Align link text with guide title.
The link currently reads:

For detailed instructions, refer to the :doc:`Connecting to Remote MCP Servers <remote_mcp_servers>` guide.

To match the actual document title ("Remote MCP Servers") and improve consistency, consider:

- For detailed instructions, refer to the :doc:`Connecting to Remote MCP Servers <remote_mcp_servers>` guide.
+ For detailed instructions, refer to the :doc:`Remote MCP Servers <remote_mcp_servers>` guide.
docs/configuration/holmesgpt/remote_mcp_servers.rst (2)

1-3: Standardize heading capitalization.
Other section titles use lowercase for common nouns (e.g., "Builtin toolsets", "Custom toolsets"), and the index uses "Remote MCP servers". Rename the title to:

Remote MCP servers
==================

to ensure consistency across the docs.


8-9: Fix header punctuation.
Remove the extra space before the colon in the section title:

- Example : MCP server configuration
+ Example: MCP server configuration
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b9cd457 and f8304b1.

📒 Files selected for processing (2)
  • docs/configuration/holmesgpt/index.rst (2 hunks)
  • docs/configuration/holmesgpt/remote_mcp_servers.rst (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: run_tests
🔇 Additional comments (4)
docs/configuration/holmesgpt/index.rst (1)

13-13: Approve toctree addition.
The new remote_mcp_servers entry is properly added to the AI Analysis toctree.

docs/configuration/holmesgpt/remote_mcp_servers.rst (3)

4-7: Approve introduction.
The overview clearly explains the purpose of the guide and the use of SSE mode. It provides sufficient context for readers.


17-32: Approve Helm values example.
The YAML snippet is well-structured, follows the pattern used elsewhere, and clearly demonstrates how to configure multiple MCP servers.


35-38: Approve Helm upgrade instructions.
The bash snippet is clear, uses the correct command, and aligns with other upgrade sections in the documentation.

Comment thread docs/configuration/holmesgpt/remote_mcp_servers.rst
@RoiGlinik RoiGlinik changed the title Rob 1292 mcp docs ROB-1292 mcp docs May 22, 2025
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

♻️ Duplicate comments (1)
docs/configuration/holmesgpt/remote_mcp_servers.rst (1)

16-19: Correct Sphinx directives for tabs
The md-tab-set/md-tab-item syntax is outdated. Use the standard Sphinx directives for consistency with the rest of the docs:

- .. md-tab-set::
+ .. tab-set::

-   .. md-tab-item:: Robusta Helm Chart
+   .. tab-item:: Robusta Helm Chart
🧹 Nitpick comments (3)
docs/configuration/holmesgpt/index.rst (1)

376-377: Unify heading capitalization
The section title here is “Remote MCP servers” (lowercase ‘s’), but in the remote_mcp_servers.rst file it appears as “Remote MCP Servers” (uppercase ‘S’). Consider aligning the casing across both files for consistency.

docs/configuration/holmesgpt/remote_mcp_servers.rst (2)

1-2: Remove trailing whitespace and align title capitalization
The title line has an extra trailing space and uses “Servers” with a capital “S,” which should match the casing used in index.rst. Trim the trailing whitespace and unify the title’s capitalization.


13-14: Correct spacing around colon in heading
Change “Example : MCP server configuration” to “Example: MCP server configuration” (no space before the colon) to adhere to standard punctuation rules.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2fe4a2d and a4b3f6d.

📒 Files selected for processing (2)
  • docs/configuration/holmesgpt/index.rst (2 hunks)
  • docs/configuration/holmesgpt/remote_mcp_servers.rst (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: run_tests
  • GitHub Check: run_tests
  • GitHub Check: Deploy docs
🔇 Additional comments (1)
docs/configuration/holmesgpt/index.rst (1)

13-13: Approve toctree addition of remote_mcp_servers
The new entry remote_mcp_servers is correctly added to the hidden toctree, exposing the new guide without altering existing structure.

@Sheeproid Sheeproid self-requested a review May 27, 2025 13:56
Copy link
Copy Markdown
Contributor

@arikalon1 arikalon1 left a comment

Choose a reason for hiding this comment

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

nice work

@arikalon1 arikalon1 merged commit ea9ed1d into master May 27, 2025
8 checks passed
@arikalon1 arikalon1 deleted the ROB-1292-mcp-docs branch May 27, 2025 21:08
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.

4 participants