docs: uvx installation guide
This commit is contained in:
53
README.md
53
README.md
@@ -160,7 +160,58 @@ The final implementation resulted in a 26% improvement in JSON parsing performan
|
||||
> If all APIs are configured, native APIs will take priority when there is a clash in model name, such as for `gemini` and `o3`.
|
||||
> Configure your model aliases and give them unique names in [`conf/custom_models.json`](conf/custom_models.json)
|
||||
|
||||
### 2. Clone and Set Up
|
||||
### 2. Choose Your Installation Method
|
||||
|
||||
**Option A: Quick Install with uvx**
|
||||
|
||||
**Prerequisites**: Install [uv](https://docs.astral.sh/uv/getting-started/installation/) first (required for uvx)
|
||||
|
||||
For **Claude Desktop**, add this to your `claude_desktop_config.json`
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"zen": {
|
||||
"command": "uvx",
|
||||
"args": [
|
||||
"--from",
|
||||
"git+https://github.com/BeehiveInnovations/zen-mcp-server.git",
|
||||
"zen-mcp-server"
|
||||
],
|
||||
"env": {
|
||||
"OPENAI_API_KEY": "your_api_key_here"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
For **Claude Code CLI**, create a `.mcp.json` file in your project root for [project-scoped configuration](https://docs.anthropic.com/en/docs/claude-code/mcp#project-scope):
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"zen": {
|
||||
"command": "uvx",
|
||||
"args": [
|
||||
"--from",
|
||||
"git+https://github.com/BeehiveInnovations/zen-mcp-server.git",
|
||||
"zen-mcp-server"
|
||||
],
|
||||
"env": {
|
||||
"OPENAI_API_KEY": "your_api_key_here"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**What this does:**
|
||||
- **Zero setup required** - uvx handles everything automatically
|
||||
- **Always up-to-date** - Pulls latest version on each run
|
||||
- **No local dependencies** - Works without Python environment setup
|
||||
- **Instant availability** - Ready to use immediately
|
||||
|
||||
|
||||
**Option B: Traditional Clone and Set Up**
|
||||
|
||||
```bash
|
||||
# Clone to your preferred location
|
||||
|
||||
Reference in New Issue
Block a user