Add Model Context Protocol integration documentation. #36799
Conversation
home-assistant
bot
added
has-parent
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request introduces a new integration for the Model Context Protocol (MCP) in Home Assistant. This integration enables interaction between Home Assistant and MCP servers, focusing on enhancing conversation agent functionality through the Assist API. The documentation covers the protocol's purpose, configuration options, server connection methods, and architectural overview of how Home Assistant clients interact with MCP servers. Changes
Sequence DiagramsequenceDiagram
participant HA as Home Assistant
participant MCP as MCP Server
participant SSE as SSE Proxy
HA->>MCP: Connect to MCP Server
MCP-->>HA: Establish Connection
HA->>SSE: Poll SSE Endpoint
SSE-->>HA: Retrieve Available Tools
HA->>MCP: Request Conversation Actions
MCP-->>HA: Return Conversation Context
This sequence diagram illustrates the high-level interaction between Home Assistant, the MCP Server, and the optional SSE Proxy, demonstrating the connection and tool retrieval process for the new MCP integration. Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 (
|
![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 (6)
source/_integrations/mcp.markdown (6)
49-49: Remove trailing space.There is a trailing space at the end of line 49.
-(for example [Anthropic](/integrations/anthropic/), [Google Generative AI](/integrations/google_generative_ai_conversation), [Ollama](/integrations/ollama/), [Open AI](/integrations/openai_conversation/)). +(for example [Anthropic](/integrations/anthropic/), [Google Generative AI](/integrations/google_generative_ai_conversation), [Ollama](/integrations/ollama/), [Open AI](/integrations/openai_conversation/)).🧰 Tools
🪛 Markdownlint (0.37.0)
49-49: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
41-44: Consider providing more specific URL examples.The current example
http://example/ssecould be enhanced with more realistic examples to help users understand the expected format.- description: The URL for the SSE endpoint of the MCP server e.g. `http://example/sse` + description: The URL for the SSE endpoint of the MCP server e.g. `http://localhost:8000/sse` or `http://192.168.1.100:8000/sse`
61-61: Remove trailing space.There is a trailing space at the end of line 61.
-and directly run an MCP server as a local command line tool. You can +and directly run an MCP server as a local command line tool. You can🧰 Tools
🪛 Markdownlint (0.37.0)
61-61: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
70-75: Consider expanding the Tools section.The Tools section could benefit from:
- Examples of common tools
- How to configure and use tools with conversation agents
- Best practices for tool usage
96-96: Remove extra blank line.There are multiple consecutive blank lines that should be reduced to a single blank line.
- - +🧰 Tools
🪛 Markdownlint (0.37.0)
96-96: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
1-101: Consider adding these sections to enhance the documentation:
- Add a "First-time setup" section with step-by-step instructions
- Include example configurations for popular MCP servers
- Add troubleshooting examples for common issues
🧰 Tools
🪛 Markdownlint (0.37.0)
49-49: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
61-61: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
96-96: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/mcp.markdown(1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
source/_integrations/mcp.markdown
49-49: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
61-61: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
96-96: Expected: 1; Actual: 2
Multiple consecutive blank lines
(MD012, no-multiple-blanks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (5)
source/_integrations/mcp.markdown (5)
1-16: LGTM! Frontmatter is well-structured.The metadata is correctly configured with appropriate categories, IoT class, and related integrations.
18-27: LGTM! Clear and informative introduction.The introduction effectively explains the purpose and benefits of the MCP integration.
28-34: LGTM! Prerequisites are clearly stated.The requirements and additional resources are well-documented.
46-67: LGTM! Comprehensive architecture overview.The section effectively explains the integration's architecture and its relationship with LLM conversation agents.
🧰 Tools
🪛 Markdownlint (0.37.0)
49-49: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
61-61: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
89-101: LGTM! Clear troubleshooting and removal instructions.The section provides helpful debugging resources and standard removal instructions.
🧰 Tools
🪛 Markdownlint (0.37.0)
96-96: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
Proposed change
Add Model Context Protocol integration documentation.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit