From 7a7778b84f12c49ea5b3abcb869c37dfd3cc2019 Mon Sep 17 00:00:00 2001 From: Chris Coutinho Date: Mon, 5 May 2025 00:36:25 +0200 Subject: [PATCH] Update README --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index e69de29..bd86d91 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,22 @@ +# Nextcloud MCP Server + +The Nextcloud MCP server allows you to automate various actions on a Nextcloud instance via Large Language Models (LLMs) such as OpenAI, Gemini, etc. + +To run the project locally, first make a copy of the `env.sample` file with your configuratoin. Then run the SSE server as follows: + +```bash +$ source env.sample +$ mcp run --transport sse nextcloud_mcp_server/server.py:mcp +``` + +or via a Docker container + +```bash +$ docker run -p 127.0.0.1:8000:8000 --env-file env.sample ghcr.io/cbcoutinho/nextcloud-mcp-server +``` + +Once the server is running, you can connect to the server on port 8000 SSE/HTTP. + +## Features + +- Notes API: https://github.com/nextcloud/notes/blob/main/docs/api/README.md \ No newline at end of file