From dac2352c9ddc2c51ac53c9242599b4a42c362dc5 Mon Sep 17 00:00:00 2001
From: Timo Behrendt <t.behrendt@t00n.de>
Date: Tue, 15 Jul 2025 20:44:21 +0200
Subject: [PATCH] update readme

---
 README.md | 38 +++++++++++++++++++++++++++++++++++++-
 1 file changed, 37 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index edb4b6d..4d17d14 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,37 @@
-# outline-mcp
+# Outline MCP
+
+[Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server wrapping the [Outline HTTP API](https://www.getoutline.com/developers). Tools will be added as needed.
+
+## Run
+
+Use docker image pushed to https://gitea.t000-n.de/t.behrendt/outline-mcp:latest
+
+Required Environment variables:
+
+- OUTLINE_BASE_URL=https:/example.com/api
+- OUTLINE_API_KEY=xx_api_xx
+
+The server will start on port 3000.
+
+## Integrate into Claude
+
+Use [mcp-remote](https://www.npmjs.com/package/mcp-remote) as this currently works best with Claude Desktop. Change the URL to wherever your MCP server runs and adjust authentication according to the package. Refer to the [Claude Desktop MCP documentation](https://modelcontextprotocol.io/quickstart/user) for a deeper dive.
+
+```json
+{
+  "mcpServers": {
+    "outline": {
+      "command": "npx",
+      "args": ["mcp-remote", "http://localhost:3000/mcp"]
+    }
+  }
+}
+```
+
+## Test
+
+Use the [mcp inspector](https://www.npmjs.com/package/@modelcontextprotocol/inspector) to view tools and run tests.
+
+```bash
+bunx @modelcontextprotocol/inspector
+```