jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-15 13:26:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for Model Context Protocol authentication

Browse Source
This commit is contained in:
Allen Porter 2025-03-31 03:17:49 +00:00
parent 138da6d1d8
commit be1a624cf0
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
source/_integrations/mcp.markdown
View File

@ -29,9 +29,10 @@ Assistant. You can control what devices and entities it can access from the {% m
## Prerequisites
1. You will need an [MCP server](https://modelcontextprotocol.io/examples).
1. If your MCP server only supports the <abbr title="Standard input/output">*stdio*</abbr> protocol, you will also need an additional
2. If your MCP server only supports the <abbr title="Standard input/output">*stdio*</abbr> protocol, you will also need an additional
MCP proxy (such as [mcp-proxy](https://github.com/sparfenyuk/mcp-proxy)) to expose
the server over <abbr title="Server-sent events">*SSE*</abbr>.
3. If your MCP server requires authentication then you will need an OAuth Client ID and Secret.
{% include integrations/config_flow.md %}
@ -42,6 +43,10 @@ The integration provides the following configuration options:
{% configuration_basic %}
SSE Server URL:
description: The URL for the SSE endpoint of the MCP server. For example, `http://example/sse`.
Client ID:
description: If the server requires authentication, enter the OAuth Client ID for the MCP server in the Application Credentials
Client Secret:
description: If the server requires authentication, enter the OAuth Client Secret for the MCP server in the Application Credentials.
{% endconfiguration_basic %}
## Architecture overview
@ -74,6 +79,12 @@ agent to use the tools.
perform actions through Home Assistant. The tools used by the configured LLM API
are exposed.
### Authorization
The Model Context Protocol supports OAuth, and allows you to give Home Assistant
access to restricted MCP servers. You can enter the MCP Servers [Application Credentials](https://www.home-assistant.io/integrations/application_credentials/) during when configuring
the MCP integration.
## Known limitations
The Home Assistant Model Context Protocol integration currently only supports a