Skip to main content

Monash Study Kit

Type Tech Release PyPI License Access

CI Monash Study Kit MCP server – quality and maintenance score on Glama

English · 中文

Connect Monash Moodle and Ed to Claude, then just ask Claude:

  • "What's due this week?": Moodle deadlines, assignments you may have missed, unfinished Ed lessons, latest announcements
  • "Anything new on Ed? Has anyone replied to my question?"
  • "Which week of FIT2102 covered monads? Which slide deck, which page?"
  • "What does the A2 spec ask for?", "What's my current grade in FIT2109?"

Everything stays on your own computer: course files, login state and the database live locally and never pass through a third-party server. All tools are read-only: they never submit assignments, attempt quizzes or post on Ed.

Built for Monash Malaysia (times are handled as UTC+8); Australian campuses work too, see the FAQ.


Two parts, one codebase

The same core (login, sync, queries) serves two kinds of "users":

MCP: the interface for Claude. Moodle and Ed both sit behind Okta + MFA, so Claude cannot get in by itself. The MCP server lets Claude look things up mid-conversation (tools such as get_study_todo, search_content, list_ed_updates):

  • Answers come from real data: deadlines, announcements and grades are fetched live, with sources such as "Workshop 5 Slides, page 25".
  • Both platforms at once: one "what do I need to do this week" checks Moodle deadlines, unfinished Ed lessons and announcements from both.
  • No manual copying: no downloading PDFs and re-uploading them. Claude finds the right file and reads only the pages it needs, saving time and usage.
  • Natural follow-ups: "What does the A2 spec require?" "Explain that week's functor material using the lecture notes."

CLI (the monash command): the interface for humans.

  1. Things only a person can do: installation, passing MFA in the login window, pasting the Ed token (tokens should never go through a chat, so they are only entered in the terminal).
  2. No AI needed: out of usage or just want a quick look? monash todo answers in a second (see Works without Claude usage).
  3. Troubleshooting and maintenance: status, sync, update, uninstall.

In short: MCP turns Claude into a TA who knows your units; the CLI handles setup, login and fallback. Ask in Claude day to day, open the terminal occasionally.

Requirements

  • Claude Desktop (download) or Claude Code
  • Chrome, Edge or Brave (the Edge that ships with Windows is fine), used to log in to Moodle
  • A Monash account

Installation

macOS

Open Terminal (search "Terminal" in Launchpad) and run these one at a time:

curl -LsSf https://astral.sh/uv/install.sh | sh

After it finishes, close Terminal and open it again, then:

uv tool install monash-study-kit
monash setup

Windows

Open PowerShell (search "PowerShell" in the Start menu) and run these one at a time:

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

After it finishes, close PowerShell and open it again, then:

uv tool install monash-study-kit
monash setup

uv is a Python tool manager. It sets up Python for you, so you don't need to install Python yourself.

First-time setup (monash setup)

Follow the prompts. There are four steps:

  1. Ed: opens Ed's API token page. Click Create Token, name it anything, copy the token and paste it back into the terminal (nothing is shown while pasting; that's normal). The token doesn't expire; delete it on the same page whenever you want to revoke it.
  2. Moodle: opens a separate browser window. Log in to Monash as usual (Okta + MFA). The window closes automatically once you're in. This window has its own profile and is completely isolated from your everyday browser: the tool only takes the Moodle session from this window and never reads anything from your normal browser.
  3. Units: tracks this semester's units by default, or pick your own.
  4. Connect to Claude: adds monash to Claude Desktop and Claude Code automatically.
    • On macOS it quits Claude Desktop first (Claude overwrites config edits made while it is running), then reopens it.
    • On Windows it asks you to fully quit Claude Desktop first: tray icon at the bottom right → right-click → Quit.

At the end you can choose to sync right away. The first sync downloads all course files and takes a few minutes to around a quarter of an hour.

Then open Claude Desktop: under "+" → Connectors in the chat box you'll see monash. Leave it switched on.

Everyday use

Just ask in Claude. While Claude is open, the tool works in the background:

  • syncs Ed and Moodle every hour (new posts, replies, course files) and refreshes the full-text index;
  • refreshes the Moodle session every 20 minutes (Moodle logs you out after 4 idle hours).

