Add User Guide page for the MCP server#176
Open
Miggets7 wants to merge 2 commits into
Open
Conversation
Document the OpenRemote MCP server (@openremote/mcp-server): what it does, how to connect an AI assistant (Claude Desktop / Claude Code) via a service user, the read and write capabilities it exposes, and a caution about granting write access. Notes that the server is Beta and currently supports the stdio transport only.
There was a problem hiding this comment.
Pull request overview
Adds a new User Guide page documenting the OpenRemote MCP server (@openremote/mcp-server) so users can understand what it is, how it works, how to set it up with common MCP clients, and what the security implications are.
Changes:
- Introduces a new User Guide page describing MCP server architecture and capabilities (read vs write).
- Documents setup steps (service user + roles, Claude Desktop JSON, Claude Code command) and required environment variables.
- Adds security guidance and warnings around write permissions and destructive operations.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #177.
What
New User Guide page documenting the OpenRemote MCP server (
@openremote/mcp-server), which lets AI assistants query and manage an OpenRemote instance over the Model Context Protocol.Content
claude mcp addcommand, environment-variable table, Node 24+.delete_realmcascading.Placement
docs/user-guide/130-ai-assistant-mcp-server.md→/docs/user-guide/ai-assistant-mcp-server. Sidebar auto-picks it up from the numeric prefix; nosidebars.tschange needed.Verification
yarn buildpasses withonBrokenLinks: 'throw', confirming the page and its cross-link to the Identity and Security guide resolve.