Skip to content
Back to search

edumcp

EDUMCP is a protocol that integrates the Model Context Protocol (MCP) with applications in the education field, dedicated to achieving seamless interconnection and interoperability among different AI models, educational applications, smart hardware, and teaching AGENTs.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/aieducations--edumcp/badge.svg)](/listings/aieducations--edumcp)

HTML

<a href="/listings/aieducations--edumcp"><img src="/api/listings/aieducations--edumcp/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Prerequisites

- Docker and Docker Compose - Python 3.10 or higher (for local development)

Installation

1. Clone the repository:

   git clone https://github.com/CHILDEDUAI/aichildedu.git
   cd aichildedu

2. Create an `.env` file in the root directory with the following variables:

   # Database
   POSTGRES_USER=postgres
   POSTGRES_PASSWORD=postgres
   MONGODB_URI=mongodb://mongodb:27017/
   MONGODB_DB=EDUMCP

   # Authentication
   SECRET_KEY=your_secret_key_change_in_production

3. Start the services using Docker Compose:

   docker-compose up -d

4. The API Gateway will be available at `http://localhost:8000`

Local Development Setup

1. Create a virtual environment:

   python -m venv venv
   source venv/bin/activate  # On Windows, use `venv\Scripts\activate`

2. Install dependencies:

   pip install -r requirements.txt

