From be1a624cf0a67212fa963fc74c3325de0a34a203 Mon Sep 17 00:00:00 2001 From: Allen Porter Date: Mon, 31 Mar 2025 03:17:49 +0000 Subject: [PATCH] Add documentation for Model Context Protocol authentication --- source/_integrations/mcp.markdown | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/source/_integrations/mcp.markdown b/source/_integrations/mcp.markdown index daf088aca75..16209ff3b60 100644 --- a/source/_integrations/mcp.markdown +++ b/source/_integrations/mcp.markdown @@ -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 *stdio* protocol, you will also need an additional +2. If your MCP server only supports the *stdio* protocol, you will also need an additional MCP proxy (such as [mcp-proxy](https://github.com/sparfenyuk/mcp-proxy)) to expose the server over *SSE*. +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