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-08 18:06:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document Model Context Protocol Server OAuth with Home Assistant (#38279)

Browse Source 
* Document Model Context Protocol Server OAuth with Home Assistant

* Update source/_integrations/mcp_server.markdown

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Fix lint errors

* Update mcp_server.markdown

* Apply suggestions from code review

Co-authored-by: Paulus Schoutsen <balloob@gmail.com>

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Paulus Schoutsen <balloob@gmail.com>
This commit is contained in:
Allen Porter 2025-03-31 05:43:55 -07:00 committed by GitHub
parent aefdce6398
commit 5b37938c86
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 21 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
source/_integrations/mcp_server.markdown
View File

@ -61,14 +61,30 @@ to act as a gateway to the Home Assistant MCP SSE server.
## Client configuration ## Client configuration
The Model Context Protocol specification does not yet define standards The Model Context Protocol specification has recently defined standards for
for authentication and connecting to remote servers. These are a *work in progress* authorization and connecting to remote servers. The standards are a *work in progress*
and this configuration will likely change in the near future. and so some clients may not support the latest functionality, and the specification
will likely continue to evolve.
### Access control ### Access control
For now, we can use #### OAuth
[Long-lived access token](https://developers.home-assistant.io/docs/auth_api/#long-lived-access-token) to control access to the API.
The Model Context Protocol supports OAuth for [Authorization](https://spec.modelcontextprotocol.io/specification/2025-03-26/basic/authorization/) and is fully supported by Home Assistant's
[Authentication API](https://developers.home-assistant.io/docs/auth_api/). MCP
Clients that support OAuth can use this to allow you to give the client access
to your Home Assistant MCP server.
Home Assistant has adopted [IndieAuth](https://indieauth.spec.indieweb.org/) and does not require you to pre-define
an OAuth Client ID. Instead, the Client ID is the base of the redirect URL.
- *Client ID*: If your redirect-uri is `https://www.example.com/mcp/redirect`, your client ID should be `https://www.example.com`.
- *Client Secret*: This is not used by Home Assistant and can be ignored or set to any value.
#### Long-Lived Access Tokens
Some MCP clients may not support OAuth, but may support access tokens. You may create a
[Long-lived access token](https://developers.home-assistant.io/docs/auth_api/#long-lived-access-token) to allow the client to access the API.
1. Visit your account profile settings, under the **Security** tab. {% my profile badge %}. 1. Visit your account profile settings, under the **Security** tab. {% my profile badge %}.