3. Run the desired service:

   uvicorn aichildedu.user_service.main:app --reload --port 8001

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 349 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # EDUMCP
  2. <div align="center">
  3. <a href="https://aichildedu.xyz/">
  4. <img src="https://raw.githubusercontent.com/aieducations/edumcp/refs/heads/main/assets/logo.jpg" margin-top="15px" margin-bottom="15px" width="200px" alt="Logo">
  5. </a>
  6. </div>
  7. EDUMCP, short for Educational Model Context Protocol, is an innovative open platform protocol designed to break down the silo effect currently seen in AI applications within education. Built on the robust Model Context Protocol (MCP), EDUMCP enables seamless interconnection and interoperability among diverse AI models, educational applications, smart hardware, and even teaching content.
  8. An AI tutoring system can easily share and understand data and context with a story generation model, an interactive game engine, or a virtual experiment platform. By establishing such a standardized communication bridge, EDUMCP brings unprecedented possibilities to the field of education, enabling various AI tools to work together to provide users with richer, more personalized, and more inspiring learning content and services.
  9. **EDUMCP One-Sentence Video Creation Framework**
  10. You only need to provide a one-sentence topic, and EDUMCP can generate a roughly 30-60 second animated video for children. It will support translation of English: dialogue content modification and image changes.
  11. like:Create an video that EDUMCP robot that makes the ROYA start to enjoy learning.
  12. [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
  13. [![Python](https://img.shields.io/badge/python-3.8%2B-blue)](https://www.python.org/)
  14. [![React](https://img.shields.io/badge/react-18%2B-blue)](https://react.dev/)
  15. [![FastAPI](https://img.shields.io/badge/fastapi-0.110.0-blue)](https://fastapi.tiangolo.com/)
  16. [![Docker](https://img.shields.io/badge/docker-24.0.5-blue)](https://www.docker.com/)
  17. [![PostgreSQL](https://img.shields.io/badge/postgresql-16.1-blue)](https://www.postgresql.org/)
  18. [![MongoDB](https://img.shields.io/badge/mongodb-6.0-blue)](https://www.mongodb.com/)
  19. [![Redis](https://img.shields.io/badge/redis-7.4-blue)](https://redis.io/)
  20. [![Elasticsearch](https://img.shields.io/badge/elasticsearch-9.1-blue)](https://www.elastic.co/elasticsearch/)
  21. ## Overview
  22. AICHILDEDU is an innovative educational platform designed specifically for children, leveraging the power of AI to create engaging, personalized, and educational content. The platform uses a microservice architecture to deliver a variety of AI-powered educational experiences, allowing for flexible scaling and feature expansion.
  23. ## Features
  24. - **Personalized Story Generation**: Create custom educational stories tailored to specific age groups, themes, and educational focuses
  25. - **Educational Quiz Creation**: Generate engaging quizzes and questions that reinforce learning objectives
  26. - **Multimedia Integration**: Combine text, images, voice, and video into comprehensive educational materials
  27. - **Age-Appropriate Content**: Content customization based on age groups and developmental stages
  28. - **Multi-Language Support**: Support for content generation in multiple languages
  29. - **User Management**: Comprehensive user system with parent, teacher, and admin roles
  30. - **Parental Controls**: Robust parental control features to ensure child-appropriate content
  31. - **Asynchronous Processing**: Non-blocking task execution for resource-intensive AI operations
  32. ## System Architecture
  33. EDUMCP follows a microservice architecture with the following key components:
  34. ```
  35. ┌─────────────────┐
  36. │ API Gateway │
  37. └───────┬─────────┘
  38. │
  39. ┌────────┬────────┬────────────────┼────────────────┬────────────────┐
  40. │ │ │ │ │ │
  41. ▼ ▼ ▼ ▼ ▼ ▼
  42. ┌──────────┐ ┌─────────┐ ┌──────────────┐ ┌──────────────┐ ┌──────────────┐
  43. │ User │ │ Content │ │ Learning │ │Recommendation│ │ Analytics │
  44. │ Service │ │ Service │ │ Service │ │ Service │ │ Service │
  45. └──────────┘ └─────────┘ └──────────────┘ └──────────────┘ └──────────────┘
  46. ┌──────────────────────────┐
  47. │ AI Services │
  48. │ │
  49. │ ┌─────────┐ ┌─────────┐ │
  50. │ │ Text │ │ Image │ │
  51. │ │Generator│ │Generator│ │
  52. │ └─────────┘ └─────────┘ │
  53. │ ┌─────────┐ ┌─────────┐ │
  54. │ │ Voice │ │ Video │ │
  55. │ │Generator│ │Generator│ │
  56. │ └─────────┘ └─────────┘ │
  57. └──────────────────────────┘
  58. ```
  59. ## Technologies Used
  60. - **Backend**: Python, FastAPI, Uvicorn
  61. - **Databases**: PostgreSQL, MongoDB, Redis
  62. - **AI & ML**: LangChain, EDUMCP GPT models, TensorFlow, PyTorch, Transformers
  63. - **Storage**: MinIO (Object Storage)
  64. - **Search**: Elasticsearch
  65. - **Containerization**: Docker, Docker Compose
  66. - **Authentication**: JWT-based authentication
  67. ## Getting Started
  68. ### Prerequisites
  69. - Docker and Docker Compose
  70. - Python 3.10 or higher (for local development)
  71. ### Installation
  72. 1. Clone the repository:
  73. ```bash
  74. git clone https://github.com/CHILDEDUAI/aichildedu.git
  75. cd aichildedu
  76. ```
  77. 2. Create an `.env` file in the root directory with the following variables:
  78. ```
  79. # Database
  80. POSTGRES_USER=postgres
  81. POSTGRES_PASSWORD=postgres
  82. MONGODB_URI=mongodb://mongodb:27017/
  83. MONGODB_DB=EDUMCP
  84. # Authentication
  85. SECRET_KEY=your_secret_key_change_in_production
  86. ```
  87. 3. Start the services using Docker Compose:
  88. ```bash
  89. docker-compose up -d
  90. ```
  91. 4. The API Gateway will be available at `http://localhost:8000`
  92. ### Local Development Setup
  93. 1. Create a virtual environment:
  94. ```bash
  95. python -m venv venv
  96. source venv/bin/activate # On Windows, use `venv\Scripts\activate`
  97. ```
  98. 2. Install dependencies:
  99. ```bash
  100. pip install -r requirements.txt
  101. ```
  102. 3. Run the desired service:
  103. ```bash
  104. uvicorn aichildedu.user_service.main:app --reload --port 8001
  105. ```
  106. ## Usage Examples
  107. ### Generating a Story
  108. ```python
  109. import requests
  110. api_url = "http://localhost:8000/api/v1/ai/text/story"
  111. story_request = {
  112. "title": "The Curious Robot",
  113. "theme": "Technology and Friendship",
  114. "age_group": "6-8",
  115. "characters": [
  116. {
  117. "name": "Robo",
  118. "description": "A curious and friendly robot who wants to learn about the world"
  119. },
  120. {
  121. "name": "Mia",
  122. "description": "A smart girl who loves technology and building things"
  123. }
  124. ],
  125. "educational_focus": "Introduction to robotics and programming concepts",
  126. "length": "medium",
  127. "language": "en"
  128. }
  129. response = requests.post(api_url, json=story_request)
  130. task = response.json()
  131. print(f"Story generation task created: {task['task_id']}")
  132. print(f"Check status at: {task['status_check_url']}")
  133. ```
  134. ### Checking Task Status
  135. ```python
  136. import requests
  137. task_id = "task_12345"
  138. status_url = f"http://localhost:8000/api/v1/ai/text/tasks/{task_id}"
  139. response = requests.get(status_url)
  140. status = response.json()
  141. print(f"Task status: {status['status']}")
  142. print(f"Progress: {status['progress']}%")
  143. ```
  144. ### Retrieving Generated Content
  145. ```python
  146. import requests
  147. task_id = "task_12345"
  148. result_url = f"http://localhost:8000/api/v1/ai/text/tasks/{task_id}/result"
  149. response = requests.get(result_url)
  150. story = response.json()
  151. print(f"Story Title: {story['title']}")
  152. print(f"Summary: {story['summary']}")
  153. print("\nContent:")
  154. print(story['content'])
  155. ```
  156. ## API Documentation
  157. The API documentation is available at:
  158. - API Gateway: `http://localhost:8000/docs`
  159. - User Service: `http://localhost:8001/docs`
  160. - Content Service: `http://localhost:8002/docs`
  161. - Learning Service: `http://localhost:8003/docs`
  162. - AI Text Generator: `http://localhost:8010/docs`
  163. - AI Image Generator: `http://localhost:8011/docs`
  164. - AI Voice Generator: `http://localhost:8012/docs`
  165. - AI Video Generator: `http://localhost:8013/docs`
  166. ## Service Architecture
  167. ### User Service
  168. Handles user management, authentication, and authorization. Manages user profiles, child accounts, and parental controls.
  169. ### Content Service
  170. Manages educational content creation, storage, retrieval, and organization with the following features:
  171. - **Content Types Management**:
  172. - **Stories**: Interactive educational narratives with character development, themes, and moral lessons
  173. - **Quizzes**: Customizable question sets with answers, difficulty levels, and scoring mechanisms
  174. - **Lessons**: Structured learning materials with educational objectives and prerequisites
  175. - **Content Organization**:
  176. - **Categories**: Hierarchical organization of content with parent-child relationships
  177. - **Tags**: Flexible content labeling for improved discoverability and filtering
  178. - **Collections**: User-created or curated sets of content (custom, curriculum, featured)
  179. - **Content Filtering and Search**:
  180. - Age-appropriate filtering based on min/max age ranges
  181. - Difficulty level filtering (beginner, intermediate, advanced)
  182. - Content rating filtering (G, PG, educational)
  183. - Multi-language support
  184. - Full-text search capabilities
  185. - **Content Metadata**:
  186. - Educational value tracking
  187. - Subjects and themes classification
  188. - Reading time estimation
  189. - Word count metrics
  190. - **User Interaction**:
  191. - Content reactions (like, favorite, helpful)
  192. - Content sharing and permissions
  193. - User-specific content collections
  194. - **Multimedia Asset Management**:
  195. - Storage and retrieval of images, audio, and video assets
  196. - Asset association with educational content
  197. ### Learning Service
  198. Tracks learning progress, personalized learning paths, and educational achievements with the following features:
  199. - **Learning Path Management**:
  200. - **Curriculum Design**: Structured learning paths based on age groups and subjects
  201. - **Prerequisites**: Dependency management for learning materials
  202. - **Progress Tracking**: Real-time monitoring of learning milestones
  203. - **Adaptive Learning**: Dynamic adjustment of content difficulty based on performance
  204. - **Assessment and Evaluation**:
  205. - **Progress Assessment**: Regular evaluation of learning outcomes
  206. - **Skill Level Analysis**: Tracking of subject-specific competencies
  207. - **Performance Metrics**: Detailed analytics of learning activities
  208. - **Achievement System**: Gamified rewards and badges for accomplishments
  209. - **Personalization Features**:
  210. - **Learning Style Detection**: Identification of individual learning preferences
  211. - **Content Recommendations**: AI-powered suggestions for next learning steps
  212. - **Pace Adjustment**: Flexible learning speed based on individual progress
  213. - **Interest-Based Learning**: Content tailoring based on demonstrated interests
  214. - **Progress Reporting**:
  215. - **Detailed Analytics**: Comprehensive learning progress visualization
  216. - **Parent/Teacher Dashboard**: Monitoring tools for guardians and educators
  217. - **Progress Reports**: Regular automated assessment summaries
  218. - **Learning Insights**: AI-generated recommendations for improvement
  219. - **Collaborative Learning**:
  220. - **Peer Learning**: Facilitated group learning activities
  221. - **Social Interaction**: Safe, moderated peer communication
  222. - **Group Projects**: Collaborative educational tasks
  223. - **Shared Achievements**: Community learning milestones
  224. - **Learning Support**:
  225. - **AI Tutoring**: Intelligent assistance for difficult concepts
  226. - **Homework Help**: Guided problem-solving support
  227. - **Review Sessions**: Automated review of challenging materials
  228. - **Learning Resources**: Additional materials for deeper understanding
  229. ### AI Services
  230. #### Text Generator
  231. Creates educational stories and quizzes with the following features:
  232. - Personalized story generation based on age, theme, and educational focus
  233. - Quiz generation with customizable difficulty levels
  234. - Asynchronous task processing for better resource management
  235. - Template-based content customization
  236. #### Image Generator
  237. Creates illustrations to accompany educational content:
  238. - Story illustration generation
  239. - Character visualization
  240. - Educational diagrams and charts
  241. #### Voice Generator
  242. Provides audio narration for educational content:
  243. - Story narration with different character voices
  244. - Multi-language support
  245. - Age-appropriate voice adaptation
  246. #### Video Generator
  247. Creates educational videos and animations:
  248. - Story animations
  249. - Educational concept visualizations
  250. - Interactive learning content
  251. ## Development and Contribution
  252. ### Development Workflow
  253. 1. Fork the repository
  254. 2. Create a feature branch
  255. 3. Implement your changes
  256. 4. Write tests for new features
  257. 5. Submit a pull request
  258. ### Code Style
  259. This project follows PEP 8 style guidelines. Please ensure your code adheres to these standards before submitting PRs.
  260. ## License
  261. This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.