free5GC MCP (Model Context Protocol) Server

This project is an MCP (Model Context Protocol) server implemented in Go that provides AI assistants (like GitHub Copilot) with tools to manage free5GC 5G core network subscribers and configurations.

Features

• Core Network Control: Start, stop, and monitor all free5GC network functions (NRF, AMF, SMF, UPF, etc.)
• Subscriber Management: Full CRUD operations for 5G subscribers
• Tenant User Management: Query users within tenants
• JWT Authentication: Automatic authentication with free5GC webconsole
• VS Code Integration: Works seamlessly with GitHub Copilot in VS Code

---

Table of Contents

1. Prerequisites
2. free5GC Setup
3. Configuring Sudo for MCP Server
4. Patching free5GC run.sh
5. Setting Up the MCP Server
6. VS Code MCP Configuration
7. Tool Summary
8. Configuration Reference
9. Usage Examples
10. Quick Start (TL;DR)
11. Troubleshooting

---

Prerequisites

• Go: Version 1.22 or later (1.23+ recommended)
• MongoDB: Version 4.4 or later
• VS Code: With GitHub Copilot extension installed
• free5GC: installation guide
• free5gc-helm: installation guide

---

free5GC Setup

This setup is only for local free5gc. Skip this if you use free5gc-helm.

Step 1: Start MongoDB

sudo systemctl start mongodb
sudo systemctl enable mongodb

# Verify MongoDB is running
mongosh --eval "db.adminCommand('ping')"

Step 2: Clone and Build free5GC

# Clone free5GC
git clone --recursive -b v4.1.0 -j `nproc` https://github.com/free5gc/free5gc.git
cd free5gc

# Build all NFs
make all

# Build webconsole
cd webconsole
go build -o bin/webconsole ./server.go

Step 3: Start free5GC Components

Edit webuicfg.yaml:

# modify the webconsole port 
nano ~/free5gc/config/webuicfg.yaml
port: 5000 -> 30500

# Terminal 1: Start the webconsole (backend API server)
cd free5gc/webconsole
./bin/webconsole

# The webconsole will be available at http://127.0.0.1:30500
# Default login: admin / free5gc

Step 4: Verify free5GC is Running

# Check webconsole health
curl -s http://127.0.0.1:30500/api/health

# Login to get a token (for manual testing)
curl -s -X POST http://127.0.0.1:30500/api/login \
  -H "Content-Type: application/json" \
  -d '{"username":"admin","password":"free5gc"}'

---

Configuring Sudo for MCP Server