POX MCP Server

1# POX MCP Server
2 
3## Overview
4A Model Context Protocol (MCP) server implementation that provides network control and management capabilities through the POX SDN controller. This server enables Python-based network programming, OpenFlow device management, and automated network analysis through POX's modular architecture. Perfect for educational environments, network prototyping, and SDN research.
5 
6## Components
7 
8### Resources
9The server exposes two dynamic resources:
10- `pox://network-config`: A comprehensive POX controller configuration memo
11  - Tracks active POX components and their configurations
12  - Records network topology and flow rules
13  - Maintains discovered network insights
14- `pox://topology`: Real-time network topology view
15  - Shows active OpenFlow datapaths (switches)
16  - Maps host locations and connections
17  - Displays link status and port mappings
18 
19### Prompts
20The server provides three specialized prompts:
21- `pox-network-manager`: Interactive prompt for POX controller management
22  - Required argument: `topic` - The network control aspect to focus on
23  - Helps configure POX components and modules
24  - Guides through network policy implementation
25  - Integrates with network configuration memo
26 
27- `simple-hub`: Basic L2 hub implementation using POX
28  - Required argument: `dpid` - The datapath identifier
29  - Demonstrates POX's event-driven programming
30  - Shows basic packet handling and flooding
31  - Explains POX's core mechanisms
32 
33- `learning-switch`: L2 learning switch implementation
34  - Required argument: `dpid` - The datapath identifier
35  - Showcases POX's table management
36  - Implements MAC learning and forwarding
37  - Demonstrates POX's packet handling capabilities
38 
39### Tools
40The server offers five core tools:
41 
42#### Datapath Management Tools
43- `get_switches`
44   - List all connected OpenFlow datapaths
45   - No input required
46   - Returns: Array of active POX-controlled switches
47   - Includes connection status and capabilities
48 
49- `get_switch_desc`
50   - Get detailed datapath information
51   - Input:
52     - `dpid` (string): Datapath identifier
53   - Returns: POX-managed switch details and features
54 
55#### Flow Management Tools
56- `get_flow_stats`
57   - Retrieve POX flow statistics
58   - Input:
59     - `dpid` (string): Datapath identifier
60     - `match` (object, optional): POX match structure
61     - `table_id` (string, optional): OpenFlow table ID
62     - `out_port` (string, optional): Output port filter
63   - Returns: POX flow statistics including packet counts
64 
65- `set_table`
66   - Configure POX flow tables
67   - Input:
68     - `dpid` (string): Datapath identifier
69     - `flows` (array): POX flow specifications
70   - Returns: Flow table update confirmation
71 
72#### Analysis Tools
73- `append_insight`
74   - Add network insights to POX configuration memo
75   - Input:
76     - `insight` (string): Network observation or analysis
77   - Returns: Insight addition confirmation
78   - Updates pox://network-config resource
79 
80## Usage with Claude Desktop
81 
82### uv
83 
84```json
85{
86  "mcpServers": {
87    "pox": {
88      "command": "uv",
89      "args": [
90        "--directory",
91        "parent_of_servers_repo/servers/src/mcp_server_pox",
92        "run",
93        "server.py"
94      ],
95      "env": {
96        "POX_SERVER_URL": "http://localhost:8000"
97      }
98    }
99  }
100}
101```
102 
103## License
104 
105This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.
106 
107## Contributing
108 
109Contributions are welcome! Please feel free to submit pull requests, report bugs, or suggest new features.
110