Conversation
Updated the README to reflect changes in server setup instructions and removed outdated CLI tool section.
There was a problem hiding this comment.
Pull request overview
This PR updates the README to simplify server setup instructions by removing the outdated CLI tool configuration section and replacing it with a clearer overview of available setup methods.
Changes:
- Removed CLI tool installation and configuration instructions
- Added new section describing three methods for running the server locally (source code, Docker, and OS-specific binaries)
- Removed manual binary installation configuration example
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Using the source code (recommended for development) | ||
| You’ll need Python 3.11+ installed along with the UV package manager. | ||
| See the example below for setup instructions. |
There was a problem hiding this comment.
The lines describing setup methods lack proper Markdown formatting. Each method should be formatted as a list item or subheading for better readability and structure. Consider using '- ' for bullet points or '#### ' for subheadings.
| Using Docker | ||
| Run the server in a containerized environment using Docker. | ||
| See the example below for details. |
There was a problem hiding this comment.
Inconsistent formatting with the previous method description. This method includes a description on line 77, while the source code method on line 72 doesn't. Either add descriptions to all methods or remove them for consistency.
| Using Docker | |
| Run the server in a containerized environment using Docker. | |
| See the example below for details. | |
| Using Docker (run the server in a containerized environment using Docker; see the example below for details.) |
| Using the source code (recommended for development) | ||
| You’ll need Python 3.11+ installed along with the UV package manager. | ||
| See the example below for setup instructions. | ||
|
|
||
| > [!NOTE] | ||
| > Choose the binary that matches your OS (Windows, macOS, Linux) | ||
| 2. **Execute or Double-click the binary** to launch the interactive configuration tool | ||
| 3. **The tool automatically generates** the JSON configuration file for you | ||
|
|
||
| > [!IMPORTANT] | ||
| > For macOS: You may encounter a security alert saying "Apple could not verify 'mcp-bzm-apitest-darwin' is free of malware." To resolve this: | ||
| > 1. Go to **System Settings** → **Privacy & Security** → **Security** | ||
| > 2. Look for the blocked application and click **"Allow Anyway"** | ||
| > 3. Try running the binary again | ||
| --- | ||
| Using Docker | ||
| Run the server in a containerized environment using Docker. | ||
| See the example below for details. |
There was a problem hiding this comment.
The references to 'See the example below' on lines 74 and 78 may not correspond to actual examples if the removed manual configuration section was the only example. Verify that appropriate examples exist below these references in the full document.
Updated the README to reflect changes in server setup instructions and removed outdated CLI tool section.