Not sure what to ask?

Use your own words: Claude picks tools by meaning, not keywords, so both "anything due this week" and "did I forget to submit something" reach the to-do tool. To see everything it can do:

  • Ask Claude "what can you do", or choose one of monash's preset prompts from the "+" menu: feature overview, this week's to-dos, Ed updates, find a topic, quiz review, grades and feedback. Presets are only sent when you click them, so they cost nothing otherwise.
  • Run monash help in the terminal: every feature with an example question and the matching command.

When the Moodle login expires

After shutdown or a long sleep, the Moodle session expires. Claude will tell you and ask whether to log in. If you agree, it opens the login window on your computer; if Okta still remembers you, it logs in silently without even showing the window. You can also run it yourself:

monash login

While the login is expired, deadlines still work (they come from Moodle's calendar subscription link, which needs no login), and Ed features are unaffected.

Works without Claude usage

The CLI doesn't use AI and consumes no usage. Run monash sync first, then:

I want to know Command
What to do this week monash todo
Deadlines monash due (or monash due FIT2102)
Which file / page covers a topic monash grep "git rebase"
New Ed posts and replies monash ed new
Replies to my own posts monash ed following
Read a full post monash ed show FIT2102#42
Grades / possibly missed assignments monash moodle grades FIT2102 / monash moodle assignments --missing

The difference is that nobody summarises for you; you get the raw information. Background sync and Moodle session refresh run alongside Claude Desktop: while Claude is open they keep running even if your usage is exhausted; if Claude is closed, run monash sync before querying and monash login if Moodle has expired.

Other AI clients

MCP is an open protocol and monash mcp is a standard local (stdio) MCP server, so any client that supports local MCP servers should in principle work. monash setup configures Claude Desktop and Claude Code. For the others, run monash setup first (login and units), then one command:

monash connect            # list clients and whether monash is connected
monash connect cursor     # or codex, vscode, windsurf, gemini

It adds only the monash entry to the client's config file with the full path to the program, keeps everything else, and saves a backup first. Codex is set up with codex mcp add when the codex command exists. --print shows the entry without changing anything, and --remove takes it out again. monash uninstall removes it from every client.

⚠️ The clients below have not been tested end to end. monash connect writes the format from each vendor's official docs (as of 2026-10); the official docs take precedence. Only Claude Desktop and Claude Code have been tested with real use.

To configure a client by hand instead, first find the full path of the monash program (many clients don't inherit your terminal's PATH):

  • macOS: run which monash, usually /Users/<you>/.local/bin/monash
  • Windows: run (Get-Command monash).Source in PowerShell, usually C:\Users\<you>\.local\bin\monash.exe

Replace /full/path/monash in the examples with your path. In JSON, Windows backslashes must be doubled (C:\\Users\\...); in TOML, use single quotes ('C:\Users\...').

Manual configuration

Client Config location Status
Codex CLI / Codex in the ChatGPT desktop app / Codex IDE extension ~/.codex/config.toml (shared by all three) Untested
Cursor ~/.cursor/mcp.json Untested
Windsurf ~/.codeium/windsurf/mcp_config.json Untested
VS Code (Copilot) Command Palette → MCP: Open User Configuration Untested
Gemini CLI ~/.gemini/settings.json Untested
ChatGPT web / mobile app n/a Not supported: only remote servers, cannot reach a program on your computer

Codex (~/.codex/config.toml), or simply run codex mcp add monash -- /full/path/monash mcp:

[mcp_servers.monash]
command = "/full/path/monash"
args = ["mcp"]

Cursor (~/.cursor/mcp.json), Windsurf (~/.codeium/windsurf/mcp_config.json) and Gemini CLI (~/.gemini/settings.json) use the same format:

{
  "mcpServers": {
    "monash": { "command": "/full/path/monash", "args": ["mcp"] }
  }
}

VS Code (mcp.json; note the outer key is servers, not mcpServers):

{
  "servers": {
    "monash": { "type": "stdio", "command": "/full/path/monash", "args": ["mcp"] }
  }
}

If the file already lists other servers, add the monash entry rather than overwriting the whole file. Restart the client afterwards.

Notes:

  • Login and unit selection are still done with monash setup. Without Claude installed, the last step reports "Claude Desktop not found"; just ignore it.
  • Background sync and Moodle session refresh only run while the client is open and the MCP server is running.
  • Tool descriptions are written with Claude in mind. Other models usually follow them fine, but this hasn't been verified.
  • If you'd rather not bother, the CLI works with no AI at all (see Works without Claude usage); you can paste the output of monash todo and friends into any AI.

What can be searched

monash grep and Claude's course-material search cover:

  • Moodle course files (PDF, Word, PowerPoint, text and code)
  • PDFs in Ed Lessons, plus content pages written directly in Ed
  • Course-notes websites: many units publish notes on a lecturer's public site, e.g. tgdwyer.github.io for FIT2102 or yqtian-se.github.io for FIT2109. Pages of this kind linked from Moodle or Ed are fetched, converted to text and stored in the Course notes (web) folder of your course files. Only pages the unit links to directly are fetched (no site-wide crawling), and each page is re-fetched at most once a week. University websites, videos, Google Docs and similar are skipped. To turn it off: monash config web_notes false
  • Lecture-recording transcripts (only with the [media] extra installed)

Privacy and security

  • Where data lives:

    • macOS: ~/Library/Application Support/monash-study-kit
    • Windows: %LOCALAPPDATA%\monash-study-kit

    It contains course files (files), the database (data), login credentials (secrets, readable only by your own user account) and the dedicated login window's profile (browser-profile). Run monash open to open the course-files folder.

  • Stored credentials: the Moodle session cookie, the Ed API token and the Moodle calendar subscription link. They stay on your computer and are only used to talk to Moodle / Ed. Never send the secrets folder to anyone.

  • What Claude can see: only what a tool returns when you ask something (e.g. a list of deadlines, the full text of a post, the text of a course file). Tokens and cookies are never sent to Claude. Don't paste your Ed token into a chat either; it is only entered in the terminal.

  • What it does to Moodle / Ed: read-only. Requests are spaced out, so it never hammers university systems like a crawler.

  • Complete removal:

    monash uninstall
    uv tool uninstall monash-study-kit
    

    monash uninstall removes it from Claude and the other AI clients and asks whether to delete all data. Finally, delete the token on Ed's settings page.

Token use

Every MCP tool's name, description and parameters are sent to Claude at the start of each conversation, so they cost tokens even when unused. Measured with scripts/measure_tokens.py on 1.1.0 (estimate: 4 ASCII characters or 1 Chinese character per token):

Sent once per conversation Tokens
17 tool definitions 2,785
Server instructions 187
Total 2,972

The largest single tool is search_ed_threads at 324.

What the answers cost, measured on one student's real data (4 Moodle units, 3 Ed courses, 376 indexed files) with --live:

Question Tool answer Pasting the files instead
What's due this week (get_study_todo) 3,336
Upcoming deadlines (list_moodle_due) 408
New on Ed (list_ed_updates) 3,934
Find "assignment" in course files (search_content) 2,596 25,466
Read the top hit, first page (read_file) 96 96

"Pasting the files instead" is the full text of every file the search hit. Searching first costs about 10% of that.

To measure your own answers (what a "what's due this week" or a course-file search returns, compared with pasting the whole files), run uv run python scripts/measure_tokens.py --live --query <word>. It prints only numbers. With ANTHROPIC_API_KEY set, --api uses Anthropic's free token-counting endpoint for exact counts.

Command reference

You can also query directly in the terminal without Claude:

Command What it does
monash status Login status, last sync time
monash help Everything it can do, each with an example question and the matching command
monash doctor Health check when something breaks: checks each item and tells you how to fix it; send the whole output to whoever helps you
monash doctor --deep Also fetches from Moodle and Ed and cross-checks the tools against a second source: due dates against the calendar feed, the assignment page against the course structure, synced files against Moodle, search against the files on disk, local Ed posts against Ed. Prints only counts, unit codes, dates and activity ids
monash todo This week: deadlines, possibly missed work, unfinished Ed lessons, announcements, unread replies
monash due [FIT2102] Deadlines
monash grep "monad" [FIT2102] Full-text search over course files, course-notes sites, Ed lesson pages and recording transcripts (with page numbers / timestamps)
monash sync Sync now
monash login / monash login ed Log in to Moodle / replace the Ed token
monash courses Re-pick tracked units
monash open Open the course-files folder
monash moodle grades [FIT2102] Grades and feedback
monash moodle assignments --missing Possibly missed assignments
monash moodle news / find / get / messages / calendar Announcements / find an activity / download one file / messages / calendar subscription link
monash ed new / following / search / show FIT2102#42 Ed updates / new replies to my posts / search / read a post
monash ed lessons FIT2109 / quiz FIT2109 Ed lesson progress / quiz questions (for revision)
monash ed read FIT2109 "W3 Pre-Class" A whole lesson as Markdown: text slides, reading pages and PDFs in order, plus its quiz questions
monash config View / change settings (restart Claude Desktop afterwards)
monash connect [client] Connect to Codex, Cursor, VS Code, Windsurf or Gemini CLI (see Other AI clients)
monash update Update to the latest version

Add --json for JSON output (output is JSON automatically when piped; --text forces text). Every command has --help.

Exit codes (for scripts): 0 success, 1 bad arguments, 2 login required (monash login / monash login ed), 3 cannot reach Moodle/Ed or the server returned an error, 4 unit or post not found, 130 interrupted with Ctrl-C.

Lecture-recording transcripts (optional)

To let Claude know what was said in class, recordings can be turned into timestamped transcripts:

  • YouTube links in Ed "Week N … Recording" posts: YouTube captions are fetched directly, which is fast;
  • Zoom recordings: downloaded with the passcode from the post, then transcribed on your computer with Whisper (a two-hour lecture takes 20–30 minutes on an ordinary laptop).

These dependencies are large (about 1 GB) and not installed by default. To get them, reinstall with [media]:

uv tool install --reinstall "monash-study-kit[media]"

Then run it manually when needed (it never runs in the background, so it won't slow your computer down):

monash media

Videos uploaded directly to Moodle aren't downloaded by default either (often hundreds of MB); they are recorded as links. To download them: monash config download_videos true.

Updating

monash update

Restart Claude Desktop afterwards. On Windows it tells you to quit Claude first and which command to run next (a running program can't be overwritten).

You'll be told when a new version is out: an extra line after terminal commands, and a short mention when you ask Claude for your to-dos. It checks GitHub at most once a day and sends no personal information; to turn it off: monash config update_check false.

FAQ

monash doesn't show up in Claude

Run monash setup claude to reconnect. On Windows, fully quit Claude from the tray first. If it still fails, check for errors under Claude Desktop → Settings → Developer.

The login window won't open / "no browser found"

Install Chrome or Edge. If your browser lives somewhere unusual, point to it: monash config browser "C:\Program Files\...\chrome.exe". If an earlier dedicated login window is still open, close it first.

"Path too long" when syncing course files on Windows

By default Windows limits full paths to 260 characters, and unit name + week name + file name can exceed that. Store course files somewhere shorter: monash config files_dir C:\Monash, then monash sync.

Australian campuses

Moodle shows times in your account's time zone; the default is Malaysia (UTC+8). For Australian campuses: monash config tz_offset 10 (11 during daylight saving).

Where are Ed "assignment deadlines"?

Most Ed lessons have no due date; Moodle is the source of truth for deadlines. The Ed-lesson part of get_study_todo follows your own progress (it lists unfinished lessons up to the week after the one you've reached).

Something is broken

Run monash doctor and follow the → after each item. If you need help, send the whole output; it contains no tokens, cookies or similar. You can also just tell Claude "monash isn't working" and it will run the same checks. The MCP background log is mcp.log in the data directory.

Development

uv sync
uv run pytest
uvx ruff check src tests
uv run monash --help

Releasing: whenever src/ changes, bump __version__ in src/monash_study_kit/__init__.py (patch for bug fixes, minor for new features) and note what changed in CHANGELOG.md. The CI version-bump check blocks PRs that forget it. After merging, push a tag such as v1.1.0: release.yml checks the tag against __version__ and the changelog, runs the tests, builds the package, uploads it to PyPI with Trusted Publishing, installs it back from PyPI on all three OSes, and creates the GitHub release. Details are in docs/releasing.md.

See also CONTRIBUTING.md, SECURITY.md (how to report a problem), docs/security.md (what is protected and how it is tested) and docs/adr (design decisions).

Every PR also builds the wheel, checks what went into it (scripts/check_dist.py) and installs it into a clean venv to run monash --version, monash help and an MCP handshake (scripts/smoke_test.py), so a module left out of the package fails CI instead of failing for users.

How it fits together

flowchart LR
    Claude["Claude Desktop / Claude Code"] -- "stdio (JSON-RPC)" --> MCP["mcp_server"]
    You["You, in a terminal"] --> CLI["cli / cli_ed"]
    MCP --> Core
    CLI --> Core
    subgraph Core["Shared core (runs on your computer)"]
        Jobs["jobs: sync + session refresh"]
        Query["features / edquery / todo"]
        Index["content_index: SQLite FTS5"]
    end
    Core -- "session cookie, read-only" --> Moodle["Moodle"]
    Core -- "API token, read-only" --> Ed["Ed"]
    Core -- "public pages only" --> Notes["Course-notes sites"]
    Login["browser_login + cdp: dedicated login window"] -- "Moodle cookie only" --> Core
Module What it does
moodlelib, htmldom Moodle client (cookie session, AJAX calls, downloads that never send the cookie off-site) and a small HTML tree for page parsing
syncer Mirrors each unit's Moodle files into Unit/Week NN - Title/ folders
features, todo Deadlines (with an iCal fallback when the session has expired), grades, assignments, announcements, the combined to-do list
edlib, edsync, edquery Ed API client, incremental sync of posts and replies, local queries
lessons, lesson_reader Ed Lessons: progress, slides, quiz questions, a whole lesson as Markdown
content_index, textextract, webnotes Full-text search over PDFs, Office files, course-notes websites and transcripts
browser_login, cdp Dedicated login window driven over the Chrome DevTools Protocol (a minimal WebSocket client in the standard library)
jobs, mcp_server, cli Sync and keep-alive jobs, the MCP server, the command line
doctor, doctor_deep, help_menu, update_check, claude_setup Health check and --deep cross-checks, help and preset prompts, new-version notice, adding the server to Claude
recordings, transcribe Optional: lecture recordings to timestamped transcripts ([media] extra)

The only runtime dependency is pypdf; everything else (HTTP, SQLite, WebSocket, HTML parsing) uses the standard library. Tests run on macOS, Windows and Ubuntu with Python 3.10 and 3.13 in CI, and ruff checks for syntax errors, undefined names and unused imports.

License

MIT. This is an independent student-built tool, not affiliated with Monash University, Ed or Anthropic.

Metadata

Release files for monash-study-kit 1.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for monash-study-kit 1.2.0
File Size Uploaded Provenance
monash_study_kit-1.2.0.tar.gz 332.6 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for monash-study-kit 1.2.0
File Interpreter ABI Platform
monash_study_kit-1.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 492.6 kB

Release files / monash_study_kit-1.2.0.tar.gz

Download URL monash_study_kit-1.2.0.tar.gz
Size 332.6 kB
Tags Source
SHA-256 checksum
How to use checksums
e968773d42e2fdd111cf9398536e1da509ebe530b422450dbe7cc0b29d1dfaca
BLAKE2b-256 checksum
How to use checksums
6dda9ae6f17570a966472aacf1f561b90159ec7701f3cbac859a7a601d6104d5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 25, 2026.

Transparency log

Release files / monash_study_kit-1.2.0-py3-none-any.whl

Download URL monash_study_kit-1.2.0-py3-none-any.whl
Size 160.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
184ba48c8eb23564af5741a9a2d5ec298fa17716cc42f0361f4c0c1f1c10387b
BLAKE2b-256 checksum
How to use checksums
5586e0193ef71295639f08d056267fff5985ca7fe9c33c3ffd738d702acc48a8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 25, 2026.

Transparency log

Security for monash-study-kit 1.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for monash_study_kit-1.2.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 25, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.2.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page