monash-study-kit 1.4.0__tar.gz → 1.5.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/CHANGELOG.md +46 -1
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/PKG-INFO +113 -46
- monash_study_kit-1.5.0/PRIVACY.md +72 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/README.md +103 -43
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/README.zh-CN.md +100 -40
- monash_study_kit-1.5.0/docs/adr/0004-confirmed-mail-and-attendance-actions.md +27 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/docs/adr/README.md +2 -1
- monash_study_kit-1.5.0/docs/gmail-foundation.md +171 -0
- monash_study_kit-1.5.0/docs/google-and-attendance-setup.md +177 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/docs/panels-library-remote.md +5 -2
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/docs/releasing.md +1 -1
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/docs/security.md +1 -1
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/pyproject.toml +8 -3
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/skills/monash-study-kit/SKILL.md +8 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/__init__.py +1 -1
- monash_study_kit-1.5.0/src/monash_study_kit/attendance.py +412 -0
- monash_study_kit-1.5.0/src/monash_study_kit/attendance_assets/PROVENANCE.md +4 -0
- monash_study_kit-1.5.0/src/monash_study_kit/attendance_assets/extract-rows.js +109 -0
- monash_study_kit-1.5.0/src/monash_study_kit/attendance_assets/shared.js +736 -0
- monash_study_kit-1.5.0/src/monash_study_kit/attendance_auto.py +116 -0
- monash_study_kit-1.5.0/src/monash_study_kit/attendance_evidence.py +202 -0
- monash_study_kit-1.5.0/src/monash_study_kit/attendance_http.py +442 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/cli.py +61 -12
- monash_study_kit-1.5.0/src/monash_study_kit/cli_attendance.py +62 -0
- monash_study_kit-1.5.0/src/monash_study_kit/cli_gmail.py +173 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/doctor.py +64 -4
- monash_study_kit-1.5.0/src/monash_study_kit/gmail.py +824 -0
- monash_study_kit-1.5.0/src/monash_study_kit/gmail_tools.py +37 -0
- monash_study_kit-1.5.0/src/monash_study_kit/google_client.json +1 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/help_menu.py +50 -4
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/jobs.py +2 -2
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/mcp_server.py +212 -11
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/paths.py +9 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/remote.py +81 -33
- monash_study_kit-1.5.0/src/monash_study_kit/service_actions.py +95 -0
- monash_study_kit-1.5.0/src/monash_study_kit/service_jobs.py +88 -0
- monash_study_kit-1.5.0/src/monash_study_kit/service_setup.py +138 -0
- monash_study_kit-1.5.0/src/monash_study_kit/student_services.py +404 -0
- monash_study_kit-1.5.0/src/monash_study_kit/student_tools.py +228 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/todo.py +3 -1
- monash_study_kit-1.5.0/tests/test_attendance_browser.py +60 -0
- monash_study_kit-1.5.0/tests/test_attendance_fast.py +323 -0
- monash_study_kit-1.5.0/tests/test_attendance_parity.py +85 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_cli.py +4 -0
- monash_study_kit-1.5.0/tests/test_gmail.py +239 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_help_menu.py +4 -1
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_mcp.py +3 -2
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_panels.py +1 -1
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_remote.py +86 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_security.py +6 -3
- monash_study_kit-1.5.0/tests/test_service_setup.py +130 -0
- monash_study_kit-1.5.0/tests/test_student_gmail.py +242 -0
- monash_study_kit-1.5.0/tests/test_student_tools.py +465 -0
- monash_study_kit-1.5.0/tests/test_without_ed.py +45 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/uv.lock +431 -18
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/.github/ISSUE_TEMPLATE/bug_report.yml +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/.github/ISSUE_TEMPLATE/config.yml +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/.github/ISSUE_TEMPLATE/feature_request.yml +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/.github/pull_request_template.md +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/.github/workflows/release.yml +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/.github/workflows/test.yml +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/.gitignore +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/CODE_OF_CONDUCT.md +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/CONTRIBUTING.md +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/LICENSE +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/SECURITY.md +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/docs/adr/0001-one-shared-core.md +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/docs/adr/0002-read-only-public-package.md +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/docs/adr/0003-release-from-a-tag.md +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/docs/screenshots/todo.png +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/glama.json +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/scripts/check_dist.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/scripts/measure_tokens.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/scripts/smoke_test.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/__main__.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/browser_login.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/cdp.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/claude_setup.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/cli_ed.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/clients.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/content_index.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/doctor_deep.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/edlib.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/edquery.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/edsync.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/features.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/htmldom.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/lesson_reader.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/lessons.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/library.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/moodlelib.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/output.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/recordings.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/syncer.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/textextract.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/transcribe.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/ui/panel.html +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/update_check.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/webnotes.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/src/monash_study_kit/widgets.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/conftest.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_cdp.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_clients.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_content_index.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_doctor.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_doctor_deep.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_ed_auth.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_ed_markdown.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_ed_query.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_ed_quiz.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_feature_cli.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_features.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_layout.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_lesson_reader.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_library.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_recordings.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_removed_files.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_setup.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_shared_core.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_skill.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_sync_robustness.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_todo.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_update_check.py +0 -0
- {monash_study_kit-1.4.0 → monash_study_kit-1.5.0}/tests/test_webnotes.py +0 -0
|
@@ -2,7 +2,52 @@
|
|
|
2
2
|
|
|
3
3
|
Version numbers follow `__version__` in `src/monash_study_kit/__init__.py`: patch for bug fixes, minor for new features.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## 1.5.0
|
|
6
|
+
|
|
7
|
+
Optional school mail and attendance. Both are off until you connect them, the core still depends only on pypdf, and Moodle and Ed stay read-only.
|
|
8
|
+
|
|
9
|
+
**Connecting**
|
|
10
|
+
|
|
11
|
+
- Ask your AI app "connect my school email" or "connect my attendance". The new `start_school_service_setup` tool installs what is missing into the running install, opens the sign-in window on your computer and turns everything on, then syncs and tells the AI app its tool list changed. Passwords and codes stay in your browser. The tool adds 145 tokens per conversation and is hidden once both are connected.
|
|
12
|
+
- In a terminal: `uv tool install --reinstall "monash-study-kit[gmail,attendance]"`, then `monash gmail login` and `monash attendance login`.
|
|
13
|
+
- `monash gmail login` uses a Google app that ships with the package, so no Google Cloud project is needed. Google shows "this app isn't verified" (Advanced, then continue). `--client` uses your own app instead. For people who only want to ask about their inbox, the guide suggests the AI apps' built-in Gmail connectors.
|
|
14
|
+
|
|
15
|
+
**School mail** (`[gmail]`)
|
|
16
|
+
|
|
17
|
+
- A private local copy: `monash gmail sync` saves each page with its cursor and prints progress, so an interrupted run keeps what it finished and the next run continues. While your AI app is open, mail syncs every 30 minutes (`gmail_sync_minutes`) and a few attachments per round are indexed.
|
|
18
|
+
- `monash gmail todo` and `get_gmail_inbox_todo` list recent unread inbox mail without promotions and social updates. Search results carry the date, unread, inbox, starred, important, category and attachment count. `gmail_read_attachment` reads PDF, Office and image attachments.
|
|
19
|
+
- Drafting, sending a draft and changing labels (archive, mark as read, star) are on after login. Every action returns a full preview and a single-use ticket bound to that payload, and runs only after you confirm that exact action. Nothing permanently deletes mail. `monash gmail login --read-only` asks Google for read access only. See [ADR 0004](docs/adr/0004-confirmed-mail-and-attendance-actions.md).
|
|
20
|
+
- The server instructions tell the AI app to use this for questions about "my email" instead of a general Gmail connector.
|
|
21
|
+
|
|
22
|
+
**Attendance** (`[attendance]`)
|
|
23
|
+
|
|
24
|
+
- `monash attendance login`, `status`, `sync`, `overview`, `codes` and `probe`, and matching tools in the AI app: classes and check-in status from the portal, and candidate codes found in synced Moodle, Ed and school mail, each with its source.
|
|
25
|
+
- A read is one plain request with the saved login (about 5 KB, a few seconds) and a Python port of the extension's parser. On the Malaysia portal it matched the browser read on all 15 days the portal offers. It falls back to a single headless browser page whenever the page looks different or the certificate cannot be verified, and HTTPS is checked with the system certificate store (`truststore`).
|
|
26
|
+
- Reads follow your timetable: weekday mornings at 8 and 15 minutes after each class you have not checked in to, nothing at night, at weekends or for finished classes (`attendance_auto_sync`).
|
|
27
|
+
- Check-in is on after login and is prepared only when you say you attended, with the same preview and confirmation as mail.
|
|
28
|
+
- `monash attendance status` records how long the login lasts. An optional lightweight keepalive (`attendance_keepalive_minutes`) is off until that is known.
|
|
29
|
+
- Checked only against the Malaysia campus portal; `MONASH_ATTENDANCE_ORIGIN` and `MONASH_ATTENDANCE_TZ` point it elsewhere.
|
|
30
|
+
|
|
31
|
+
**Remote MCP**
|
|
32
|
+
|
|
33
|
+
- Each app chooses on the pairing page which mail and attendance features it may use. Only features turned on on the server are offered; read-only ones start ticked, actions unticked. The choice is kept on refresh, checked against the server settings at every call and shown by `monash remote clients`. Apps paired before 1.5.0 keep Moodle and Ed only. Tickets and background jobs belong to one app.
|
|
34
|
+
|
|
35
|
+
**Other changes**
|
|
36
|
+
|
|
37
|
+
- Units without Ed: `monash config use_ed false`, or answering yes in `monash setup` after skipping the Ed token, stops the reminders about a missing token and hides the Ed tools and help.
|
|
38
|
+
- `monash update` keeps every installed extra (`gmail`, `attendance`, `media`).
|
|
39
|
+
- `monash status` and `monash doctor` cover mail and attendance once they are on; doctor output never shows the mail address.
|
|
40
|
+
- `monash help` and the help prompt list mail and attendance once connected, and suggest connecting them until then.
|
|
41
|
+
- The agent skill lists the mail and attendance commands and the rule that `--confirm` comes only after the student confirms the preview.
|
|
42
|
+
- Token use: 3,377 per conversation by default (3,232 in 1.4.1), 5,132 with mail and attendance connected.
|
|
43
|
+
- Docs: setup guide in [docs/google-and-attendance-setup.md](docs/google-and-attendance-setup.md) (Chinese), design notes in [docs/gmail-foundation.md](docs/gmail-foundation.md), privacy policy in [PRIVACY.md](PRIVACY.md).
|
|
44
|
+
|
|
45
|
+
Not verified yet: attendance check-in on a real account, how long the attendance login lasts, the keepalive, and portals of campuses other than Malaysia.
|
|
46
|
+
|
|
47
|
+
## 1.4.1
|
|
48
|
+
|
|
49
|
+
- `monash --help` now lists `monash library` and `monash remote` in its summary at the top. They were already in the subcommand list below.
|
|
50
|
+
- The real Chromium pipe test waits longer for google-chrome to start on CI.
|
|
6
51
|
|
|
7
52
|
## 1.4.0
|
|
8
53
|
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
Metadata-Version: 2.5
|
|
2
2
|
Name: monash-study-kit
|
|
3
|
-
Version: 1.
|
|
4
|
-
Summary: Connect Monash Moodle and Ed to Claude via a local MCP server and CLI: deadlines, announcements, grades, full-text search over course materials and Ed posts, all on your own machine.
|
|
3
|
+
Version: 1.5.0
|
|
4
|
+
Summary: Connect Monash Moodle and Ed to Claude, Codex, Cursor or any local MCP client via a local MCP server and CLI: deadlines, announcements, grades, full-text search over course materials and Ed posts, all on your own machine.
|
|
5
5
|
Project-URL: Homepage, https://github.com/Waldo0926/monash-study-kit
|
|
6
6
|
Project-URL: Issues, https://github.com/Waldo0926/monash-study-kit/issues
|
|
7
7
|
Project-URL: Changelog, https://github.com/Waldo0926/monash-study-kit/blob/main/CHANGELOG.md
|
|
8
8
|
Author: Waldo
|
|
9
9
|
License-Expression: MIT
|
|
10
10
|
License-File: LICENSE
|
|
11
|
-
Keywords: claude,cli,edstem,mcp,model-context-protocol,monash,moodle,study-tools
|
|
11
|
+
Keywords: claude,cli,codex,cursor,edstem,mcp,model-context-protocol,monash,moodle,study-tools
|
|
12
12
|
Classifier: Development Status :: 5 - Production/Stable
|
|
13
13
|
Classifier: Environment :: Console
|
|
14
14
|
Classifier: Intended Audience :: Education
|
|
@@ -21,6 +21,13 @@ Classifier: Programming Language :: Python :: 3.13
|
|
|
21
21
|
Classifier: Topic :: Education
|
|
22
22
|
Requires-Python: >=3.10
|
|
23
23
|
Requires-Dist: pypdf>=4.0
|
|
24
|
+
Provides-Extra: attendance
|
|
25
|
+
Requires-Dist: pillow<13,>=10; extra == 'attendance'
|
|
26
|
+
Requires-Dist: playwright<2,>=1.49; extra == 'attendance'
|
|
27
|
+
Requires-Dist: truststore<1,>=0.10; extra == 'attendance'
|
|
28
|
+
Requires-Dist: tzdata; (sys_platform == 'win32') and extra == 'attendance'
|
|
29
|
+
Provides-Extra: gmail
|
|
30
|
+
Requires-Dist: google-auth-oauthlib<2,>=1.2; extra == 'gmail'
|
|
24
31
|
Provides-Extra: media
|
|
25
32
|
Requires-Dist: deno>=2.0; extra == 'media'
|
|
26
33
|
Requires-Dist: faster-whisper>=1.0; extra == 'media'
|
|
@@ -41,21 +48,22 @@ Description-Content-Type: text/markdown
|
|
|
41
48
|
|
|
42
49
|
**English** · [中文](README.zh-CN.md)
|
|
43
50
|
|
|
44
|
-
Connect Monash **Moodle** and **Ed** to Claude, then just ask
|
|
51
|
+
Connect Monash **Moodle** and **Ed** to the AI app on your computer (Claude, Codex, Cursor, VS Code and others), then just ask:
|
|
45
52
|
|
|
46
53
|
- "What's due this week?": Moodle deadlines, assignments you may have missed, unfinished Ed lessons, latest announcements
|
|
47
54
|
- "Anything new on Ed? Has anyone replied to my question?"
|
|
48
55
|
- "Which week of FIT2102 covered monads? Which slide deck, which page?"
|
|
49
56
|
- "What does the A2 spec ask for?", "What's my current grade in FIT2109?"
|
|
57
|
+
- "Quiz me on FIT2109 week 3." In apps that support MCP Apps, to-dos, lesson progress and quiz questions also show up as small panels you can click
|
|
50
58
|
|
|
51
59
|
By default, everything stays **on your own computer**: course files, login state and the database live locally and never pass through a third-party server.
|
|
52
|
-
All tools are **read-only**: they never submit assignments, attempt quizzes or post on Ed.
|
|
60
|
+
All Moodle and Ed tools are **read-only**: they never submit assignments, attempt quizzes or post on Ed. The optional school mail and attendance parts can draft mail, change labels or check you in, and only after you confirm each action.
|
|
53
61
|
|
|
54
62
|
Built for Monash Malaysia (times are handled as UTC+8); Australian campuses work too, see the [FAQ](#faq).
|
|
55
63
|
|
|
56
64
|

|
|
57
65
|
|
|
58
|
-
The picture is real output of `monash todo` against a database filled with made-up units, files and posts.
|
|
66
|
+
The picture is real output of `monash todo` against a database filled with made-up units, files and posts. Your AI app reads the same data through the MCP tools. Guide with more pictures: [docs.secureview.tech/study-kit](https://docs.secureview.tech/study-kit/).
|
|
59
67
|
|
|
60
68
|
---
|
|
61
69
|
|
|
@@ -63,25 +71,25 @@ The picture is real output of `monash todo` against a database filled with made-
|
|
|
63
71
|
|
|
64
72
|
The same core (login, sync, queries) serves two kinds of "users":
|
|
65
73
|
|
|
66
|
-
**MCP: the interface for
|
|
67
|
-
The MCP server lets
|
|
74
|
+
**MCP: the interface for your AI app.** Moodle and Ed both sit behind Okta + MFA, so the AI cannot get in by itself.
|
|
75
|
+
The MCP server lets it look things up mid-conversation (tools such as `get_study_todo`, `search_content`, `list_ed_updates`):
|
|
68
76
|
|
|
69
77
|
- **Answers come from real data**: deadlines, announcements and grades are fetched live, with sources such as "Workshop 5 Slides, page 25".
|
|
70
78
|
- **Both platforms at once**: one "what do I need to do this week" checks Moodle deadlines, unfinished Ed lessons and announcements from both.
|
|
71
|
-
- **No manual copying**: no downloading PDFs and re-uploading them.
|
|
79
|
+
- **No manual copying**: no downloading PDFs and re-uploading them. The AI finds the right file and reads only the pages it needs, saving time and usage.
|
|
72
80
|
- **Natural follow-ups**: "What does the A2 spec require?" "Explain that week's functor material using the lecture notes."
|
|
73
81
|
|
|
74
82
|
**CLI (the `monash` command): the interface for humans.**
|
|
75
83
|
|
|
76
84
|
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).
|
|
77
|
-
2. **No AI needed**: out of usage or just want a quick look? `monash todo` answers in a second (see [Works without
|
|
85
|
+
2. **No AI needed**: out of usage or just want a quick look? `monash todo` answers in a second (see [Works without AI usage](#works-without-ai-usage)).
|
|
78
86
|
3. **Troubleshooting and maintenance**: `status`, `sync`, `update`, `uninstall`.
|
|
79
87
|
|
|
80
|
-
In short: MCP turns
|
|
88
|
+
In short: MCP turns your AI app into a TA who knows your units; the CLI handles setup, login and fallback. Ask in your AI app day to day, open the terminal occasionally.
|
|
81
89
|
|
|
82
90
|
## Requirements
|
|
83
91
|
|
|
84
|
-
- **Claude Desktop** ([download](https://claude.ai/download)) or **Claude Code**
|
|
92
|
+
- An AI app that supports local MCP: **Claude Desktop** ([download](https://claude.ai/download)) or **Claude Code** are set up automatically; **Codex** (including Codex in the ChatGPT desktop app), **Cursor**, **VS Code**, **Windsurf** and **Gemini CLI** take one more command (see [Other AI clients](#other-ai-clients))
|
|
85
93
|
- **Chrome, Edge or Brave** (the Edge that ships with Windows is fine), used to log in to Moodle
|
|
86
94
|
- A Monash account
|
|
87
95
|
|
|
@@ -149,42 +157,53 @@ Follow the prompts. There are four steps:
|
|
|
149
157
|
This window has its own profile and is completely isolated from your everyday browser: the tool only takes the Moodle session from this window
|
|
150
158
|
and never reads anything from your normal browser.
|
|
151
159
|
3. **Units**: tracks this semester's units by default, or pick your own.
|
|
152
|
-
4. **Connect
|
|
160
|
+
4. **Connect your AI app**: adds `monash` to Claude Desktop and Claude Code automatically.
|
|
153
161
|
- On macOS it quits Claude Desktop first (Claude overwrites config edits made while it is running), then reopens it.
|
|
154
162
|
- On Windows it asks you to **fully quit** Claude Desktop first: tray icon at the bottom right → right-click → Quit.
|
|
163
|
+
- Using Codex, Cursor, VS Code, Windsurf or Gemini CLI? If this step says Claude Desktop is not found, ignore it. After setup, run `monash connect codex` (or `cursor`, `vscode`, `windsurf`, `gemini`) and restart that app.
|
|
155
164
|
|
|
156
165
|
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.
|
|
157
166
|
|
|
158
|
-
Then open Claude Desktop
|
|
167
|
+
Then open your AI app. In Claude Desktop, **"+" → Connectors** in the chat box lists **monash**; leave it switched on. For other apps, `monash connect` shows which ones are connected.
|
|
159
168
|
|
|
160
|
-
##
|
|
169
|
+
## What's new in 1.5
|
|
161
170
|
|
|
162
|
-
- **
|
|
163
|
-
- **
|
|
164
|
-
- **
|
|
165
|
-
- **
|
|
171
|
+
- **School mail (optional).** Ask "anything in my email I need to deal with?" and get recent unread school mail, offline search, whole threads and attachment text. The AI can draft a reply, send a draft or archive mail, and only after you confirm each action.
|
|
172
|
+
- **Attendance (optional).** "Which classes this week haven't I checked in to?" and "what's the code for today's workshop?", with each code's source. Reads follow your timetable and take a few seconds without opening a browser. Checked against the Malaysia campus portal.
|
|
173
|
+
- **No terminal needed to connect them.** Say "connect my school email" or "connect my attendance" in your AI app; it installs what is missing and opens the sign-in window. No Google Cloud setup either.
|
|
174
|
+
- **Remote apps choose.** With `monash remote`, each app you pair ticks which of these it may use.
|
|
175
|
+
- **Units without Ed** can turn Ed off: `monash config use_ed false`.
|
|
166
176
|
|
|
167
|
-
|
|
177
|
+
Details: [Optional: Gmail and attendance](#optional-gmail-and-attendance) and the [changelog](CHANGELOG.md).
|
|
178
|
+
|
|
179
|
+
## What's new in 1.4
|
|
180
|
+
|
|
181
|
+
- **Study panels.** In apps that support MCP Apps, "what do I need to do this week", "show my FIT2109 lesson progress" and "help me practise the week 3 quiz" also come with a small panel: deadline cards, lesson progress by module, and quiz questions you can click through. When you finish a quiz, the **交给 AI 批改** button sends your choices back to the chat and the AI explains them from the lesson. Nothing is submitted to Ed. Apps without panels still get the same text answers as before.
|
|
182
|
+
- **Find a Moodle activity by name.** "Where is the week 7 workshop on Moodle?" now works through the new `search_moodle_activities` tool. It needs a Moodle login.
|
|
183
|
+
- **Browse your files without AI.** `monash library --open` opens a page in your browser with every Moodle and Ed lesson file you have synced. Filter by unit, week or name and download the original. It only listens on `127.0.0.1`, so other devices cannot open it.
|
|
184
|
+
- **Optional remote access.** `monash remote serve` lets ChatGPT, or Claude on the web and phone, reach your own data over HTTPS. Use your own server and domain, or try it with a free Cloudflare quick tunnel on your own computer, which needs no account and no domain. Each app pairs with a one-time code from your terminal, and only the 16 read-only query tools are exposed. Nothing starts unless you run it. Steps are on [Host it yourself](https://docs.secureview.tech/study-kit/remote/).
|
|
185
|
+
|
|
186
|
+
1.4.1 adds `library` and `remote` to the summary at the top of `monash --help`. Everyday use on your own computer still needs no server, domain or extra account. Technical notes: [docs/panels-library-remote.md](docs/panels-library-remote.md).
|
|
168
187
|
|
|
169
188
|
## Everyday use
|
|
170
189
|
|
|
171
|
-
Just ask in
|
|
190
|
+
Just ask in your AI app. While it is open, the tool works in the background:
|
|
172
191
|
|
|
173
192
|
- syncs Ed and Moodle every hour (new posts, replies, course files) and refreshes the full-text index;
|
|
174
193
|
- refreshes the Moodle session every 20 minutes (Moodle logs you out after 4 idle hours).
|
|
175
194
|
|
|
176
195
|
### Not sure what to ask?
|
|
177
196
|
|
|
178
|
-
Use your own words:
|
|
197
|
+
Use your own words: the AI picks tools by meaning, not keywords, so both "anything due this week" and "did I forget to submit something" reach the to-do tool.
|
|
179
198
|
To see everything it can do:
|
|
180
199
|
|
|
181
|
-
- Ask
|
|
200
|
+
- Ask your AI "what can you do". In Claude you can also pick one of monash's preset prompts from the **"+" menu** (other apps show MCP prompts in their own place, or not at all): feature overview, this week's to-dos,
|
|
182
201
|
Ed updates, find a topic, quiz review, assignment requirements, grades and feedback. Presets are only sent when you click them, so they cost nothing otherwise.
|
|
183
202
|
- Run `monash help` in the terminal: every feature with an example question and the matching command.
|
|
184
203
|
|
|
185
204
|
### When the Moodle login expires
|
|
186
205
|
|
|
187
|
-
After shutdown or a long sleep, the Moodle session expires.
|
|
206
|
+
After shutdown or a long sleep, the Moodle session expires. The AI will tell you and ask whether to log in.
|
|
188
207
|
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.
|
|
189
208
|
You can also run it yourself:
|
|
190
209
|
|
|
@@ -194,7 +213,7 @@ monash login
|
|
|
194
213
|
|
|
195
214
|
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.
|
|
196
215
|
|
|
197
|
-
### Works without
|
|
216
|
+
### Works without AI usage
|
|
198
217
|
|
|
199
218
|
The CLI doesn't use AI and consumes no usage. Run `monash sync` first, then:
|
|
200
219
|
|
|
@@ -208,8 +227,8 @@ The CLI doesn't use AI and consumes no usage. Run `monash sync` first, then:
|
|
|
208
227
|
| Read a full post | `monash ed show FIT2102#42` |
|
|
209
228
|
| Grades / possibly missed assignments | `monash moodle grades FIT2102` / `monash moodle assignments --missing` |
|
|
210
229
|
|
|
211
|
-
The difference is that nobody summarises for you; you get the raw information. Background sync and Moodle session refresh run
|
|
212
|
-
|
|
230
|
+
The difference is that nobody summarises for you; you get the raw information. Background sync and Moodle session refresh run while your AI app is open, because that is when the MCP server runs:
|
|
231
|
+
they keep running even if your usage is exhausted; if the app is closed, run `monash sync` before querying and `monash login` if Moodle has expired.
|
|
213
232
|
|
|
214
233
|
## Other AI clients
|
|
215
234
|
|
|
@@ -223,9 +242,9 @@ monash connect cursor # or codex, vscode, windsurf, gemini
|
|
|
223
242
|
|
|
224
243
|
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.
|
|
225
244
|
|
|
226
|
-
> **Verified:** Claude Desktop and Claude Code with the local server
|
|
245
|
+
> **Verified:** Claude Desktop and Claude Code with the local server. ChatGPT and Codex through a private remote integration on the v1.3.0 core: on 30 October 2026 Codex queried Moodle and Ed courses and ChatGPT's course query was confirmed. ChatGPT Plus works with the author's own domain and server.
|
|
227
246
|
>
|
|
228
|
-
>
|
|
247
|
+
> On 30 October 2026 the 1.4.0 package from PyPI was also checked in a clean environment with made-up data: the stdio handshake, the 18-tool catalog, the three panels, `monash library`, and the whole `monash remote` sign-in and query flow using the Claude and ChatGPT callback addresses. None of this covers the native local Codex, Cursor, VS Code, Windsurf or Gemini CLI connections. `monash connect` writes the format from each vendor's official docs (as of 2026-10); the official docs take precedence.
|
|
229
248
|
|
|
230
249
|
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):
|
|
231
250
|
|
|
@@ -244,7 +263,7 @@ Replace `/full/path/monash` in the examples with your path. **In JSON, Windows b
|
|
|
244
263
|
| Windsurf | `~/.codeium/windsurf/mcp_config.json` | Untested |
|
|
245
264
|
| VS Code (Copilot) | Command Palette → `MCP: Open User Configuration` | Untested |
|
|
246
265
|
| Gemini CLI | `~/.gemini/settings.json` | Untested |
|
|
247
|
-
| ChatGPT web / mobile app |
|
|
266
|
+
| ChatGPT, Claude web / mobile app | `monash remote serve` behind your own domain or a Cloudflare quick tunnel | ChatGPT Plus works with the author's domain; see [Host it yourself](https://docs.secureview.tech/study-kit/remote/) |
|
|
248
267
|
|
|
249
268
|
Codex (`~/.codex/config.toml`), or simply run `codex mcp add monash -- /full/path/monash mcp`:
|
|
250
269
|
|
|
@@ -281,7 +300,7 @@ If the file already lists other servers, add the `monash` entry rather than over
|
|
|
281
300
|
- Login and unit selection are still done with `monash setup`. Without Claude installed, the last step reports "Claude Desktop not found"; just ignore it.
|
|
282
301
|
- Background sync and Moodle session refresh only run while the client is open and the MCP server is running.
|
|
283
302
|
- Tool descriptions are written with Claude in mind. Other models usually follow them fine, but this hasn't been verified.
|
|
284
|
-
- If you'd rather not bother, the CLI works with no AI at all (see [Works without
|
|
303
|
+
- If you'd rather not bother, the CLI works with no AI at all (see [Works without AI usage](#works-without-ai-usage)); you can paste the output of `monash todo` and friends into any AI.
|
|
285
304
|
|
|
286
305
|
### Agent skill
|
|
287
306
|
|
|
@@ -295,7 +314,7 @@ The file is [`skills/monash-study-kit/SKILL.md`](skills/monash-study-kit/SKILL.m
|
|
|
295
314
|
|
|
296
315
|
### What can be searched
|
|
297
316
|
|
|
298
|
-
`monash grep` and
|
|
317
|
+
`monash grep` and the AI's course-material search cover:
|
|
299
318
|
|
|
300
319
|
- Moodle course files (PDF, Word, PowerPoint, text and code)
|
|
301
320
|
- PDFs in Ed Lessons, plus content pages written directly in Ed
|
|
@@ -315,8 +334,10 @@ The file is [`skills/monash-study-kit/SKILL.md`](skills/monash-study-kit/SKILL.m
|
|
|
315
334
|
Run `monash open` to open the course-files folder.
|
|
316
335
|
- **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.
|
|
317
336
|
**Never send the `secrets` folder to anyone.**
|
|
318
|
-
- **What
|
|
319
|
-
Tokens and cookies are never sent to
|
|
337
|
+
- **What the AI 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).
|
|
338
|
+
Tokens and cookies are never sent to the AI. **Don't paste your Ed token into a chat either**; it is only entered in the terminal.
|
|
339
|
+
- **Course library page**: `monash library` only listens on `127.0.0.1` and only serves files that sync registered. It has no password, so don't forward it to the internet.
|
|
340
|
+
- **Optional remote mode**: `monash remote` keeps the apps you paired in `secrets/remote-mcp.db`, storing only hashes of their tokens. Access tokens last an hour, refresh tokens 30 days and change on every use. `monash remote revoke --all` cuts every app off.
|
|
320
341
|
- **What it does to Moodle / Ed**: read-only. Requests are spaced out, so it never hammers university systems like a crawler.
|
|
321
342
|
- **Complete removal**:
|
|
322
343
|
|
|
@@ -329,13 +350,15 @@ The file is [`skills/monash-study-kit/SKILL.md`](skills/monash-study-kit/SKILL.m
|
|
|
329
350
|
|
|
330
351
|
## Token use
|
|
331
352
|
|
|
332
|
-
Every MCP tool's name, description and parameters are sent to
|
|
353
|
+
Every MCP tool's name, description and parameters are sent to the model at the start of each conversation, so they cost tokens even when unused. Measured with `scripts/measure_tokens.py` on 1.5.0 (estimate: 4 ASCII characters or 1 Chinese character per token):
|
|
333
354
|
|
|
334
355
|
| Sent once per conversation | Tokens |
|
|
335
356
|
| --- | ---: |
|
|
336
|
-
|
|
|
357
|
+
| 19 tool definitions | 3,107 |
|
|
337
358
|
| Server instructions | 270 |
|
|
338
|
-
| **Total** | **3,
|
|
359
|
+
| **Total** | **3,377** |
|
|
360
|
+
|
|
361
|
+
1.5.0 added `start_school_service_setup` (145), which lets you connect school mail or attendance by asking your AI app. It is hidden again once both are connected; with both connected the total is 5,132. In 1.4.0 the total was 3,232.
|
|
339
362
|
|
|
340
363
|
The instructions grew from 187 in 1.2.0 when the rule for assignment questions was added (brief and rubric first, then staff answers on Ed).
|
|
341
364
|
|
|
@@ -357,7 +380,7 @@ To measure your own answers (what a "what's due this week" or a course-file sear
|
|
|
357
380
|
|
|
358
381
|
## Command reference
|
|
359
382
|
|
|
360
|
-
You can also query directly in the terminal without
|
|
383
|
+
You can also query directly in the terminal without any AI:
|
|
361
384
|
|
|
362
385
|
| Command | What it does |
|
|
363
386
|
|---|---|
|
|
@@ -372,14 +395,18 @@ You can also query directly in the terminal without Claude:
|
|
|
372
395
|
| `monash login` / `monash login ed` | Log in to Moodle / replace the Ed token |
|
|
373
396
|
| `monash courses` | Re-pick tracked units |
|
|
374
397
|
| `monash open` | Open the course-files folder |
|
|
398
|
+
| `monash library [--open]` | Browse and download synced files in your browser (only on this computer) |
|
|
375
399
|
| `monash moodle grades [FIT2102]` | Grades and feedback |
|
|
376
400
|
| `monash moodle assignments --missing` | Possibly missed assignments |
|
|
377
401
|
| `monash moodle news` / `find` / `get` / `messages` / `calendar` | Announcements / find an activity / download one file / messages / calendar subscription link |
|
|
378
402
|
| `monash ed new` / `following` / `search` / `show FIT2102#42` | Ed updates / new replies to my posts / search / read a post |
|
|
379
403
|
| `monash ed lessons FIT2109` / `quiz FIT2109` | Ed lesson progress / quiz questions (for revision) |
|
|
380
404
|
| `monash ed read FIT2109 "W3 Pre-Class"` | A whole lesson as Markdown: text slides, reading pages and PDFs in order, plus its quiz questions |
|
|
381
|
-
| `monash config` | View / change settings (restart
|
|
405
|
+
| `monash config` | View / change settings (restart your AI app afterwards) |
|
|
382
406
|
| `monash connect [client]` | Connect to Codex, Cursor, VS Code, Windsurf or Gemini CLI (see [Other AI clients](#other-ai-clients)) |
|
|
407
|
+
| `monash remote serve` / `pair` / `clients` / `revoke` | Optional remote MCP for ChatGPT and Claude on the web ([Host it yourself](https://docs.secureview.tech/study-kit/remote/)) |
|
|
408
|
+
| `monash gmail todo` / `sync` / `search` / `thread` | Optional school Gmail: unread inbox mail / sync / offline search / read a thread ([setup](#optional-gmail-and-attendance)) |
|
|
409
|
+
| `monash attendance login` / `status` / `sync` / `overview` / `codes` | Optional attendance: log in / status / read the portal / saved classes / find check-in codes |
|
|
383
410
|
| `monash update` | Update to the latest version |
|
|
384
411
|
|
|
385
412
|
Add `--json` for JSON output (output is JSON automatically when piped; `--text` forces text). Every command has `--help`.
|
|
@@ -389,7 +416,7 @@ Exit codes (for scripts): 0 success, 1 bad arguments, 2 login required (`monash
|
|
|
389
416
|
|
|
390
417
|
## Lecture-recording transcripts (optional)
|
|
391
418
|
|
|
392
|
-
To let
|
|
419
|
+
To let your AI know what was said in class, recordings can be turned into timestamped transcripts:
|
|
393
420
|
|
|
394
421
|
- **YouTube** links in Ed "Week N … Recording" posts: YouTube captions are fetched directly, which is fast;
|
|
395
422
|
- **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).
|
|
@@ -408,24 +435,53 @@ monash media
|
|
|
408
435
|
|
|
409
436
|
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`.
|
|
410
437
|
|
|
438
|
+
## Optional: Gmail and attendance
|
|
439
|
+
|
|
440
|
+
New in 1.5.0. Both parts are off until you connect them and only run on your own computer.
|
|
441
|
+
|
|
442
|
+
- **School Gmail.** Keeps a private copy of your Monash mailbox. Ask "anything in my email I need to deal with?" and the AI lists recent unread school mail (promotions and social updates left out), searches it offline, reads whole threads and the text of attachments (PDF, Office, images). Reading never marks mail as read.
|
|
443
|
+
- **Attendance.** Reads your classes and check-in status from the attendance portal, so you can ask "which classes this week haven't I checked in to?" or "what's the code for today's FIT2102 workshop?". Codes are looked up in synced Moodle, Ed and school mail and shown with where they came from, for you to check. Only checked against the Malaysia campus portal.
|
|
444
|
+
|
|
445
|
+
If you only want to ask about your inbox in Claude or ChatGPT, their built-in Gmail connectors are the easiest way. The Gmail part here is for linking mail with attendance codes, searching mail and attachments offline, and using it in apps without a Gmail connector such as Codex or Cursor. No Google Cloud setup is needed: the package includes a Google app, and Google will show "this app isn't verified" (click Advanced, then continue). Using your own Google app instead is optional. The step-by-step guide (in Chinese) is [docs/google-and-attendance-setup.md](docs/google-and-attendance-setup.md); what is accessed and stored is in [PRIVACY.md](PRIVACY.md). The easiest way is to ask your AI app: "connect my school email" or "connect my attendance". It installs what is missing, opens the sign-in window on your computer, and you only sign in; nothing is typed in a terminal and no password goes into the chat. The same steps in a terminal:
|
|
446
|
+
|
|
447
|
+
```bash
|
|
448
|
+
uv tool install --reinstall "monash-study-kit[gmail,attendance]"
|
|
449
|
+
monash gmail login
|
|
450
|
+
monash gmail sync
|
|
451
|
+
monash attendance login
|
|
452
|
+
monash attendance sync
|
|
453
|
+
```
|
|
454
|
+
|
|
455
|
+
Restart your AI app after logging in. While it is open, mail syncs in the background every 30 minutes (`monash config gmail_sync_minutes`, 0 turns it off); `monash gmail sync` updates it right away. Attendance follows your timetable instead of the clock: once on weekday mornings at 8 and 15 minutes after each class you have not checked in to yet, so nothing runs at night, at weekends or between classes (`monash config attendance_auto_sync false` turns it off). You or the AI can also ask for a read any time. A read is one plain request to the portal (about 5 KB, a few seconds, no browser); if the page ever looks different from what is expected it falls back to one headless browser page. On the Malaysia portal both ways gave the same result for all 15 days the portal offers, and `monash attendance probe` repeats that check on yours. `monash status` and `monash doctor` show both parts once they are on, and `monash update` keeps the extras you installed.
|
|
456
|
+
|
|
457
|
+
Logging in turns everything on in your AI app, including drafting, sending a draft, changing labels (archive, mark as read, star) and checking in to a class. The AI has to show you the full preview first and only runs it after you confirm that exact action; a check-in is only prepared when you say you attended. Mail is never permanently deleted. To keep mail read-only, log in with `monash gmail login --read-only`; to switch an action off, `monash config gmail_manage_enabled false` or `monash config attendance_submit_enabled false`.
|
|
458
|
+
|
|
459
|
+
With `monash remote serve`, each app you pair chooses on the pairing page which of these features it may use. Only features turned on on the server are offered, read-only ones start ticked and the write ones start unticked. So Claude on your phone can have attendance only and ChatGPT mail only, or neither. Apps paired earlier keep Moodle and Ed only until you pair them again, and `monash remote clients` shows what each app has.
|
|
460
|
+
|
|
461
|
+
Each part adds tool descriptions to every conversation: with both logged in it is about 1,900 tokens more (5,132 in total instead of 3,232); without logging in nothing changes.
|
|
462
|
+
|
|
463
|
+
Not verified yet: attendance submission, how long the attendance login lasts, and portals of campuses other than Malaysia.
|
|
464
|
+
|
|
411
465
|
## Updating
|
|
412
466
|
|
|
413
467
|
```bash
|
|
414
468
|
monash update
|
|
415
469
|
```
|
|
416
470
|
|
|
417
|
-
Restart
|
|
471
|
+
Restart your AI app afterwards. On Windows it tells you to quit Claude first and which command to run next (a running program can't be overwritten); close Codex, Cursor or whichever app you use before updating.
|
|
418
472
|
|
|
419
|
-
You'll be told when a new version is out: an extra line after terminal commands, and a short mention when you ask
|
|
473
|
+
You'll be told when a new version is out: an extra line after terminal commands, and a short mention when you ask your AI for your to-dos. It checks GitHub at most once a day
|
|
420
474
|
and sends no personal information; to turn it off: `monash config update_check false`.
|
|
421
475
|
|
|
422
476
|
## FAQ
|
|
423
477
|
|
|
424
|
-
### monash doesn't show up in
|
|
478
|
+
### monash doesn't show up in your AI app
|
|
425
479
|
|
|
426
|
-
|
|
480
|
+
Claude Desktop or Claude Code: run `monash setup claude` to reconnect. On Windows, **fully quit** Claude from the tray first.
|
|
427
481
|
If it still fails, check for errors under Claude Desktop → Settings → Developer.
|
|
428
482
|
|
|
483
|
+
Codex, Cursor, VS Code, Windsurf or Gemini CLI: run `monash connect` to see whether the app is connected, then `monash connect <app>` and restart the app.
|
|
484
|
+
|
|
429
485
|
### The login window won't open / "no browser found"
|
|
430
486
|
|
|
431
487
|
Install Chrome or Edge. If your browser lives somewhere unusual, point to it:
|
|
@@ -436,6 +492,10 @@ Install Chrome or Edge. If your browser lives somewhere unusual, point to it:
|
|
|
436
492
|
By default Windows limits full paths to 260 characters, and unit name + week name + file name can exceed that. Store course files somewhere shorter:
|
|
437
493
|
`monash config files_dir C:\Monash`, then `monash sync`.
|
|
438
494
|
|
|
495
|
+
### My units don't use Ed
|
|
496
|
+
|
|
497
|
+
That's fine: deadlines, grades, course files, search, mail and attendance work without it. When `monash setup` asks for the Ed token, press Enter to skip and answer yes to "not using Ed". Or run `monash config use_ed false` at any time. After that sync, the to-do list and `monash doctor` stop mentioning Ed, and your AI app no longer lists the Ed tools. `monash login ed` turns it back on.
|
|
498
|
+
|
|
439
499
|
### Australian campuses
|
|
440
500
|
|
|
441
501
|
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).
|
|
@@ -448,7 +508,7 @@ Most Ed lessons have no due date; Moodle is the source of truth for deadlines. T
|
|
|
448
508
|
### Something is broken
|
|
449
509
|
|
|
450
510
|
Run `monash doctor` and follow the → after each item. If you need help, send the whole output; it contains no tokens, cookies or similar.
|
|
451
|
-
You can also just tell
|
|
511
|
+
You can also just tell your AI "monash isn't working" and it will run the same checks. The MCP background log is `mcp.log` in the data directory.
|
|
452
512
|
|
|
453
513
|
## Development
|
|
454
514
|
|
|
@@ -469,7 +529,7 @@ Every PR also builds the wheel, checks what went into it (`scripts/check_dist.py
|
|
|
469
529
|
|
|
470
530
|
```mermaid
|
|
471
531
|
flowchart LR
|
|
472
|
-
Claude["Claude
|
|
532
|
+
Claude["Claude, Codex, Cursor and other local MCP apps"] -- "stdio (JSON-RPC)" --> MCP["mcp_server"]
|
|
473
533
|
You["You, in a terminal"] --> CLI["cli / cli_ed"]
|
|
474
534
|
MCP --> Core
|
|
475
535
|
CLI --> Core
|
|
@@ -482,6 +542,10 @@ flowchart LR
|
|
|
482
542
|
Core -- "API token, read-only" --> Ed["Ed"]
|
|
483
543
|
Core -- "public pages only" --> Notes["Course-notes sites"]
|
|
484
544
|
Login["browser_login + cdp: dedicated login window"] -- "Moodle cookie only" --> Core
|
|
545
|
+
Web["ChatGPT / Claude on the web (optional)"] -- "HTTPS + OAuth" --> Remote["remote"]
|
|
546
|
+
Remote --> Core
|
|
547
|
+
Browser["Your browser"] -- "127.0.0.1 only" --> Library["library"]
|
|
548
|
+
Library --> Core
|
|
485
549
|
```
|
|
486
550
|
|
|
487
551
|
| Module | What it does |
|
|
@@ -494,6 +558,9 @@ flowchart LR
|
|
|
494
558
|
| `content_index`, `textextract`, `webnotes` | Full-text search over PDFs, Office files, course-notes websites and transcripts |
|
|
495
559
|
| `browser_login`, `cdp` | Dedicated login window driven over the Chrome DevTools Protocol (a minimal WebSocket client in the standard library) |
|
|
496
560
|
| `jobs`, `mcp_server`, `cli` | Sync and keep-alive jobs, the MCP server, the command line |
|
|
561
|
+
| `widgets`, `ui/panel.html` | The study panels: what each tool attaches for MCP Apps hosts, and the single HTML page that draws them |
|
|
562
|
+
| `library` | `monash library`: the local, read-only page for browsing synced files |
|
|
563
|
+
| `remote` | `monash remote`: optional single-user remote MCP with pairing codes, OAuth and PKCE |
|
|
497
564
|
| `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 |
|
|
498
565
|
| `recordings`, `transcribe` | Optional: lecture recordings to timestamped transcripts (`[media]` extra) |
|
|
499
566
|
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# Privacy policy
|
|
2
|
+
|
|
3
|
+
Last updated: 31 October 2026
|
|
4
|
+
|
|
5
|
+
**English** · [中文摘要](#中文摘要)
|
|
6
|
+
|
|
7
|
+
Monash Study Kit (also used under the name "Monash Student MCP") is open-source, self-hosted software. It is not a hosted service: each person runs it on their own computer or their own server, with their own accounts and credentials. The maintainer does not operate a shared server for other users and does not receive anyone's data.
|
|
8
|
+
|
|
9
|
+
This policy explains what the software accesses, where that data goes, and how to remove it.
|
|
10
|
+
|
|
11
|
+
## What the software accesses
|
|
12
|
+
|
|
13
|
+
Depending on which parts you set up, the software signs in as you and reads:
|
|
14
|
+
|
|
15
|
+
- **Moodle** (learning.monash.edu): courses, files, assignments, grades, feedback, announcements, messages and calendar events.
|
|
16
|
+
- **Ed** (edstem.org): posts, replies, lessons and lesson progress.
|
|
17
|
+
- **Gmail** (optional): if you connect a Google account, messages, threads, labels and attachments, through the Gmail API.
|
|
18
|
+
- **Attendance** (optional): your attendance records on the university attendance portal.
|
|
19
|
+
|
|
20
|
+
Gmail access is requested only when you choose to connect it. The package includes a Google OAuth client (a "desktop app" registered in the maintainer's Google Cloud project) so you can sign in without creating your own. It only tells Google which app is asking; your mail goes from Google straight to your own computer and never passes through the maintainer, who cannot see your tokens or messages. You can use your own client instead with `--client`. By default the software asks for `gmail.modify`, which lets it read mail and, when you ask for it, create drafts, send a draft you reviewed or change labels (archive, mark as read, star). It cannot permanently delete email. If you only want reading, log in with `--read-only` and it asks for `gmail.readonly` instead. Every mailbox action and every attendance check-in runs only after you review the full preview and confirm that specific action.
|
|
21
|
+
|
|
22
|
+
## How the data is used
|
|
23
|
+
|
|
24
|
+
Data is used only to provide the features you use: syncing a private local copy, full-text search, to-do and deadline summaries, and answering questions you ask through an AI app connected to your own instance.
|
|
25
|
+
|
|
26
|
+
The software does not use your data for advertising, does not sell it, and does not use it to build profiles or train machine-learning models.
|
|
27
|
+
|
|
28
|
+
## Where the data is stored
|
|
29
|
+
|
|
30
|
+
- Synced data (course files, posts, email bodies and attachments) is stored on the machine that runs your instance: your own computer, or a server you control.
|
|
31
|
+
- Sign-in state (Moodle session, Ed token, Google OAuth tokens) is stored on that same machine in a private, owner-only directory. Passwords are never stored; Google sign-in happens in your own browser.
|
|
32
|
+
- Nothing is sent to the maintainer or to any analytics or telemetry service.
|
|
33
|
+
|
|
34
|
+
## Sharing
|
|
35
|
+
|
|
36
|
+
The software sends data to:
|
|
37
|
+
|
|
38
|
+
- the services you connected (Moodle, Ed, Google, the attendance portal), to read your data and, only after you confirm, to carry out an action you asked for;
|
|
39
|
+
- the AI app you connect to your instance (for example Claude or Codex), and only the results of the queries that app makes on your behalf. That app's own privacy policy applies to what it receives. With the optional remote mode, an app receives mail or attendance results only if you ticked that feature when pairing it.
|
|
40
|
+
|
|
41
|
+
No other party receives your data.
|
|
42
|
+
|
|
43
|
+
## Google user data
|
|
44
|
+
|
|
45
|
+
Use and transfer of information received from Google APIs adheres to the [Google API Services User Data Policy](https://developers.google.com/terms/api-services-user-data-policy), including the Limited Use requirements. Specifically, Google user data is used only to provide or improve the user-facing features described above; it is not transferred to others except as described in "Sharing", as needed to provide those features, to comply with law, or with your explicit consent; it is not used for advertising; and humans do not read it unless you ask for help with a specific message, it is needed for security or to comply with law, or the data is aggregated and anonymised for internal operations.
|
|
46
|
+
|
|
47
|
+
## Keeping and deleting your data
|
|
48
|
+
|
|
49
|
+
Data stays until you delete it. You can at any time:
|
|
50
|
+
|
|
51
|
+
- revoke Google access at <https://myaccount.google.com/permissions>;
|
|
52
|
+
- delete the local data and credentials by removing the instance's data directory (`MONASH_KIT_HOME`, or `MONASH_KIT_DATA` and `MONASH_KIT_SECRETS` if you set them separately);
|
|
53
|
+
- uninstall the software.
|
|
54
|
+
|
|
55
|
+
Copies already downloaded (for example an attachment) remain on your machine until you delete them, even if the original is later deleted at the source.
|
|
56
|
+
|
|
57
|
+
## Security
|
|
58
|
+
|
|
59
|
+
Credentials and private data are kept in owner-only files and directories, are never written to logs, and are not placed in the course-file web directory. Remote access to a self-hosted server requires OAuth sign-in. Details are in [docs/security.md](docs/security.md). To report a problem, see [SECURITY.md](SECURITY.md).
|
|
60
|
+
|
|
61
|
+
## Changes and contact
|
|
62
|
+
|
|
63
|
+
Changes to this policy are published in this file, with the history visible in the repository. Questions can be raised through [GitHub issues](https://github.com/Waldo0926/monash-study-kit/issues).
|
|
64
|
+
|
|
65
|
+
## 中文摘要
|
|
66
|
+
|
|
67
|
+
- 这是开源、自托管的软件:每个人在自己的电脑或自己的服务器上运行,维护者不运营共享服务,也收不到任何人的数据。
|
|
68
|
+
- 数据(课件、帖子、邮件正文与附件)和登录凭据只保存在运行实例的那台机器上,凭据存放在仅本人可读的目录,不保存密码。
|
|
69
|
+
- Gmail 为可选功能,默认只读;邮箱操作(草稿、发信、标签)需要额外授权,并在你确认具体内容后才执行,永不彻底删除邮件。
|
|
70
|
+
- 数据只发给你连接的服务(Moodle、Ed、Google、考勤门户)和你接入的 AI 应用(仅限它代你查询的结果);不用于广告、不出售、不用于训练模型。
|
|
71
|
+
- 使用 Google API 获取的数据遵守 Google API Services User Data Policy 及其 Limited Use 要求。
|
|
72
|
+
- 可随时在 <https://myaccount.google.com/permissions> 撤销 Google 授权,删除数据目录即可清除全部本地数据。
|