gr-mcp/README.md
2025-04-27 00:32:21 +03:00

28 lines
833 B
Markdown

# GNURadio MCP Server
The goal of this project is allowing LLMs to create GNURadio Flowcharts for GNURadio Companion.
## Installation
Install GNURadio, follow the installation process in [InstallingGR](https://wiki.gnuradio.org/index.php/InstallingGR).
```bash
brew install gnuradio
```
Now create a virtual environment to run the project.
```bash
python3.13 -m venv --system-site-packages venv
source venv/bin/activate
pip install -e .
```
we use the `--system-site-packages` flag since GNURadio installs the `gnuradio` python package globally.
## Current Status
Rewriting the server using `gnuradio.grc` library. Currently using GNURadio Companion (v3.10.12.0).
## TODO:
- Add flowgraph save
- Add elements validation
- Add errors check
- Build MCP interface
- [Optional] Build REST interface
- Implement usage of Python Block