From 2ade89408e6a1ac75c20b02572524db12d355040 Mon Sep 17 00:00:00 2001
From: Yoel Bassin <joel@Mac-2.lan>
Date: Sun, 27 Apr 2025 22:20:31 +0300
Subject: [PATCH] main - fix: Update README

---
 README.md | 26 ++++++++++++++++----------
 1 file changed, 16 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index 4eb62f4..c997249 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
 # GNURadio MCP Server
-The goal of this project is allowing LLMs to create GNURadio Flowcharts for GNURadio Companion.
+The goal of this project is allowing LLMs to create GNURadio Flowcharts for GNURadio Companion. The MCP server works by creating a flowchart and saving it as a `.grc` file that can be opened in gnuradio-companion.
 
 ## Installation
 
@@ -15,13 +15,19 @@ 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).
+Currently, you can run the MCP server located on `main.py`
+```
+python main.py
+```
 
-## TODO:
-- Add flowgraph save
-- Add elements validation
-- Add errors check
-- Build MCP interface
-- [Optional] Build REST interface
-- Implement usage of Python Block
+and add the GnuradioMCP server to your LLM using
+```
+  "mcpServers": {
+    "GnuradioMCP": {
+      "url": "http://localhost:8000/sse"
+    }
+  }
+```
+
+## Current Status
+In development, basic server have been created. Currently using GNURadio Companion (v3.10.12.0).