Fix installation docs and add missing build dependency#41
Fix installation docs and add missing build dependency#41
Conversation
The Quick Start referenced a pre-built wheel (dist/mcp_acp-*.whl) that doesn't exist after a fresh clone, and the Python version requirement was listed as 3.10+ instead of the actual 3.12+. Reorganized the Installation section to lead with the simplest path (pip install from source), clarified audience for each install method, added a venv fallback for PEP 668 systems with guidance on configuring MCP clients to use the venv path, and added the missing `build` package to dev dependencies so `make build` succeeds. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
WalkthroughREADME installation and development instructions were rewritten (separate end‑user, contributor, and virtualenv flows), Python requirement raised to 3.12+, local wheel reference updated to 0.3.0, Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 273: The package version in pyproject.toml (version = "0.3.0") and README
use 0.3.0 but src/mcp_acp/__init__.py still sets __version__ = "0.1.0"; update
the __version__ constant in src/mcp_acp/__init__.py to "0.3.0" so the
module-level __version__ matches pyproject.toml and the README, ensuring
consistent package metadata and runtime version checks.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: cab5c6b2-f63e-462f-8dc2-9f28d364c556
📒 Files selected for processing (2)
README.mdpyproject.toml
__init__.py was never updated when 0.3.0 was released in 95e83ee, leaving __version__ at "0.1.0". Align it with pyproject.toml. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/mcp_acp/__init__.py`:
- Line 3: Replace the hardcoded __version__ string in __init__.py with dynamic
retrieval from package metadata: import importlib.metadata (or
importlib_metadata for older Python), attempt to call
importlib.metadata.version("mcp-acp") and assign that to __version__, and fall
back to the existing literal "0.3.0" if the package metadata is not available
(catch PackageNotFoundError or ImportError) so importing the package in a dev
environment still works; update the module-level imports and the __version__
assignment (refer to symbol __version__ in src/mcp_acp/__init__.py and use
importlib.metadata.version as the retrieval function).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: f1bfed7c-2af8-4d65-b218-b5f514518724
📒 Files selected for processing (1)
src/mcp_acp/__init__.py
| """MCP ACP Server - Ambient Code Platform management via MCP.""" | ||
|
|
||
| __version__ = "0.1.0" | ||
| __version__ = "0.3.0" |
There was a problem hiding this comment.
🧹 Nitpick | 🔵 Trivial
LGTM! Version now aligns with pyproject.toml.
The version string correctly matches the version = "0.3.0" declared in pyproject.toml, fixing the previous drift.
Optional: Consider a single source of truth for versioning.
To prevent future version drift between __init__.py and pyproject.toml, consider using importlib.metadata.version("mcp-acp") to read the version dynamically from the installed package metadata, or configure dynamic versioning in pyproject.toml.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@src/mcp_acp/__init__.py` at line 3, Replace the hardcoded __version__ string
in __init__.py with dynamic retrieval from package metadata: import
importlib.metadata (or importlib_metadata for older Python), attempt to call
importlib.metadata.version("mcp-acp") and assign that to __version__, and fall
back to the existing literal "0.3.0" if the package metadata is not available
(catch PackageNotFoundError or ImportError) so importing the package in a dev
environment still works; update the module-level imports and the __version__
assignment (refer to symbol __version__ in src/mcp_acp/__init__.py and use
importlib.metadata.version as the retrieval function).
1 participant
Summary
pip install dist/mcp_acp-*.whl(fails after fresh clone sincedist/doesn't exist) withpip install .requires-pythonin pyproject.tomlmake install→make builddependency, and added a "Virtual Environment Install" fallback for PEP 668 systems with MCP client configuration guidancebuilddependency:make buildrunspython -m buildbut thebuildpackage was not in dev dependencies, causingModuleNotFoundError0.1.0to0.3.0in uvx example🤖 Generated with Claude Code