Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
43 changes: 38 additions & 5 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,23 +110,44 @@ A Python wrapper (`xcodemcpwrapper`) that intercepts responses from `xcrun mcpbr
- Select **Intelligence** in the sidebar
- Under **Model Context Protocol**, toggle **Xcode Tools** on

### Installation
### Installation (Using uvx - Recommended)

The easiest way to install is using [uvx](https://github.com/astral-sh/uv) (requires `uv` to be installed):

```bash
# No manual installation needed - uvx downloads and runs automatically
uvx --from mcpbridge-wrapper mcpbridge-wrapper
```

Or install via pip:
```bash
pip install mcpbridge-wrapper
```

For manual installation (development):
```bash
# Clone the repository
git clone https://github.com/SoundBlaster/XcodeMCPWrapper.git
cd XcodeMCPWrapper

# Run the install script
./scripts/install.sh
```

### Configuration

#### Cursor

Edit `~/.cursor/mcp.json`:
**Using uvx (Recommended):**
```json
{
"mcpServers": {
"xcode-tools": {
"command": "uvx",
"args": ["--from", "mcpbridge-wrapper", "mcpbridge-wrapper"]
}
}
}
```

**Manual installation:**
```json
{
"mcpServers": {
Expand All @@ -139,12 +160,24 @@ Edit `~/.cursor/mcp.json`:

#### Claude Code

**Using uvx (Recommended):**
```bash
claude mcp add --transport stdio xcode -- uvx --from mcpbridge-wrapper mcpbridge-wrapper
```

**Manual installation:**
```bash
claude mcp add --transport stdio xcode -- /Users/YOUR_USERNAME/bin/xcodemcpwrapper
```

#### Codex CLI

**Using uvx (Recommended):**
```bash
codex mcp add xcode -- uvx --from mcpbridge-wrapper mcpbridge-wrapper
```

**Manual installation:**
```bash
codex mcp add xcode -- /Users/YOUR_USERNAME/bin/xcodemcpwrapper
```
Expand Down
96 changes: 86 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,20 +44,39 @@ Xcode's `mcpbridge` returns tool responses in the `content` field but omits the

### Installation

#### Option 1: Via MCP Registry (Recommended)
#### Option 1: Using uvx (Recommended - Easiest)

If your MCP client supports the MCP Registry, you can install directly:
The fastest way to install is using [uvx](https://github.com/astral-sh/uv) (requires `uv` to be installed):

```bash
# No manual installation needed - uvx will automatically download and run
uvx --from mcpbridge-wrapper mcpbridge-wrapper
```

Or add to your MCP client configuration directly (see configuration sections below).

#### Option 2: Via MCP Registry

If your MCP client supports the MCP Registry:

**Server name:** `io.github.SoundBlaster/xcode-mcpbridge-wrapper`

```bash
# Using mcp-publisher CLI
mcp-publisher install io.github.SoundBlaster/xcode-mcpbridge-wrapper
```

# Or via your MCP client's registry browser
#### Option 3: Using pip

```bash
pip install mcpbridge-wrapper
```

#### Option 2: Manual Installation
Then use `mcpbridge-wrapper` or `xcodemcpwrapper` command.

#### Option 4: Manual Installation (Development)

For development or if you prefer to install from source:

```bash
git clone https://github.com/SoundBlaster/XcodeMCPWrapper.git
Expand All @@ -70,12 +89,10 @@ Add the following to your `~/.bashrc` or `~/.zshrc`:
export PATH="$HOME/bin:$PATH"
```

Then reload config:
Then reload:
```bash
source ~/.zshrc
```
or use shortcut:
```bash
# or
. ~/.zshrc
```

Expand All @@ -95,7 +112,22 @@ Options:

#### Cursor

Edit `~/.cursor/mcp.json` with replacing `YOUR_USERNAME` with your real username:
**Using uvx (Recommended):**

Edit `~/.cursor/mcp.json`:

```json
{
"mcpServers": {
"xcode-tools": {
"command": "uvx",
"args": ["--from", "mcpbridge-wrapper", "mcpbridge-wrapper"]
}
}
}
```

**Using manual installation:**

```json
{
Expand All @@ -110,19 +142,49 @@ Edit `~/.cursor/mcp.json` with replacing `YOUR_USERNAME` with your real username

#### Claude Code

**Using uvx (Recommended):**

```bash
claude mcp add --transport stdio xcode -- uvx --from mcpbridge-wrapper mcpbridge-wrapper
```

**Using manual installation:**

```bash
claude mcp add --transport stdio xcode -- ~/bin/xcodemcpwrapper
```

#### Codex CLI

**Using uvx (Recommended):**

```bash
codex mcp add xcode -- uvx --from mcpbridge-wrapper mcpbridge-wrapper
```

**Using manual installation:**

```bash
codex mcp add xcode -- ~/bin/xcodemcpwrapper
```

#### Zed Agent

Edit `~/.zed/settings.json` (or use the Zed > Settings menu):
**Using uvx (Recommended):**

Edit `~/.zed/settings.json`:

```json
{
"xcode-tools": {
"command": "uvx",
"args": ["--from", "mcpbridge-wrapper", "mcpbridge-wrapper"],
"env": {}
}
}
```

**Using manual installation:**

```json
{
Expand All @@ -136,8 +198,22 @@ Edit `~/.zed/settings.json` (or use the Zed > Settings menu):

#### Kimi CLI

**Using uvx (Recommended):**

Edit `~/.kimi/mcp.json`:

```json
{
"xcode-tools": {
"command": "uvx",
"args": ["--from", "mcpbridge-wrapper", "mcpbridge-wrapper"],
"env": {}
}
}
```

**Using manual installation:**

```json
{
"xcode-tools": {
Expand Down
118 changes: 118 additions & 0 deletions SPECS/ARCHIVE/P9-T2_uvx_documentation_update/PRD.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
# P9-T2: Update Documentation with uvx Installation Method

## Overview

**Task ID:** P9-T2
**Task Name:** Update Documentation with uvx Installation Method
**Priority:** P1
**Status:** In Progress

## Problem Statement

The package is now published to PyPI and MCP Registry, but all documentation still describes only the manual installation method (cloning repo and running install.sh). The `uvx` tool provides a much simpler one-line installation that doesn't require cloning or manual PATH setup. We need to update all documentation to make uvx the recommended installation method.

## Background

- Package name on PyPI: `mcpbridge-wrapper`
- MCP Registry name: `io.github.SoundBlaster/xcode-mcpbridge-wrapper`
- uvx command: `uvx --from mcpbridge-wrapper mcpbridge-wrapper`
- The user has already verified uvx works correctly with Cursor and Claude

## Deliverables

### 1. Primary Documentation Updates

#### README.md Changes
- [ ] Add uvx as Option 1 (Recommended) in Installation section
- [ ] Keep manual installation as Option 2 (Alternative/Development)
- [ ] Update all client configuration examples to show uvx method first
- [ ] Update Cursor config to show uvx method
- [ ] Update Claude Code config to show uvx method
- [ ] Update Codex CLI config to show uvx method
- [ ] Update Zed Agent config to show uvx method
- [ ] Update Kimi CLI config to show uvx method

#### docs/installation.md Changes
- [ ] Reorder installation options: uvx first, then pip, then manual
- [ ] Add clear uvx installation section with examples
- [ ] Update verification section to include uvx verification

#### docs/cursor-setup.md Changes
- [ ] Add uvx configuration as primary method
- [ ] Keep manual path configuration as alternative
- [ ] Update GUI setup instructions
- [ ] Update JSON configuration examples

#### docs/claude-setup.md Changes
- [ ] Add uvx one-line setup command
- [ ] Keep manual path as alternative

#### docs/codex-setup.md Changes
- [ ] Add uvx one-line setup command
- [ ] Keep manual path as alternative

#### docs/troubleshooting.md Changes
- [ ] Add uvx-specific troubleshooting (if any)
- [ ] Update "command not found" section to mention uvx

#### AGENTS.md Changes
- [ ] Update Quick Start to show uvx method
- [ ] Keep manual install for development context

### 2. Configuration Template Updates

#### config/cursor-mcp.json
- [ ] Add uvx template option
- [ ] Keep path-based option commented

#### config/claude-code.txt
- [ ] Add uvx command example
- [ ] Keep path-based command as alternative

#### config/codex-cli.txt
- [ ] Add uvx command example
- [ ] Keep path-based command as alternative

### 3. DocC Documentation (if applicable)
- [ ] Check if DocC docs need updating
- [ ] Update Installation.md in DocC if it exists

## Acceptance Criteria

1. **Primary Method**: uvx is clearly presented as the recommended installation method
2. **Alternative Preserved**: Manual installation is still documented for development/advanced users
3. **All Clients Covered**: Cursor, Claude, Codex, Zed, Kimi all have uvx configuration examples
4. **Working Verified**: Documentation reflects the verified working state (user tested)
5. **No Breaking Changes**: Existing manual installation paths still work
6. **Consistency**: All documentation files use consistent uvx examples

## Implementation Plan

1. Update README.md (main entry point)
2. Update docs/installation.md
3. Update docs/cursor-setup.md
4. Update docs/claude-setup.md
5. Update docs/codex-setup.md
6. Update docs/troubleshooting.md
7. Update AGENTS.md
8. Update config templates
9. Run quality gates
10. Create validation report

## Testing/Verification

- [ ] Documentation is consistent across all files
- [ ] No broken links or references
- [ ] All code examples are syntactically correct
- [ ] uvx commands are accurate

## Dependencies

- P9-T1 (version 0.2.0 release) - Package must be on PyPI

## Notes

- uvx is part of the `uv` tool (https://github.com/astral-sh/uv)
- uvx automatically handles Python package installation and caching
- No manual PATH setup required with uvx
- uvx is the modern Python equivalent of `npx` for Node.js
Loading