Skip to content

ROB-1418 mcp stdio docs + loom#1839

Merged
aantn merged 2 commits into
masterfrom
ROB-1418-mcp-stdio-docs
Jun 5, 2025
Merged

ROB-1418 mcp stdio docs + loom#1839
aantn merged 2 commits into
masterfrom
ROB-1418-mcp-stdio-docs

Conversation

@RoiGlinik
Copy link
Copy Markdown
Contributor

@RoiGlinik RoiGlinik commented Jun 5, 2025

Summary by CodeRabbit

  • Documentation
    • Added a detailed example section on integrating stdio-based MCP servers with HolmesGPT using Supergateway.
    • Included step-by-step instructions for setup in Docker and Kubernetes environments.
    • Provided configuration examples for HolmesGPT via CLI and Helm chart.
    • Added a live demo link with an embedded video for practical guidance.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 5, 2025

Walkthrough

The documentation for configuring remote MCP servers with HolmesGPT has been expanded with a new example section. This addition details how to use stdio-based MCP servers by converting them to SSE-compatible endpoints using Supergateway, including setup instructions for Docker and Kubernetes, and updated HolmesGPT configuration steps.

Changes

File(s) Change Summary
docs/configuration/holmesgpt/remote_mcp_servers.rst Added a comprehensive example section for using stdio MCP servers with Supergateway and HolmesGPT.

Possibly related PRs

  • ROB-1292 mcp docs #1824: Both PRs update HolmesGPT documentation for remote MCP servers, with this PR adding detailed stdio-to-SSE conversion guidance and the related PR introducing initial configuration instructions.

Suggested reviewers

  • Sheeproid
  • RamanKharchee
  • arikalon1

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.

❤️ Share
🪧 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.

@RoiGlinik RoiGlinik requested review from aantn and pavangudiwada June 5, 2025 12:57
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 (7)
docs/configuration/holmesgpt/remote_mcp_servers.rst (7)

45-52: Fix heading punctuation and underline length
Remove the extra space before the colon in the section title and adjust the underline to match the new title length exactly for consistency with RST heading rules.

-Example : Working with Stdio MCP servers
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Example: Working with stdio MCP servers
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

53-56: Improve list grammar and formatting
Add a comma and colon after the introductory phrase, then indent the bullet items consistently and remove trailing punctuation on links.

-For this demo we will use
-  * `Dynatrace MCP <https://github.com/dynatrace-oss/dynatrace-mcp>`_ .
-  * `Supergateway <https://github.com/supercorp-ai/supergateway>`_ - runs MCP stdio-based servers over SSE.
+For this demo, we will use:
+
+   * `Dynatrace MCP <https://github.com/dynatrace-oss/dynatrace-mcp>`_
+   * `Supergateway <https://github.com/supercorp-ai/supergateway>`_ – runs MCP stdio-based servers over SSE

57-58: Correct spelling and tone in the callout
Fix the misspelling of “Supergateway,” add the definite article, and improve phrasing.

-Check out supergatway docs to find out other useful flags.
+Check out the Supergateway docs to discover additional useful flags.

59-68: Consider replacing raw HTML with RST directives
Embedding raw HTML can hinder theming and responsiveness. You can use Sphinx’s image/link directives instead:

**See it in action**

.. image:: https://cdn.loom.com/sessions/thumbnails/1b290511b79942c7b1d672a2a4cde105-ed4eed3f9d70b125-full-play.gif
   :target: https://www.loom.com/share/1b290511b79942c7b1d672a2a4cde105
   :alt: Live demo of Supergateway wrapping Dynatrace MCP

69-85: Capitalize and format the Docker instructions
Ensure sentences start with a capital letter and use inline code formatting for commands in prose. Also verify the code-block indentation aligns under the directive.

-    you can change `"npx -y @dynatrace-oss/dynatrace-mcp-server@latest /"` to your specific MCP.
+    You can change ``npx -y @dynatrace-oss/dynatrace-mcp-server@latest /`` to your specific MCP.

106-107: Remove pipe characters and use proper RST formatting
The leading | will render literally. Replace with standard paragraph text or an admonition.

-    | This will run dynatrace MCP server as a pod in your cluster.
-    | credentials are passed as env vars.
+    This will run the Dynatrace MCP server as a pod in your cluster.
+    Credentials are passed as environment variables.

157-158: Capitalize product name in the step header
Update “holmes” to “Holmes” and consider rephrasing for clarity.

-2. Add MCP server to holmes config.
+2. Add MCP server to Holmes 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 f632bc0 and 19425ca.

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

173-178: Holmes CLI config example looks good
The YAML snippet correctly demonstrates how to add an SSE endpoint under mcp_servers.

Comment thread docs/configuration/holmesgpt/remote_mcp_servers.rst
@aantn aantn enabled auto-merge (squash) June 5, 2025 14:15
@aantn aantn merged commit 37612b2 into master Jun 5, 2025
9 of 10 checks passed
@aantn aantn deleted the ROB-1418-mcp-stdio-docs branch June 5, 2025 14:31
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.

2 participants