Peancor Moodle MCP Server

🚀 Moodle MCP Server

An MCP (Model Context Protocol) server that enables large language models to interact with the Moodle platform for managing courses, students, assignments, and quizzes.

🚀 Quick Start

The Moodle MCP Server is designed to facilitate the interaction between large language models and the Moodle platform. It offers a range of tools for student, assignment, and quiz management.

✨ Features

Student Management Tools

• list_students - Retrieve a list of students enrolled in a course.
  • Displays each student's ID, name, email, 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.
  • Contains information like ID, name, description, start/end dates, and maximum score.
• get_quiz_attempts - Check a student's attempts at a specific quiz.
  • Requires the quiz ID and an optional student ID.
• provide_quiz_feedback - Offer feedback comments on quiz answers.
  • 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

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 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_api_token",
        "MOODLE_COURSE_ID": "1"  # Replace with your course ID
      },
      "autoApprove": true
    }
  }
}

📚 Documentation

Development

• To run the MCP server, refer to the instructions in the README.md file.
• To contribute code or report issues, visit the GitHub repository.

Obtaining an API Token

To get a Moodle API token:

1. Log in to your Moodle administration interface.
2. Navigate to Site administration > Users and permissions > API keys.
3. Create a new API key and use it as MOODLE_API_TOKEN.

Security

⚠️ Important Note

Ensure that you do not expose the API token publicly or share it with unauthorized third - parties.

💡 Usage Tip

Exclude the .env file from version control systems to protect sensitive information.

📄 License

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