Skip to content

Fix installation docs and add missing build dependency #41

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

Merged
adalton merged 2 commits into from
Mar 31, 2026
Merged

Fix installation docs and add missing build dependency #41

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
69f0e59
fix: correct installation docs and add missing build dependency
adalton Mar 27, 2026
3ba4e17
fix: sync __init__.py version with pyproject.toml (0.3.0)
adalton Mar 27, 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
45 changes: 41 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ A Model Context Protocol (MCP) server for managing Ambient Code Platform (ACP) s
```bash
# Install
git clone https://github.com/ambient-code/mcp
pip install dist/mcp_acp-*.whl
cd mcp
pip install . # installs the 'mcp-acp' command

# Configure
mkdir -p ~/.config/acp
Expand Down Expand Up @@ -113,23 +114,59 @@ List my ACP sessions

## Installation

### From Source (end users)

```bash
git clone https://github.com/ambient-code/mcp
cd mcp
pip install . # installs the 'mcp-acp' command
```

### From Wheel

Requires `make` to be installed.

```bash
# "make install" sets up the dev environment (.venv + dependencies),
# which "make build" then uses to produce the wheel in dist/
make install
make build
pip install dist/mcp_acp-*.whl
```

### From Source
### Development Install (contributors)

```bash
git clone https://github.com/ambient-code/mcp
cd mcp
uv venv
uv pip install -e ".[dev]"
```

### Virtual Environment Install

On some Linux distributions (Debian, Ubuntu, Fedora 38+), [PEP 668](https://peps.python.org/pep-0668/)
prevents `pip install` into the system Python. If you get an "externally-managed-environment" error,
install into a virtual environment instead:

```bash
git clone https://github.com/ambient-code/mcp
cd mcp
python3 -m venv .venv
source .venv/bin/activate
pip install .
```

Note that the `mcp-acp` command will only be available inside the venv. To use it
from an MCP client like Claude Code, reference the full path:

```bash
claude mcp add mcp-acp -t stdio /full/path/to/mcp/.venv/bin/mcp-acp
```

**Requirements:**

- Python 3.10+
- Python 3.12+
- Bearer token for the ACP public-api gateway
- Access to an ACP cluster

Expand Down Expand Up @@ -233,7 +270,7 @@ For a local wheel (before PyPI publish):
"mcpServers": {
"acp": {
"command": "uvx",
"args": ["--from", "/full/path/to/dist/mcp_acp-0.1.0-py3-none-any.whl", "mcp-acp"]
"args": ["--from", "/full/path/to/dist/mcp_acp-0.3.0-py3-none-any.whl", "mcp-acp"]
Comment thread
coderabbitai[bot] marked this conversation as resolved.
}
}
}
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ dev = [
"mypy>=1.0.0",
"pre-commit>=4.0.0",
"bandit>=1.7.0",
"build>=1.0.0",
]

[project.scripts]
Expand Down
Loading