diff --git a/README.md b/README.md index 219eedf..936d46f 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,30 @@ MCP server that provides full-text search over 4,000+ [Mendix documentation](htt Version-aware search across Studio Pro 8–11, powered by SQLite FTS5 with BM25 ranking. Auto-builds the index on first run — no setup required. +## Prerequisites + +You'll need an MCP-compatible client (e.g. Claude Code, Claude Desktop, Cursor, VS Code) and `uvx` (from [uv](https://docs.astral.sh/uv/)). No Python install required — `uv` manages that automatically. + +Install `uv` if you don't have it: + +**macOS / Linux:** + +```bash +curl -LsSf https://astral.sh/uv/install.sh | sh +``` + +**Windows:** + +```powershell +powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex" +``` + +Verify it works: + +```bash +uvx --version +``` + ## Quick Start Add to your MCP client config: