README changes (b0914ac6) · Commits · OOP / code / ai2

deployment/k8s/README.md

+2 −2

Original line number	Diff line number	Diff line
		@@ -96,7 +96,7 @@ curl -X POST "http://127.0.0.1:9013/groq-mcp" \
		-d '{"query":"Create QoD session for device IP 12.1.0.20 application server IP 198.51.100.10 with QoS qos-e and duration 60 seconds"}'
		```

		Get QoD session:
		Get QoD session (copy the previous session id) :

		```bash
		curl -X POST "http://127.0.0.1:9013/groq-mcp" \
		@@ -104,7 +104,7 @@ curl -X POST "http://127.0.0.1:9013/groq-mcp" \
		-d '{"query":"Get QoD session information for 33f6392b-57d0-42a3-a9fd-b4dcce617fce"}'
		```

		Delete QoD session:
		Delete QoD session (copy the previous session id) :

		```bash
		curl -X POST "http://127.0.0.1:9013/groq-mcp" \

mcp_module/README.md

+17 −5

Original line number	Diff line number	Diff line
		@@ -18,7 +18,8 @@ mcp_module/
		├── json_templates/ # CAMARA API request/response templates (interpolated by user input)
		├── models/ # Pydantic models for CAMARA API compliance or custom types
		├── tools/ # MCP tools registered as callable endpoints
		│ ├── qod.py # Quality of Demand (QoD) related tools
		├── qod.py # Quality of Demand (QoD) related tools leveraging OOP OEG
		│ ├── qod_legacy.py # Quality of Demand (QoD) related tools leveraging dummy backend
		│ └── edge_application.py # Discovery of edge applications
		├── app.py
		├── .env
		@@ -37,6 +38,8 @@ mcp_module/
		* `tools/` Implementation of MCP tools — each file should correspond to the equivalent CRUD operations for the relevant REST API.
		* All MCP tools are explicitly registered in `app.py` for safety and traceability:

		Using dummy backend:

		\| Tool \| File \| Description \|
		\| --------------------- \| --------------------------- \|------------------------------------------\|
		\| `create_qod_session` \| `tools/qod.py` \| Creates a CAMARA QoD session \|
		@@ -45,6 +48,16 @@ mcp_module/
		\| `list_qod_sessions` \| `tools/qod.py` \| Get QoS session information for a device
		\| `get_app_definitions` \| `tools/edge_application.py` \| Retrieves available edge app information \|


		Using OOP OEG:

		\| Tool \| File \| Description \|
		\| --------------------- \| --------------------------- \|------------------------------------------\|
		\| `create_qod_session` \| `tools/qod.py` \| Creates a CAMARA QoD session \|
		\| `get_qod_session` \| `tools/qod.py` \| Retrieves QoD session details \|
		\| `delete_qod_session` \| `tools/qod.py` \| Deletes an existing QoD session
		\| `get_app_definitions` \| `tools/edge_application.py` \| Retrieves available edge app information \|

		---

		## ⚙️ Installation
		@@ -61,9 +74,9 @@ pip install -r requirements.txt
		Create a `.env` file in the project root (if not already present) and set your API configuration:
		MCP_HOST=
		MCP_PORT=
		ENV OpenOP_BACKEND_OAI=http://127.0.0.1:32263/oeg/1.0.0


		OpenOP_Backend=
		OpenOP_ISI_BACKEND=
		```


		@@ -94,11 +107,10 @@ Run the container:

		The Dockerfile sets these defaults:
		```
		OpenOP_Backend=
		OpenOP_ISI_BACKEND=

		MCP_HOST=
		MCP_PORT=
		OpenOP_BACKEND_OAI=
		```
		To start the backend with these defaults:
		```