Skip to content

Add User Guide page for the MCP server#176

Open
Miggets7 wants to merge 2 commits into
mainfrom
docs/mcp-server-guide
Open

Add User Guide page for the MCP server#176
Miggets7 wants to merge 2 commits into
mainfrom
docs/mcp-server-guide

Conversation

@Miggets7

@Miggets7 Miggets7 commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

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

  • How it works — mermaid diagram of AI assistant → MCP server → REST API via a service user.
  • Capabilities — read vs write tools, described by category. Defers the full tool list to the npm page rather than citing a count (avoids drift).
  • Setup — create a service user + roles, Claude Desktop JSON block, claude mcp add command, environment-variable table, Node 24+.
  • Security — warning that write roles let the model create/edit/delete data, and how to revoke access (disable/delete the service user, strip write roles, or rotate the secret). Calls out destructive tools like delete_realm cascading.
  • Notes the server is Beta and currently supports the stdio transport only.

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; no sidebars.ts change needed.

Verification

yarn build passes with onBrokenLinks: 'throw', confirming the page and its cross-link to the Identity and Security guide resolve.

Miggets7 added 2 commits July 22, 2026 15:43
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.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.

Comment thread docs/user-guide/130-ai-assistant-mcp-server.md
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.

Document the OpenRemote MCP server

2 participants