add_discussiondestructive | Start a new discussion thread in a forum. IRREVERSIBLE once dry_run=False.
Call with dry_run=True (default) first, show the preview to the user,
and only call again with dry_run=False after they explicitly confirm.
|
add_discussion_postdestructive | Reply to a forum discussion thread. IRREVERSIBLE once dry_run=False.
Call with dry_run=True (default) first, show the preview to the user,
and only call again with dry_run=False after they explicitly confirm.
|
add_private_filedestructive | Upload a file to this account's Moodle private files area.
IRREVERSIBLE once dry_run=False -- no delete tool exists for
private files yet, so this permanently adds the file until the
user removes it via PLATO's own UI. Only works when this server
is running locally (stdio).
Call with dry_run=True (default) first, show the preview to the
user, and only call again with dry_run=False after they explicitly
confirm.
|
create_calendar_eventdestructive | Create a personal calendar entry. IRREVERSIBLE once dry_run=False.
Only personal ("user") events are supported -- course/group events
are not something a student account can create.
Call with dry_run=True (default) first, show the preview to the user,
and only call again with dry_run=False after they explicitly confirm.
|
delete_calendar_eventdestructive | Delete a personal calendar entry this account owns. IRREVERSIBLE
once dry_run=False.
Call with dry_run=True (default) first, show the preview to the user,
and only call again with dry_run=False after they explicitly confirm.
|
download_course_fileread-only | Download a course file (the `fileurl` from get_course_contents).
Running locally (stdio, e.g. Claude Code/Desktop): saves the file to
`save_path` on this machine and returns the saved path -- `save_path`
is required in this case.
Running as a remote/hosted server (streamable-http, e.g. reached via
a Claude.ai web/mobile Connector): this server's own disk is not
reachable by you, so do NOT pass `save_path` -- it will be rejected.
Instead the file is fetched here and returned inline as base64
content for you to decode and present, unless it's too large, in
which case a direct authenticated download URL is returned instead
(that URL embeds a live PLATO access token: do not share it or a
chat transcript containing it).
Only common course-material extensions are allowed (pdf, office
docs, images, zip, txt); local downloads over the configured size
limit are rejected.
|
get_activity_completion_statusread-only | Get this account's completion status for every activity/module in
a course -- richer than get_course_contents's per-module `completed`
flag (includes tracking rules, e.g. 'must view' vs 'must spend N
minutes'). For `vod` (video lecture) modules specifically, prefer
get_course_contents, whose per-module `vod_progress` field also
includes watch-percentage and deadline info this function doesn't
return. |
get_assignment_detailread-only | Get one assignment's details and this account's submission status. |
get_calendar_access_inforead-only | Check this account's calendar-management permissions -- a
student account can typically manage its own personal entries
only, not course/group entries. |
get_course_completion_statusread-only | Get this account's overall course-completion status, if the course
has course-level completion criteria configured. Most courses on
this platform don't (available=False, with a message explaining
why) -- try get_activity_completion_status for per-activity
progress instead, or get_course_contents's per-module `completed`
flag. |
get_course_contentsread-only | Get a course's weekly sections, modules, and file links. |
get_course_moduleread-only | Resolve a single course module by its id directly, without
fetching and filtering the whole course's contents. |
get_courses_by_timelineread-only | List enrolled courses filtered by Moodle's own timeline
classification (in-progress/future/past), based on course start/end
dates. Unlike list_courses (which returns everything unfiltered),
this answers "what am I actually taking right now" directly. |
get_course_updates_sinceread-only | Get what changed in a course since a given time -- configuration,
completion, grades, submissions, etc. Only reports modules that
implement Moodle's change-tracking (confirmed: the standard `assign`
module does; this platform's own custom lecture-file/board/video
modules do not, so this won't catch a new ubfile lecture or ubboard
post -- use get_course_contents/list_notices to check those instead. |
get_discussion_postsread-only | Get all posts in one forum discussion thread. |
get_enrolled_usersread-only | Get the list of users enrolled in a course (classmates and
instructors), with their role. Same data visible in PLATO's own
participant list to any enrolled student. |
get_forum_discussionsread-only | List discussion threads in one standard Moodle forum. |
get_gradesread-only | Get this account's grade items for a course, if visible. |
get_grades_access_inforead-only | Check what grade-related permissions this account has in a
course -- e.g. whether it can see its own grades vs. (as a
teacher/TA) everyone's grades. Most student accounts will see
canviewallgrades=False. |
get_grades_overviewread-only | Get this account's overall grade for every enrolled course in one
call. For the individual grade *items* within one course (e.g. each
assignment's score), use get_grades instead -- this tool only
returns one summary grade per course. |
get_my_course_groupsread-only | Get the groups this account belongs to within a course, if any. |
get_notice_detailread-only | Get the full text of one notice/announcement. |
get_private_files_inforead-only | Get a summary (file/folder count, total size) of this account's
Moodle private files area. |
get_qna_detailread-only | Get one Q&A question's text. Does not include replies -- see issue #23. |
get_quiz_access_informationread-only | Check whether this account can currently attempt a quiz, and
why not if blocked (e.g. time window, password, previous
attempts exhausted). UNVERIFIED against a real quiz -- call this
before start_quiz_attempt and sanity-check the result. |
get_quiz_attempt_dataread-only | Get the questions for one page of an in-progress quiz attempt.
Each question's `html` is Moodle's own rendered question form --
parse it for the actual answer-field names before calling
save_quiz_attempt_responses/process_quiz_attempt. UNVERIFIED
against a real quiz. |
get_quiz_attempt_reviewread-only | Get the grade and per-question review for a finished quiz
attempt. UNVERIFIED against a real quiz. |
get_quiz_attemptsread-only | Get this account's past attempts at one quiz. |
get_quiz_attempt_summaryread-only | Get a summary of all questions in an attempt (answered/
unanswered), across all pages. UNVERIFIED against a real quiz. |
get_quiz_best_graderead-only | Get this account's best grade on one quiz, if any attempt has
been graded. |
get_quiz_combined_review_optionsread-only | Check which review details (marks, feedback, right answers) this
account is allowed to see for a quiz's attempts. |
get_quiz_feedback_for_graderead-only | Get the grade-boundary feedback text configured for a quiz at
a given grade (e.g. 'You passed!' / 'Please review chapter 3'). |
get_quiz_required_qtypesread-only | List the question types used in a quiz (e.g. 'multichoice',
'truefalse', 'essay') -- useful to know what kind of answers
to expect before starting an attempt. |
get_recent_coursesread-only | Get this account's recently-accessed courses, most recent first. |
get_recent_itemsread-only | Get this account's recently-accessed course modules (files,
assignments, etc.) across all courses, most recent first. |
get_starred_coursesread-only | Get this account's starred/favourited courses, if any. |
get_unread_messagesread-only | Get this account's unread PLATO notifications. |
get_unread_notification_countread-only | Get a count of this account's unread notifications (a cheaper
check than get_unread_messages when you don't need the content).
Note: PLATO has person-to-person messaging disabled site-wide, so
this counts notifications only, not conversation messages. |
get_upcoming_action_eventsread-only | Get Moodle's own "what needs action soon" feed -- assignments due,
video lectures with a watch deadline, etc. -- sorted by urgency, from
now onward. Unlike combining list_assignments + get_calendar_events,
this is Moodle's own cross-activity prioritized view and may surface
activity types (e.g. vod watch deadlines) those tools don't. |
get_user_preferencesread-only | Get this account's Moodle user preferences. Note: most of these
are internal UI state (e.g. which dashboard sections are
collapsed), not information meaningful on its own. |
get_user_profileread-only | Get a user's profile, scoped to a shared course (not a global
user search -- see docs/pii_review.md). |
list_assignmentsread-only | List assignments across one or more courses, with due dates. |
list_calendar_eventsread-only | List upcoming calendar events within the next `days_ahead` days. |
list_chatsread-only | List Chat (real-time chat room) activities across one or more
courses. Reading/sending chat messages is not supported by this
server -- this tool is read-only coverage only. |
list_choicesread-only | List Choice (single-question poll) activities across one or
more courses. Voting is not supported by this server -- this
tool is read-only coverage only. |
list_coursesread-only | List the courses the logged-in PLATO account is enrolled in. |
list_database_activitiesread-only | List Database ("mod_data") activities across one or more
courses. Reading/adding entries is not supported by this server --
this tool is read-only coverage only. |
list_feedbacksread-only | List Feedback (survey) activities across one or more courses.
Responding to a survey is not supported by this server -- this
tool is read-only coverage only. |
list_forumsread-only | List standard Moodle forums across one or more courses. NOT the
same as PLATO's notice/Q&A board (use list_notices/list_qna for
that) -- this covers the separate, less-commonly-used mod_forum
module. |
list_glossariesread-only | List Glossary activities across one or more courses. Reading/
adding entries is not supported by this server -- this tool is
read-only coverage only. |
list_h5p_activitiesread-only | List H5P interactive-content activities across one or more
courses. Attempt results are not supported by this server -- this
tool is read-only coverage only. |
list_lessonsread-only | List Lesson activities across one or more courses. Taking a
lesson (answering pages) is not supported by this server -- this
tool is read-only coverage only. |
list_noticesread-only | List announcements posted to a course's Notices board. |
list_qnaread-only | List questions posted to a course's Q&A board. |
list_quizzesread-only | List quizzes across one or more courses. |
list_scormsread-only | List SCORM packaged-content activities across one or more
courses. Launching/tracking a SCORM attempt is not supported by
this server -- this tool is read-only coverage only. |
list_surveysread-only | List Survey activities across one or more courses. Answering is
not supported by this server -- this tool is read-only coverage
only. |
list_video_conferencesread-only | List BigBlueButton video-conference activities across one or
more courses. Joining a meeting is not supported by this server --
this tool is read-only coverage only. Zoom activities (mod_zoom)
are not covered -- no real instance has existed to verify against. |
list_wikisread-only | List Wiki activities across one or more courses. Reading/
editing pages is not supported by this server -- this tool is
read-only coverage only. |
list_workshopsread-only | List Workshop (peer assessment) activities across one or more
courses. Submitting or assessing work is not supported by this
server -- this tool is read-only coverage only. |
post_qna_questiondestructive | Post a new question to a course's Q&A board. IRREVERSIBLE and VISIBLE
to the instructor once dry_run=False (posted as private/secret by default).
Call with dry_run=True (default) first, show the preview to the user, and
only call again with dry_run=False after they explicitly confirm.
|
process_quiz_attemptdestructive | Submit answers for a quiz attempt. IRREVERSIBLE once
dry_run=False AND finish_attempt=True -- that is the final,
graded submission and cannot be undone. UNVERIFIED against a
real quiz.
Call with dry_run=True (default) first, show the preview to the
user -- especially before finish_attempt=True -- and only call
again with dry_run=False after they explicitly confirm.
|
remove_submissiondestructive | Withdraw/clear this account's own submission for an assignment.
IRREVERSIBLE and DESTRUCTIVE once dry_run=False -- this discards
already-submitted work (files/text), not a draft.
KNOWN ISSUE: live testing found dry_run=False currently fails with
an "invalid parameter" error from PLATO every time (the real
required parameter shape wasn't determined -- see
remove_submission_for's docstring). dry_run=True (preview) works
and is safe to call. Do not rely on dry_run=False actually working
until this is fixed.
Call with dry_run=True (default) first, show the preview to the user,
and only call again with dry_run=False after they explicitly confirm.
|
save_quiz_attempt_responsesdestructive | Save in-progress answers WITHOUT finishing the attempt -- can
still be changed later. UNVERIFIED against a real quiz.
Call with dry_run=True (default) first, show the preview to the
user, and only call again with dry_run=False after they explicitly
confirm.
|
search_coursesread-only | Search PLATO's entire course catalog by name -- not limited to
this account's enrolled courses (use list_courses for that). |
start_quiz_attemptdestructive | Start a new attempt at a quiz. IRREVERSIBLE once dry_run=False --
consumes one of the quiz's limited attempts. UNVERIFIED against a
real quiz -- call get_quiz_access_information first and check
canattempt/preventaccessreasons.
Call with dry_run=True (default) first, show the preview to the
user, and only call again with dry_run=False after they explicitly
confirm.
|
submit_assignmentdestructive | Submit text and/or file attachments for an assignment. IRREVERSIBLE once dry_run=False.
Call with dry_run=True (default) first, show the preview to the user, and
only call again with dry_run=False (same parameters) after they explicitly
confirm. Provide text, file_paths/file_contents, or both -- whichever this
assignment actually accepts (see get_assignment_detail).
file_paths works only when this server is running locally (stdio, e.g.
Claude Code/Desktop) -- rejected with a clear error over a remote
(streamable-http, e.g. a Claude.ai Connector) connection, mirroring
download_course_file's own stdio-vs-remote split. file_contents works
over either transport and is the only option remotely, since this
server's disk is not reachable by you there.
|