main - fix: Update README to add UV support
This commit is contained in:
parent
80c0a1f32a
commit
2dc21b5363
39
README.md
39
README.md
@ -26,39 +26,42 @@
|
||||
### Requirements
|
||||
- Python >= 3.13
|
||||
- GNURadio (Tested with GNURadio Companion v3.10.12.0)
|
||||
- UV
|
||||
|
||||
### Installation
|
||||
1. [**Install GNURadio**](https://wiki.gnuradio.org/index.php/InstallingGR)
|
||||
|
||||
2. **Set up a Python virtual environment**
|
||||
### Usage
|
||||
1. **Clone the repository**
|
||||
```bash
|
||||
python3.13 -m venv --system-site-packages venv
|
||||
source venv/bin/activate
|
||||
pip install -e .
|
||||
git clone https://github.com/yoelbassin/gnuradioMCP
|
||||
```
|
||||
|
||||
2. [**Install GNURadio**](https://wiki.gnuradio.org/index.php/InstallingGR)
|
||||
|
||||
3. **Set up a UV environment**
|
||||
```bash
|
||||
cd gnuradioMCP
|
||||
uv venv --system-site-packages
|
||||
```
|
||||
> The `--system-site-packages` flag is required because GNURadio installs the `gnuradio` Python package globally.
|
||||
|
||||
### Usage
|
||||
|
||||
Start the MCP server:
|
||||
```bash
|
||||
python main.py
|
||||
```
|
||||
|
||||
Connect your LLM or automation tool with:
|
||||
4. **Add the MCP server configuration to your client configuration.** For example, for Claude Desktop or Cursor:
|
||||
```json
|
||||
"mcpServers": {
|
||||
"GnuradioMCP": {
|
||||
"url": "http://localhost:8000/sse"
|
||||
"command": "uv",
|
||||
"args": [
|
||||
"--directory",
|
||||
"/path/to/gnuradioMCP",
|
||||
"run",
|
||||
"main.py"
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
## Development
|
||||
Install development dependencies and run tests with:
|
||||
```bash
|
||||
pip install -e .[dev]
|
||||
pip install -e ".[dev]"
|
||||
pytest
|
||||
```
|
||||
|
||||
|
||||
3
main.py
3
main.py
@ -24,4 +24,5 @@ app: FastMCP = FastMCP(
|
||||
|
||||
McpPlatformProvider.from_platform_middleware(app, PlatformMiddleware(platform))
|
||||
|
||||
app.run(transport="sse")
|
||||
if __name__ == "__main__":
|
||||
app.run()
|
||||
|
||||
@ -9,7 +9,10 @@ description = "A FastMCP server for gnuradio."
|
||||
requires-python = ">=3.13"
|
||||
dependencies = [
|
||||
"pydantic",
|
||||
"fastmcp"
|
||||
"fastmcp",
|
||||
# for gnuradio
|
||||
"mako",
|
||||
"pyyaml",
|
||||
]
|
||||
|
||||
[project.optional-dependencies]
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user