Skip to main content
Glama
README.md

````markdown
# ๐Ÿš€ EduChain MCP Server

The **EduChain MCP Server** integrates the [EduChain](https://github.com/satvik314/educhain) library with the [Model Context Protocol (MCP)](https://github.com/modelcontextprotocol/python-sdk) to build a local educational content server for **Claude Desktop**.  
It runs via `stdio` and leverages **Grok's free-tier** (xAI) to generate:

- โœ… Multiple-choice questions  
- ๐Ÿ“š Lesson plans  
- ๐Ÿ’ก Flashcards  

Currently focused on **Python programming** and **Algebra**, this server provides AI-powered tools tailored to real-world educational scenarios.

---

## โš™๏ธ Setup Instructions (Windows + VS Code)

1. **Clone the Repository**
   ```bash
   git clone https://github.com/AyaanShaheer/EduChain-MCP-Server
   cd educhain-mcp-server
````

2. **Create and Activate Virtual Environment**

   ```bash
   python -m venv venv
   .\venv\Scripts\activate
   ```

3. **Install Dependencies**

   ```bash
   pip install mcp httpx educhain
   ```

4. **Run the MCP Server**

   ```bash
   python mcp_educhain_server.py
   ```

---

## ๐Ÿ–ฅ๏ธ Claude Desktop Configuration

Edit the config file:

๐Ÿ“ `C:\Users\Ayaan\AppData\Roaming\Claude\claude_desktop_config.json`

```json
{
  "mcpServers": {
    "EduChainServer": {
      "command": "C:\\Users\\Ayaan\\Desktop\\educhain-mcp-server\\venv\\Scripts\\python.exe",
      "args": ["C:\\Users\\Ayaan\\Desktop\\educhain-mcp-server\\mcp_educhain_server.py"],
      "env": {
        "PYTHONPATH": "C:\\Users\\Ayaan\\Desktop\\educhain-mcp-server"
      }
    }
  }
}
```

๐Ÿ” Replace `<YourUsername>` with your actual Windows username.

---

## โœจ Features

* ๐Ÿง  **Multiple-Choice Questions**
  Generate quizzes with options, answers, and explanations.

* ๐Ÿง‘โ€๐Ÿซ **Lesson Plans**
  Create structured teaching plans (e.g., Algebra).

* ๐Ÿƒ **Flashcards**
  Outputs HTML-based flashcards manually (due to API limitations).

---

## ๐Ÿ“Œ Usage Examples

1. Start the server
2. Open Claude Desktop
3. Try commands like:

```
"Generate 5 multiple-choice questions on Python loops."
"Provide a lesson plan for teaching algebra."
"Generate 5 flashcards on Python Programming Basics."
```

๐Ÿ“‚ Responses are saved in: `Sample_Responses.txt`

---

## โš ๏ธ Known Limitations

* Flashcard support via `educhain` is experimental.
  Use the manually generated HTML version in `Sample_Responses.txt`.

---

## ๐Ÿ“… Project Status

* ๐Ÿ—“๏ธ Last updated: **July 3, 2025**
* โœ… Verified on **Windows + VS Code + Claude Desktop**
* ๐Ÿงช Tested using **Grok's free-tier LLM**

---

## ๐Ÿ“š Citations

* ๐Ÿงฉ EduChain: [https://github.com/satvik314/educhain](https://github.com/satvik314/educhain)
* โš™๏ธ MCP SDK: [https://github.com/modelcontextprotocol/python-sdk](https://github.com/modelcontextprotocol/python-sdk)