From 1d4b0ca7fc0cc269f0d5906a11f2d306026214b4 Mon Sep 17 00:00:00 2001 From: Dhruv Behl Date: Tue, 23 Jun 2026 22:46:20 +0530 Subject: [PATCH 1/2] Add prerequisites section with uv/uvx install instructions Users were confused about needing uvx installed before the MCP server can run. This adds clear install commands for macOS/Linux and Windows. --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 219eedf..440fc61 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,28 @@ 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 + +This server is distributed via [PyPI](https://pypi.org/project/mendix-doc-mcp/) and runs using `uvx` (from [uv](https://docs.astral.sh/uv/)). Install `uv` first 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: From e6cda348c56a032a73ca816f245cbd999b241173 Mon Sep 17 00:00:00 2001 From: Dhruv Behl Date: Wed, 24 Jun 2026 16:51:33 +0530 Subject: [PATCH 2/2] Addressing review comments Clarify that Python is not a prerequisite (uv manages it automatically) and mention MCP client requirement. --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 440fc61..936d46f 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,9 @@ Version-aware search across Studio Pro 8–11, powered by SQLite FTS5 with BM25 ## Prerequisites -This server is distributed via [PyPI](https://pypi.org/project/mendix-doc-mcp/) and runs using `uvx` (from [uv](https://docs.astral.sh/uv/)). Install `uv` first if you don't have it: +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:**