vh/homepage
1
0
Fork 0
mirror of https://github.com/gethomepage/homepage.git synced 2026-10-02 17:01:15 -07:00
Code Issues Actions 12 Packages Projects Releases Wiki Activity

Docs stuff

Browse Source
This commit is contained in:
shamoon
2026-06-13 09:47:45 -07:00
parent 03a64b07f9
commit 53abc9c2fb
2 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/assets/claude_mcp.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 378 KiB

docs/configs/mcp.md
+5 -1
View File
@@ -6,6 +6,10 @@ Homepage includes an optional, lightweight [Model Context Protocol](https://mode
This endpoint is **disabled by default**. Do not expose it to an untrusted network unless you put Homepage behind authentication, TLS, and a reverse proxy that validates Host headers. This endpoint is **disabled by default**. Do not expose it to an untrusted network unless you put Homepage behind authentication, TLS, and a reverse proxy that validates Host headers.
Once enabled you can use the endpoint to help an assistant understand your current Homepage configuration, add new services or widgets, and get links to relevant documentation. For example, an assistant could add a new media service to your dashboard by appending it to `services.yaml` via the MCP endpoint instead of you having to manually edit the file. For example, you can ask an assistant to add a new service entry for Paperless-ngx:
![Example of Claude Request](../../assets/claude_mcp.png)
## Enable the MCP endpoint ## Enable the MCP endpoint
Set the following environment variable and restart Homepage: Set the following environment variable and restart Homepage:
@@ -67,7 +71,7 @@ When writes are enabled, YAML files are parsed before they are saved so a syntac
| `add_info_widget` | Appends an information widget to `widgets.yaml` when `HOMEPAGE_MCP_ALLOW_WRITE=true`. | | `add_info_widget` | Appends an information widget to `widgets.yaml` when `HOMEPAGE_MCP_ALLOW_WRITE=true`. |
| `homepage_docs` | Returns focused Homepage documentation links for common setup topics. | | `homepage_docs` | Returns focused Homepage documentation links for common setup topics. |
The structured write tools are safer than replacing an entire file because they parse the existing YAML, preserve the expected top-level structure, and only append a Homepage-shaped entry. For example, an assistant can add a service with: For example, an assistant can add a service with:
```json ```json
{ {