moodle-mcp 0.1.0__tar.gz

moodle_mcp-0.1.0/PKG-INFO

@@ -0,0 +1,39 @@
+Metadata-Version: 2.4
+Name: moodle-mcp
+Version: 0.1.0
+Summary: A Model Context Protocol (MCP) server implementation that provides capabilities to interact with Moodle LMS.
+Project-URL: Homepage, https://github.com/loyaniu/moodle-mcp
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: glom>=24.11.0
+Requires-Dist: mcp[cli]>=1.6.0
+Requires-Dist: python-dotenv>=1.1.0
+Requires-Dist: requests>=2.32.3
+
+# Moodle-MCP
+
+> A Model Context Protocol (MCP) server implementation that provides capabilities to interact with Moodle LMS.
+>
+> **Warning:** This project is still in development, only some functions are available.
+
+## Features
+
+- [x] Get upcoming events from Moodle
+
+## API Reference
+
+For available Moodle API functions, please refer to the [official documentation](https://docs.moodle.org/dev/Web_service_API_functions).
+
+## Setup Instructions
+
+1. Create your own `.env` file from `.env.example`
+2. Assume you have `uv` installed, run `uv add "mcp[cli]"` to install the MCP CLI tools
+3. Run `mcp install server.py -f .env` to add the moodle-mcp server to Claude app
+
+## Authentication
+
+### Getting your Moodle token
+
+1. Navigate to your Moodle token management page `https://{your-moodle-url}/user/managetoken.php`
+2. Use the token with `Moodle mobile web service` in the `Service` column
+3. Add this token to your `.env` file

moodle_mcp-0.1.0/README.md

@@ -0,0 +1,27 @@
+# Moodle-MCP
+
+> A Model Context Protocol (MCP) server implementation that provides capabilities to interact with Moodle LMS.
+>
+> **Warning:** This project is still in development, only some functions are available.
+
+## Features
+
+- [x] Get upcoming events from Moodle
+
+## API Reference
+
+For available Moodle API functions, please refer to the [official documentation](https://docs.moodle.org/dev/Web_service_API_functions).
+
+## Setup Instructions
+
+1. Create your own `.env` file from `.env.example`
+2. Assume you have `uv` installed, run `uv add "mcp[cli]"` to install the MCP CLI tools
+3. Run `mcp install server.py -f .env` to add the moodle-mcp server to Claude app
+
+## Authentication
+
+### Getting your Moodle token
+
+1. Navigate to your Moodle token management page `https://{your-moodle-url}/user/managetoken.php`
+2. Use the token with `Moodle mobile web service` in the `Service` column
+3. Add this token to your `.env` file

moodle_mcp-0.1.0/pyproject.toml

@@ -0,0 +1,18 @@
+[project]
+name = "moodle-mcp"
+version = "0.1.0"
+description = "A Model Context Protocol (MCP) server implementation that provides capabilities to interact with Moodle LMS."
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "glom>=24.11.0",
+    "mcp[cli]>=1.6.0",
+    "python-dotenv>=1.1.0",
+    "requests>=2.32.3",
+]
+
+[project.scripts]
+moodle-mcp = "moodle_mcp.server:main"
+
+[project.urls]
+Homepage = "https://github.com/loyaniu/moodle-mcp"

moodle_mcp-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

moodle_mcp-0.1.0/src/moodle_mcp/api.py

@@ -0,0 +1,49 @@
+from typing import TypedDict
+
+from glom import glom
+
+from .logger import logger
+from .moodle import APIFunction, get_moodle_api_data
+from .utils import to_json_file
+
+
+class UpcomingEvent(TypedDict):
+    id: int
+    name: str
+    formattedtime: str
+    url: str
+    description: str
+    popupname: str
+
+
+def get_upcoming_events() -> list[UpcomingEvent]:
+    data = get_moodle_api_data(APIFunction.core_calendar_get_calendar_upcoming_view)
+
+    to_json_file(data, "calendar_upcoming_view.json")
+
+    # define the extraction specification to get the required fields
+    upcoming_events_spec = (
+        "events",
+        [
+            {
+                "id": "id",
+                "name": "name",
+                "formattedtime": "formattedtime",
+                "url": "url",
+                "description": "description",
+                "popupname": "popupname",
+            }
+        ],
+    )
+
+    # use glom to extract the data
+    upcoming_events = glom(data, upcoming_events_spec)
+
+    logger.info(f"Extracted {len(upcoming_events)} upcoming events")
+
+    return upcoming_events
+
+
+if __name__ == "__main__":
+    upcoming_events = get_upcoming_events()
+    to_json_file(upcoming_events, "upcoming_events.json")

moodle_mcp-0.1.0/src/moodle_mcp/logger.py

@@ -0,0 +1,9 @@
+import logging
+
+logging.basicConfig(
+    level=logging.INFO,
+    format="%(asctime)s - %(name)s:%(levelname)s - %(message)s",
+    datefmt="%Y-%m-%d %H:%M:%S",
+)
+
+logger = logging.getLogger("moodle-mcp")

moodle_mcp-0.1.0/src/moodle_mcp/moodle.py

@@ -0,0 +1,46 @@
+from enum import Enum
+
+import requests
+from glom import delete
+
+from .logger import logger
+from .utils import getenv
+
+MOODLE_URL = getenv("MOODLE_URL")
+MOODLE_TOKEN = getenv("MOODLE_TOKEN")
+
+
+class APIFunction(Enum):
+    core_calendar_get_calendar_upcoming_view = (
+        "core_calendar_get_calendar_upcoming_view"
+    )
+
+
+# Fields not needed for specific API functions
+# Using `glom` to extract fields not needed
+DELETE_FIELDS = {
+    APIFunction.core_calendar_get_calendar_upcoming_view: [
+        "events.*.course.courseimage"
+    ]
+}
+
+
+def get_moodle_api_data(function: APIFunction, use_original_data=True):
+    params = {
+        "wstoken": MOODLE_TOKEN,
+        "wsfunction": function.value,
+        "moodlewsrestformat": "json",
+    }
+
+    logger.info(f"Getting moodle data for `{function.value}`")
+    rsp = requests.get(MOODLE_URL, params=params)
+
+    data = rsp.json()
+
+    if use_original_data:
+        return data
+
+    for field_path in DELETE_FIELDS.get(function, []):
+        delete(data, field_path)
+
+    return data

moodle_mcp-0.1.0/src/moodle_mcp/server.py

@@ -0,0 +1,17 @@
+from mcp.server.fastmcp import FastMCP
+
+from . import api
+from .logger import logger
+
+mcp = FastMCP("moodle-mcp", dependencies=["glom", "requests"])
+
+
+@mcp.tool()
+def get_upcoming_events() -> list[api.UpcomingEvent]:
+    """Get upcoming events from moodle"""
+    return api.get_upcoming_events()
+
+
+def main():
+    logger.info("Starting moodle-mcp server")
+    mcp.run()

moodle_mcp-0.1.0/src/moodle_mcp/utils.py

@@ -0,0 +1,24 @@
+import json
+import os
+
+from dotenv import load_dotenv
+
+ENV_LOADED = False
+
+
+def to_json_file(data, filename, folder="output"):
+    if not os.path.exists(folder):
+        os.makedirs(folder)
+
+    with open(f"{folder}/{filename}", "w", encoding="utf-8") as f:
+        json.dump(data, f, ensure_ascii=False, indent=4)
+
+
+def getenv(key: str, default: str = None) -> str:
+    global ENV_LOADED
+
+    if not ENV_LOADED:
+        load_dotenv()
+        ENV_LOADED = True
+
+    return os.getenv(key, default)

moodle_mcp-0.1.0/src/moodle_mcp.egg-info/PKG-INFO

@@ -0,0 +1,39 @@
+Metadata-Version: 2.4
+Name: moodle-mcp
+Version: 0.1.0
+Summary: A Model Context Protocol (MCP) server implementation that provides capabilities to interact with Moodle LMS.
+Project-URL: Homepage, https://github.com/loyaniu/moodle-mcp
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: glom>=24.11.0
+Requires-Dist: mcp[cli]>=1.6.0
+Requires-Dist: python-dotenv>=1.1.0
+Requires-Dist: requests>=2.32.3
+
+# Moodle-MCP
+
+> A Model Context Protocol (MCP) server implementation that provides capabilities to interact with Moodle LMS.
+>
+> **Warning:** This project is still in development, only some functions are available.
+
+## Features
+
+- [x] Get upcoming events from Moodle
+
+## API Reference
+
+For available Moodle API functions, please refer to the [official documentation](https://docs.moodle.org/dev/Web_service_API_functions).
+
+## Setup Instructions
+
+1. Create your own `.env` file from `.env.example`
+2. Assume you have `uv` installed, run `uv add "mcp[cli]"` to install the MCP CLI tools
+3. Run `mcp install server.py -f .env` to add the moodle-mcp server to Claude app
+
+## Authentication
+
+### Getting your Moodle token
+
+1. Navigate to your Moodle token management page `https://{your-moodle-url}/user/managetoken.php`
+2. Use the token with `Moodle mobile web service` in the `Service` column
+3. Add this token to your `.env` file

moodle_mcp-0.1.0/src/moodle_mcp.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+README.md
+pyproject.toml
+src/moodle_mcp/__init__.py
+src/moodle_mcp/api.py
+src/moodle_mcp/logger.py
+src/moodle_mcp/moodle.py
+src/moodle_mcp/server.py
+src/moodle_mcp/utils.py
+src/moodle_mcp.egg-info/PKG-INFO
+src/moodle_mcp.egg-info/SOURCES.txt
+src/moodle_mcp.egg-info/dependency_links.txt
+src/moodle_mcp.egg-info/entry_points.txt
+src/moodle_mcp.egg-info/requires.txt
+src/moodle_mcp.egg-info/top_level.txt

moodle_mcp-0.1.0/src/moodle_mcp.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

moodle_mcp-0.1.0/src/moodle_mcp.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+moodle-mcp = moodle_mcp.server:main

moodle_mcp-0.1.0/src/moodle_mcp.egg-info/requires.txt

@@ -0,0 +1,4 @@
+glom>=24.11.0
+mcp[cli]>=1.6.0
+python-dotenv>=1.1.0
+requests>=2.32.3

moodle_mcp-0.1.0/src/moodle_mcp.egg-info/top_level.txt

@@ -0,0 +1 @@
+moodle_mcp