Get the MCP server version (only use for debugging).

Get the MCP server API URL (only use for debugging).

Upload a local file or a file from a URL to the EduBase temporary file storage with a link requested from the API in advance.

Generate upload link for a temporary file storage.

Delete an uploaded file and/or temporary file upload link.

List owned and managed Quiz questions.

Check existing question. Questions are the lowest level in the EduBase hierarchy, serving as the building blocks for Quiz sets. To get question details, use the question export function!

Publish or update a question. Questions are the atomic building blocks of the EduBase Quiz system and represent the lowest level in the hierarchy (Questions -> Quiz sets -> Exams). Always check what the fields named like the type of the question do and consider using them, for example if creating a HOTSPOT question, both hotspot_zones and hotspot_image will be required!

Permanently delete a Quiz question.

Generate download link for exporting the question (in JSON format). If a previous valid link exists, it will be returned instead.

Get external unique question identifier by question identification string.

Set external unique question identifier for question identified by a question identification string.

List owned and managed exams. Exams are the highest level in the EduBase Quiz hierarchy, built from Quiz sets.

Get/check exam.

Create a new exam from an existing Quiz set. Exams are at the top level of the EduBase Quiz hierarchy and MUST be created from existing Quiz sets. They are time-constrained, secured assessment instances of Quiz sets.

Update the details of an existing exam.

Remove/archive exam.

Get the settings of an exam. Surveys are never graded and their results cannot be viewed later, so the grading and the results viewing settings are not returned for them. The columns of the results export cannot be configured for surveys either, only the format and the ordering of the exported file.

Change individual settings of an exam. The columns of the export (every setting from export_stats on) cannot be configured for surveys, only the export_format and the export_sort settings are available for them. The export_attendance setting is read only, the attendance is configured together with its source on the interface.

Replace the complete configuration of an exam with the configuration of another exam. Exam specific data and state (automatic account generation, rounds, notifications, login settings and previously used patterns) is never copied. Branding, and the attached learning materials (course, SCORM package and video) of the target exam are kept as well.

Copy only those settings from another exam that are not configured yet in the target exam.

Get the automatic login configuration of an exam.

Enable or reconfigure automatic login for an exam.

Disable automatic login for an exam. The PIN code and the shortlink of the exam are removed as well.

Generate exam accounts from patterns and assign them to an exam. The following placeholders can be used in the patterns: {index} (the index of the generated account), {random:N} (a random alphanumeric string of N characters, unambiguous characters only in passwords), {number:N} (a random numeric string of N characters), {name} and {Name} (the name of the account, only when names is specified, as given and capitalized) and {username} (the generated username, in the name pattern only). Patterns are stored with the exam and reused as defaults for the next call.

Get the user data fields of an exam. These are the built-in name, email address and phone number fields, and the custom fields the examinees fill in before they start their test.

Change the built-in user data fields of an exam, and replace the complete list of its custom fields. The view_results_identifier setting of the exam is cleared when the selected custom field is not a unique free text field anymore.

Remove every custom field of an exam. The built-in name, email address and phone number fields are kept, use edubase_post_exam_fields to turn those off. The values the examinees already entered are kept, but they are not shown anymore. The view_results_identifier setting of the exam is cleared as well.

Get the status of an exam, showing whether new tests can be started.

Enable or disable starting new tests on an exam. The exam itself stays active, only the start of further tests is controlled. The status can only be changed while the exam is active and has not closed yet. New tests cannot be started in the results viewing period. Disabling new tests also cancels the scheduled automatic disabling of the exam.

Get the current round of an exam.

Start a new round of the exam. The running tests are closed, the results of the previous round are detached from the exam accounts and the generated accounts are reset, so the exam can be taken again by another group of examinees. A new round cannot be started when the exam is locked, archived, the current round is frozen (see the freeze_round setting of edubase_post_exam_settings), or the results viewing period of the exam has already begun (see the view_results_start setting of edubase_post_exam_settings).

Get skills defined in the Quiz set used by an exam.

Get exam branding configuration.

Configure or update exam branding.

Remove branding from an exam.

List all users on an exam.

Assign user(s) to an exam.

Remove user(s) from an exam.

Submit a new AI exam summary.

Get detailed results for a specific Quiz play.

Archive or forget the result of a Quiz play. An exam result is archived: it disappears from the result lists and the reports of the exam, but it is kept and can be restored by adding the archived user back to the exam. A result outside of an exam is forgotten: the play is detached from the user and only kept for the statistics. Exam results can only be archived when archiving is enabled for the exam (see the archive setting of edubase_post_exam_settings), and only the current result of the user can be archived. Results outside of an exam can only be forgotten by administrators.

Get user results for a specific Quiz set.

Get user results for a specific exam.

Get raw results for a specific exam. Only use this if very detailed results are needed! This endpoint returns raw results, including all answers given by the user. It is not meant to be displayed to the user. This might require additional permissions!

Generate a download link for the results of an exam. The generated link is not authenticated, so it can be handed over to any service, but it can only be used once and it expires in an hour. Only those examinees are exported that are visible for the current user, and the exported columns are controlled by the export settings of the exam (see edubase_get_exam_settings). Exporting the results needs reporting permission for the exam.

Get (the latest) certificate details for a specific exam and user.

Generate download link for the latest user exam certificate. If a previous valid link exists, it will be returned instead.

List owned and managed Quiz sets. Quiz sets are named collections of questions that sit at the middle level of the EduBase Quiz hierarchy.

