Update mcp server documentation with additional information #37248
Conversation
home-assistant
bot
added
has-parent
|
This is targeting |
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request updates the API documentation in the MCP server integration file. The description now emphasizes using the Stateless Assist version of the Assist API and avoids including state information in prompts. A new "Prompts" section has been added, detailing its role in guiding LLM calls and updating its support status in Home Assistant. The troubleshooting section has also been expanded to address connection issues between the LLM client and the Home Assistant MCP server. Changes
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 (2)
source/_integrations/mcp_server.markdown (2)
128-136: Addition of the "Prompts" Section
The new "Prompts" section is a valuable enhancement. It effectively explains how MCP Prompts guide LLM calls and reinforces the recommendation to use the Stateless Assist API. As an additional improvement, consider including a brief example or sample prompt configuration to help users understand the practical implementation.
137-138: Markdown Lint: Remove Extra Blank Line
There appear to be multiple consecutive blank lines before the "## Known Limitations" section. Please remove the extra blank line to comply with markdownlint (MD012) guidelines.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
138-138: Multiple consecutive blank lines
Expected: 1; Actual: 2(MD012, no-multiple-blanks)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/mcp_server.markdown(3 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/mcp_server.markdown
138-138: Multiple consecutive blank lines
Expected: 1; Actual: 2
(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 (2)
source/_integrations/mcp_server.markdown (2)
37-41: Configuration Description Update
The updated configuration option now clearly recommends using the Stateless Assist API, which aligns well with the intended usage. Ensure that all downstream documentation and examples are updated to reflect this change.
146-146: Supported Functionality Table Update for Prompts
Updating the support status for Prompts from ❌ to ✅ correctly reflects the current capability. Please double-check that this change is synchronized with any related API references or configuration guides.
Proposed change
Update mcp server documentation with additional information about supported promps and known issues.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit