davidlms commited on
Commit
147ce6e
Β·
verified Β·
1 Parent(s): 60703fc

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +56 -6
README.md CHANGED
@@ -1,13 +1,63 @@
1
  ---
2
- title: Ipmentor
3
- emoji: πŸ“Š
4
- colorFrom: yellow
5
- colorTo: indigo
6
  sdk: gradio
7
- sdk_version: 5.32.1
8
  app_file: app.py
9
  pinned: false
10
  license: mit
 
 
 
 
 
 
 
 
 
11
  ---
12
 
13
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: IPMentor
3
+ emoji: 🌐
4
+ colorFrom: blue
5
+ colorTo: green
6
  sdk: gradio
7
+ sdk_version: 5.33.1
8
  app_file: app.py
9
  pinned: false
10
  license: mit
11
+ short_description: IPv4 networking toolkit with verified calculations
12
+ tags:
13
+ - Agents-MCP-Hackathon
14
+ - mcp-server-track
15
+ - networking
16
+ - education
17
+ - ipv4
18
+ - subnet-calculator
19
+ - ai-tutoring
20
  ---
21
 
22
+ # IPMentor 🌐
23
+
24
+ **IPMentor** is an IPv4 networking toolkit designed as verified computational tools for AI tutoring systems. Built for the **Gradio MCP Hackathon 2025**, this project demonstrates how MCP can bridge AI tutoring systems with specialized computational tools, creating more reliable and cost-effective educational experiences.
25
+
26
+ ## 🎯 Hackathon Track: MCP Server/Tool
27
+
28
+ This Gradio app serves as both an interactive web interface and an **MCP Server**, providing three core networking tools that AI agents can access through the Model Context Protocol:
29
+
30
+ - `ip_info` - Analyze IPv4 addresses and subnet masks
31
+ - `subnet_calculator` - Perform subnet calculations with multiple division methods
32
+ - `generate_diagram` - Create visual network diagrams
33
+
34
+ ## πŸ† Competing for Mistral AI Choice Award
35
+
36
+ This project uses **Mistral Small 3.1 24B Instruct** in the AI chatbot demo, showcasing how smaller, efficient models can handle educational interactions while delegating precise calculations to IPMentor's verified tools.
37
+
38
+ ## πŸŽ₯ Demo Video
39
+
40
+ Video demonstration: [assets/ipmentor-demo.mp4](assets/ipmentor-demo.mp4)
41
+
42
+ ## πŸ€– Live AI Chatbot Demo
43
+
44
+ Experience IPMentor in action with an Mistral Small 3.1 24B Instruct: [ipmentor-demo](https://huggingface.co/spaces/Agents-MCP-Hackathon/ipmentor-demo)
45
+
46
+ ## πŸ’‘ Why IPMentor?
47
+
48
+ Current AI tutoring faces a challenge: while LLMs can perform calculations, they occasionally make errors and using powerful models for every calculation is expensive. IPMentor solves this by:
49
+
50
+ - **Verified Calculations**: All subnet mathematics uses dedicated algorithms, eliminating computational errors
51
+ - **Cost-Effective AI**: Smaller models handle pedagogy while IPMentor handles precise calculations
52
+ - **Educational Focus**: Designed specifically for networking education scenarios
53
+
54
+ ## πŸ”— Links
55
+
56
+ - **GitHub Repository**: [https://github.com/DavidLMS/ipmentor](https://github.com/DavidLMS/ipmentor)
57
+ - **AI Chatbot Demo**: [https://huggingface.co/spaces/Agents-MCP-Hackathon/ipmentor-demo](https://huggingface.co/spaces/Agents-MCP-Hackathon/ipmentor-demo)
58
+
59
+ ## πŸ› οΈ Technical Architecture
60
+
61
+ Built with Python, Gradio, native IPv4 algorithms, D2 for diagrams, MCP protocol support, and Pydantic validation. This creates a reliable foundation for AI-powered networking education.
62
+
63
+ **Integration Focus**: IPMentor is designed to complement [LearnMCP-xAPI](https://github.com/DavidLMS/learnmcp-xapi) for comprehensive AI tutoring systems. While IPMentor provides verified computational tools, LearnMCP-xAPI maintains persistent learning records, enabling AI tutors that can both perform accurate calculations and adapt to individual student learning patterns over time.