Get/check Quiz set. Containing questions and powering Exams.

Create a new Quiz set. Quiz sets are collections of questions that can be used for practice or to power multiple Exams.

Update the details of an existing Quiz set.

Get the settings of a Quiz set.

Change individual settings of a Quiz set.

Replace the complete configuration of a Quiz set with the configuration of another Quiz set. Only the configuration is copied, questions and question groups are not. The question selection, filtering and export settings of the target Quiz set are kept as well.

Copy only those settings from another Quiz set that are not configured yet in the target Quiz set.

Remove/archive Quiz set.

List the grading presets available for the user. Both the global presets and the owned, custom presets are returned.

Get a grading preset with its thresholds and grades.

Create a new custom grading preset. Needs the custom grading feature to be enabled.

Update an existing custom grading preset. Global presets cannot be modified.

Remove a custom grading preset. Global presets, and presets that are still used by a Quiz set or an exam cannot be removed.

Get skills defined in a Quiz set.

List all questions and question groups in a Quiz set. Quiz sets contain questions (lowest level) and can be used by exams (highest level).

Assign question(s) to a Quiz set, or one of its question group. Questions can exist independently from Quiz sets.

Remove question(s) from a Quiz set, or one of its question group.

List managed, non-generated users.

Get/check current user.

Get/check user.

Create new EduBase user account.

Update user.

Delete user.

Get user's name.

Update a user's name.

Get user's group.

Update a user's group.

Get latest valid login link for user.

Generate login link. If a valid link with the same settings exists, it will be returned instead of creating a new one.

Delete a previously generated login link.

Lookup user by email, username or code.

Assume user for next requests with assume token.

Revoke assume token.

List owned and managed classes.

Get/check class.

List all assignments in a class.

List all members in a class.

Assign user(s) to a class. Updates memberships if already member of the class.

Remove user(s) from a class.

Assign user(s) to class(es). Updates memberships if already member of a class.

List all classes a user is member of.

Assign user to class(es). Updates membership if already member of a class.

Remove user from class(es).

List owned and managed organizations.

Get/check organization.

Create an organization.

Update organization.

Remove organization.

List all members in an organization.

Assign user(s) to an organization. Updates memberships if already member of the organization.

Remove user(s) from an organization.

Assign user(s) to organization(s). Updates memberships if already member of an organization.

List all organizations a user is member of.

Assign user to organization(s). Updates membership if already member of an organization.

Remove user from organization(s).

Get/check webhook configured in organization.

Create a webhook for an organization.

Update organizational webhook.

Remove organizational webhook.

Trigger an organizational webhook call with optional custom payload. Only triggers webhooks with trigger_event set to api!.

List owned and managed integrations.

Get/check integration.

Create a new API or LMS integration.

Update integration.

Remove integration.

Get integration keys/secrets.

Rotate integration keys/secrets.

List owned and managed tags.

Get/check tag.

List all attached tags of a class.

Check if tag is attached to a class.

Attach tag to a class.

Remove a tag attachment from a class.

List all attached tags of a course.

Check if tag is attached to a course.

Attach tag to a course.

Remove a tag attachment from a course.

List all attached tags of an event.

Check if tag is attached to an event.

Attach tag to an event.

Remove a tag attachment from an event.

List all attached tags of an exam.

Check if tag is attached to an exam.

Attach tag to an exam.

Remove a tag attachment from an exam.

List all attached tags of an integration.

Check if tag is attached to an integration.

Attach tag to an integration.

Remove a tag attachment from an integration.

List all attached tags of an organization.

Check if tag is attached to an organization.

Attach tag to an organization.

Remove a tag attachment from an organization.

List all attached tags of a Quiz.

Check if tag is attached to a Quiz.

Attach tag to a Quiz.

Remove a tag attachment from a Quiz.

List all attached tags of a SCORM learning material.

Check if tag is attached to a SCORM learning material.

Attach tag to a SCORM learning material.

Remove a tag attachment from a SCORM learning material.

List all attached tags of a video.

Check if tag is attached to a video.

Attach tag to a video.

Remove a tag attachment from a video.

Check if a user has permission on a class.

Create new permission for a user on a class.

Remove a user permission from a class.

Transfer class to user.

Check if a user has permission on a course.

Create new permission for a user on a course.

Remove a user permission from a course.

Transfer course to user.

Check if a user has permission on an event.

Create new permission for a user on an event.

Remove a user permission from an event.

Transfer event to user.

Check if a user has permission on an exam.

Create new permission for a user on an exam.

Remove a user permission from an exam.

Transfer exam to user.

Check if a user has permission on an integration.

Create new permission for a user on an integration.

Remove a user permission from an integration.

Transfer integration to user.

Check if a user has permission on an organization.

Create new permission for a user on an organization.

Remove a user permission from an organization.

Transfer organization to user.

Check if a user has permission on a quiz.

Create new permission for a user on a quiz.

Remove a user permission from a quiz.

Transfer Quiz to user.

Check if a user has permission on a SCORM learning material.

Create new permission for a user on a SCORM learning material.

Remove a user permission from a SCORM learning material.

Transfer SCORM to user.

Check if a user has permission on a tag.

Create new permission for a user on a tag.

Remove a user permission from a tag.

Transfer tag to user.

Check if a user has permission on a video.

Create new permission for a user on a video.

Remove a user permission from a video.

Transfer video to user.

Update a custom metric.