Skip to content

Add prerequisites section with uv install instructions #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dhruvbehl wants to merge 2 commits into
base: main
Choose a base branch
from
+24 −0
Open

Add prerequisites section with uv install instructions #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d4b0ca
Add prerequisites section with uv/uvx install instructions
dhruvbehl Jun 23, 2026
e6cda34
Addressing review comments
dhruvbehl Jun 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

@MarkvanMents MarkvanMents Jun 24, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we also include Python as a prerequisite, or will that be automatically installed with Claude Code/Cursor.

Should we also mention Claude Code/Cursor as prerequisites - and perhaps some other LLM. Or is that too obvious?

@dhruvbehl dhruvbehl Jun 24, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Python is not a prerequisite, uv automatically downloads the required Python version if it's not already present on the system. This is documented at https://docs.astral.sh/uv/concepts/python-versions/#installing-a-python-version

@dhruvbehl dhruvbehl Jun 24, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where as Claude Code/Cursor is obvious, if thats needed i could add it

@dhruvbehl dhruvbehl Jun 24, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed e6cda34

@MarkvanMents MarkvanMents Jun 24, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks.


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:
Expand Down