Skip to main content

MCP server exposing Moodle Web Services to AI assistants (Claude, Cursor, etc.)

Project description

mcp-moodle

An MCP server that exposes Moodle Web Services to any MCP-compatible AI assistant — Claude Code, Claude Desktop, Cursor, Codex, and others.

Ask your assistant things like "what's due this week?", "list my courses", "download the slides from CS101 week 3" — without leaving the chat.

Features

  • site_info — verify the token and get the authenticated user
  • list_my_courses — courses you're enrolled in
  • get_course_contents — sections, modules, file URLs
  • search_courses — search the public catalog
  • list_assignments — assignments across one or all courses
  • list_quizzes — quizzes/QCMs in one or all visible courses
  • get_quiz_qcm_content — rendered QCM questions, readable text, and images
  • upcoming_events — calendar deadlines and sessions
  • get_user_grades — your grades for a course
  • download_file — save any Moodle file locally (token appended automatically)

Works with any Moodle 3.5+ instance that has Web Services enabled.

Install

The recommended way is uv — no virtualenv to manage:

# One-off run (no install)
uvx mcp-moodle

# Or persist as a tool
uv tool install mcp-moodle

Plain pip works too:

pip install mcp-moodle

Update

If you installed with uv tool install, upgrade to the latest published version with:

uv tool upgrade mcp-moodle

If you run it one-off with uvx, force a fresh fetch with:

uvx --refresh mcp-moodle

For pip installs:

pip install -U mcp-moodle

Get a token

Moodle Web Services require a personal token. The package ships a helper that handles every common login flow — native accounts, SSO (Microsoft, Google, SAML, OAuth), or manual paste:

# Default: opens a Chromium window, you complete SSO, token is captured
uvx --from "mcp-moodle[token]" mcp-moodle-token https://moodle.example.org

# Native (non-SSO) account
uvx --from "mcp-moodle[token]" mcp-moodle-token https://moodle.example.org \
  --method local --user jdoe

# Headless server fallback (paste the moodlemobile:// URL by hand)
uvx --from "mcp-moodle[token]" mcp-moodle-token https://moodle.example.org \
  --method manual-mobile

The token is written to ./.env (chmod 600) as MOODLE_URL and MOODLE_TOKEN. Pass --stdout to print it to stdout instead.

The [token] extra pulls in Playwright. First run downloads Chromium (~150 MB, one-time). Skip the extra if you only ever use --method local, --method web, or --method manual-mobile.

Configure your MCP client

Claude Code

claude mcp add moodle \
  --env MOODLE_URL=https://moodle.example.org \
  --env MOODLE_TOKEN=your_token_here \
  -- uvx mcp-moodle

Claude Desktop

Edit ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows):

{
  "mcpServers": {
    "moodle": {
      "command": "uvx",
      "args": ["mcp-moodle"],
      "env": {
        "MOODLE_URL": "https://moodle.example.org",
        "MOODLE_TOKEN": "your_token_here"
      }
    }
  }
}

Cursor / other clients

Any MCP client that supports stdio servers works the same way: command uvx, args ["mcp-moodle"], env MOODLE_URL and MOODLE_TOKEN.

Verify it works

In your MCP client, ask: "call the moodle site_info tool". You should see your name, username, and the site URL.

Quiz / QCM content

Use list_quizzes to find quiz instance ids, then call get_quiz_qcm_content with the quiz id. The tool reuses the latest unfinished attempt when one exists. If no unfinished attempt exists, it returns requires_attempt_creation: true instead of starting an attempt silently; ask the user for permission, then call again with start_if_needed: true.

Each returned question keeps Moodle's raw html and also includes:

  • text — cleaned readable text with formula/image labels from alt/title
  • images — image metadata with the original url and a token-free download_url that can be passed to download_file

download_file automatically converts Moodle pluginfile.php URLs to the token-aware webservice/pluginfile.php form before downloading.

Development

git clone git@github.com:Snaw80/moodle-mcp.git
cd moodle-mcp
uv sync --all-extras
uv run mcp-moodle

Security notes

  • Your token is the equivalent of a password for Moodle Web Services — keep .env out of version control (the included .gitignore already does this).
  • The server reads MOODLE_TOKEN from the environment and never logs it.
  • download_file appends the token to the URL; that URL is not logged either, but be mindful if your client echoes tool arguments.

License

MIT — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_moodle-0.1.2.tar.gz (14.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_moodle-0.1.2-py3-none-any.whl (13.9 kB view details)

Uploaded Python 3

File details

Details for the file mcp_moodle-0.1.2.tar.gz.

File metadata

  • Download URL: mcp_moodle-0.1.2.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mcp_moodle-0.1.2.tar.gz
Algorithm Hash digest
SHA256 b220572afb0a5f32f6a2034b32cda2d7b3350603d76b6e15f8305ff884469c82
MD5 a9bd2b26077b419c2943f4fffe84dc5e
BLAKE2b-256 046301181ac2f98a1745d36de771ec735327142872ebd34c245f50a14d85ba32

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_moodle-0.1.2.tar.gz:

Publisher: release.yml on Snaw80/moodle-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mcp_moodle-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: mcp_moodle-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 13.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mcp_moodle-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f5fe512a7035a040c03ff5e7a3d67cfdc5adf0b9a851965f2cc63f8529d96fa3
MD5 13448439cc47ffdc88b3d9836338fed9
BLAKE2b-256 7a2727478ff241f299a91432d7f84fd4996cbc59367e1155dbc0b4407abccf04

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_moodle-0.1.2-py3-none-any.whl:

Publisher: release.yml on Snaw80/moodle-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page