Moodle MCP Server

🚀 Moodle MCP Server

An MCP (Model Context Protocol) server that enables Large Language Models (LLMs) to interact with the Moodle platform to manage courses, students, assignments, and quizzes.

🚀 Quick Start

The Moodle MCP Server allows LLMs to interact with the Moodle platform. Here's a quick guide on how to get started.

✨ Features

Student Management Tools

• list_students - Retrieve a list of registered students in a course.
  • Displays each student's ID, name, email address, and last access time.

Assignment Management Tools

• get_assignments - Fetch all available assignments in a course.
  • Includes information such as ID, name, description, due date, and maximum score.
• get_student_submissions - View student submissions for a specific assignment.
  • Requires the assignment ID and an optional student ID.
• provide_assignment_feedback - Provide grading and feedback for a student's submission.
  • Requires the student ID, assignment ID, grade, and feedback comments.

Quiz Management Tools

• get_quizzes - Obtain all available quizzes in a course.
  • Includes information such as ID, name, description, start/end dates, and maximum score.
• get_quiz_attempts - View a student's attempts at a specific quiz.
  • Requires the quiz ID and an optional student ID.
• provide_quiz_feedback - Offer feedback on a quiz attempt.
  • Requires the attempt ID and feedback comments.

📦 Installation

Prerequisites

• Node.js (v14 or higher)
• A Moodle API token with appropriate permissions
• A Moodle course ID

Installation Steps

1. Clone this repository:

git clone https://github.com/your-username/moodle-mcp-server.git
cd moodle-mcp-server

2. Install dependencies:

npm install

3. Create a .env file with the following configuration:

MOODLE_API_URL=https://your-moodle.com/webservice/rest/server.php
MOODLE_API_TOKEN=your_api_token
MOODLE_COURSE_ID=1  # Replace 1 with your course ID

4. Build the server:

npm run build

💻 Usage Examples

Using with Claude

To use the server with Claude Desktop, add the server configuration:

On MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json On Windows: %APPDATA%/Claude/claude_desktop_config.json%

{
  "mcpServers": {
    "moodle-mcp-server": {
      "command": "/path/to/node",
      "args": [
        "/path/to/moodle-mcp-server/build/index.js"
      ],
      "env": {
        "MOODLE_API_URL": "https://your-moodle.com/webservice/rest/server.php",
        "MOODLE_API_TOKEN": "your_moodle_api_token",
        "MOODLE_COURSE_ID": "your_course_id"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

For Windows users, use backslashes in the paths:

{
  "mcpServers": {
    "moodle-mcp-server": {
      "command": "C:\\path\\to\\node.exe",
      "args": [
        "C:\\path\\to\\moodle-mcp-server/build/index.js"
      ],
      "env": {
        "MOODLE_API_URL": "https://your-moodle.com/webservice/rest/server.php",
        "MOODLE_API_TOKEN": "your_moodle_api_token",
        "MOODLE_COURSE_ID": "your_course_id"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

🔧 Technical Details

Development

To start development, follow these steps:

1. Clone this repository.
2. Install dependencies (as described above).
3. Run npm run dev in the terminal to start the development server.

Debugging

To debug, use the MCP Inspector:

npx mcp-inspect .

Visit http://localhost:8090 in your browser to view the documentation.

Security

• Keep your API token secure and do not expose it publicly.
• Use HTTPS to protect communication in a production environment.
• Regularly update the software to prevent security vulnerabilities.

📄 License

This project is licensed under the MIT License. See LICENSE for details.