Skip to content

Add prerequisites section with uv install instructions#1

Open
dhruvbehl wants to merge 2 commits into
mainfrom
docs/add-prerequisites-section
Open

Add prerequisites section with uv install instructions#1
dhruvbehl wants to merge 2 commits into
mainfrom
docs/add-prerequisites-section

Conversation

@dhruvbehl

Copy link
Copy Markdown
Collaborator

Summary

  • Adds a Prerequisites section to the README with install commands for uv/uvx (macOS/Linux and Windows)
  • Includes a verification step (uvx --version)
  • Addresses user confusion when uvx is not installed and the MCP server fails to start

Context

Users reported the server not working in Claude Desktop because uvx wasn't installed. This was raised in Slack — the README previously assumed users already had uv available.

Users were confused about needing uvx installed before the MCP server
can run. This adds clear install commands for macOS/Linux and Windows.
@dhruvbehl dhruvbehl self-assigned this Jun 23, 2026
@pommi pommi self-requested a review June 24, 2026 07:30

@MarkvanMents MarkvanMents left a comment

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 for that - just a quick comment on the PR.

Comment thread README.md

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

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?

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

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

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

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.

Clarify that Python is not a prerequisite (uv manages it automatically)
and mention MCP client requirement.

@MarkvanMents MarkvanMents left a comment

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 for this.
I'll look at linking to it from our documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants