EduBase MCP Server
The EduBase MCP server enables Claude and other LLMs to interact with EduBase's comprehensive e-learning platform through the Model Context Protocol (MCP).
MCP Info
| Attribute | Details |
|---|---|
| Docker Image | mcp/edubase |
| Author | EduBase |
| Repository | https://github.com/EduBase/MCP |
Image Building Info
| Attribute | Details |
|---|---|
| Dockerfile | https://github.com/EduBase/MCP/blob/327a66790b2aa4aa83be6303398145a3b5e520fc/Dockerfile |
| Commit | 327a66790b2aa4aa83be6303398145a3b5e520fc |
| Docker Image built by | Docker Inc. |
| Docker Scout Health Score | Docker Scout Health Score |
| Verify Signature | COSIGN_REPOSITORY=mcp/signatures cosign verify mcp/edubase --key https://raw.githubusercontent.com/docker/keyring/refs/heads/main/public/mcp/latest.pub |
| Licence | MIT License |
Available Tools (165)
| Tools provided by this Server | Short Description |
|---|---|
edubase_delete_class_members |
Remove user(s) from a class |
edubase_delete_class_permission |
Remove a user permission from a class |
edubase_delete_class_tag |
Remove a tag attachment from a class |
edubase_delete_course_permission |
Remove a user permission from a course |
edubase_delete_course_tag |
Remove a tag attachment from a course |
edubase_delete_event_permission |
Remove a user permission from an event |
edubase_delete_event_tag |
Remove a tag attachment from an event |
edubase_delete_exam |
Remove/archive exam |
edubase_delete_exam_branding |
Remove branding from an exam |
edubase_delete_exam_permission |
Remove a user permission from an exam |
edubase_delete_exam_tag |
Remove a tag attachment from an exam |
edubase_delete_exam_users |
Remove user(s) from an exam |
edubase_delete_filebin_upload |
Delete an uploaded file and/or temporary file upload link |
edubase_delete_integration |
Remove integration |
edubase_delete_integration_permission |
Remove a user permission from an integration |
edubase_delete_integration_tag |
Remove a tag attachment from an integration |
edubase_delete_organization |
Remove organization |
edubase_delete_organization_members |
Remove user(s) from an organization |
edubase_delete_organization_permission |
Remove a user permission from an organization |
edubase_delete_organization_tag |
Remove a tag attachment from an organization |
edubase_delete_organization_webhook |
Remove organizational webhook |
edubase_delete_question |
Permanently delete a Quiz question |
edubase_delete_quiz |
Remove/archive Quiz set |
edubase_delete_quiz_permission |
Remove a user permission from a quiz |
edubase_delete_quiz_questions |
Remove question(s) from a Quiz set, or one of its question group |
edubase_delete_quiz_tag |
Remove a tag attachment from a Quiz |
edubase_delete_scorm_permission |
Remove a user permission from a SCORM learning material |
edubase_delete_scorm_tag |
Remove a tag attachment from a SCORM learning material |
edubase_delete_tag_permission |
Remove a user permission from a tag |
edubase_delete_user |
Delete user |
edubase_delete_user_assume |
Revoke assume token |
edubase_delete_user_classes |
Remove user from class(es) |
edubase_delete_user_login |
Delete a previously generated login link |
edubase_delete_user_organizations |
Remove user from organization(s) |
edubase_delete_video_permission |
Remove a user permission from a video |
edubase_delete_video_tag |
Remove a tag attachment from a video |
edubase_filebin |
Upload file to EduBase temporary file storage |
edubase_get_class |
Get/check class |
edubase_get_class_assignments |
List all assignments in a class |
edubase_get_class_members |
List all members in a class |
edubase_get_class_permission |
Check if a user has permission on a class |
edubase_get_class_tag |
Check if tag is attached to a class |
edubase_get_class_tags |
List all attached tags of a class |
edubase_get_classes |
List owned and managed classes |
edubase_get_course_permission |
Check if a user has permission on a course |
edubase_get_course_tag |
Check if tag is attached to a course |
edubase_get_course_tags |
List all attached tags of a course |
edubase_get_event_permission |
Check if a user has permission on an event |
edubase_get_event_tag |
Check if tag is attached to an event |
edubase_get_event_tags |
List all attached tags of an event |
edubase_get_exam |
Get/check exam |
edubase_get_exam_branding |
Get exam branding configuration |
edubase_get_exam_certificates_user |
Get (the latest) certificate details for a specific exam and user |
edubase_get_exam_permission |
Check if a user has permission on an exam |
edubase_get_exam_results_raw |
Get raw results for a specific exam |
edubase_get_exam_results_user |
Get user results for a specific exam |
edubase_get_exam_tag |
Check if tag is attached to an exam |
edubase_get_exam_tags |
List all attached tags of an exam |
edubase_get_exam_users |
List all users on an exam |
edubase_get_exams |
List owned and managed exams |
edubase_get_integration |
Get/check integration |
edubase_get_integration_keys |
Get integration keys/secrets |
edubase_get_integration_permission |
Check if a user has permission on an integration |
edubase_get_integration_tag |
Check if tag is attached to an integration |
edubase_get_integration_tags |
List all attached tags of an integration |
edubase_get_integrations |
List owned and managed integrations |
edubase_get_organization |
Get/check organization |
edubase_get_organization_members |
List all members in an organization |
edubase_get_organization_permission |
Check if a user has permission on an organization |
edubase_get_organization_tag |
Check if tag is attached to an organization |
edubase_get_organization_tags |
List all attached tags of an organization |
edubase_get_organization_webhook |
Get/check webhook configured in organization |
edubase_get_organizations |
List owned and managed organizations |
edubase_get_question |
Check existing question |
edubase_get_question_id |
Get external unique question identifier by question identification string |
edubase_get_questions |
List owned and managed Quiz questions |
edubase_get_quiz |
Get/check Quiz set |
edubase_get_quiz_permission |
Check if a user has permission on a quiz |
edubase_get_quiz_questions |
List all questions and question groups in a Quiz set |
edubase_get_quiz_results_play |
Get detailed results for a specific Quiz play |
edubase_get_quiz_results_user |
Get user results for a specific Quiz set |
edubase_get_quiz_tag |
Check if tag is attached to a Quiz |
edubase_get_quiz_tags |
List all attached tags of a Quiz |
edubase_get_quizes |
List owned and managed Quiz sets |
edubase_get_scorm_permission |
Check if a user has permission on a SCORM learning material |
edubase_get_scorm_tag |
Check if tag is attached to a SCORM learning material |
edubase_get_scorm_tags |
List all attached tags of a SCORM learning material |
edubase_get_tag |
Get/check tag |
edubase_get_tag_permission |
Check if a user has permission on a tag |
edubase_get_tags |
List owned and managed tags |
edubase_get_user |
Get/check user |
edubase_get_user_classes |
List all classes a user is member of |
edubase_get_user_group |
Get user's group |
edubase_get_user_login |
Get latest valid login link for user |
edubase_get_user_me |
Get/check current user |
edubase_get_user_name |
Get user's name |
edubase_get_user_organizations |
List all organizations a user is member of |
edubase_get_user_search |
Lookup user by email, username or code |
edubase_get_users |
List managed, non-generated users |
edubase_get_video_permission |
Check if a user has permission on a video |
edubase_get_video_tag |
Check if tag is attached to a video |
edubase_get_video_tags |
List all attached tags of a video |
edubase_mcp_server_api |
Get MCP Server API URL |
edubase_mcp_server_version |
Get MCP Server Version |
edubase_patch_integration |
Update integration |
edubase_patch_organization |
Update organization |
edubase_patch_organization_webhook |
Update organizational webhook |
edubase_patch_user |
Update user |
edubase_post_class_members |
Assign user(s) to a class |
edubase_post_class_permission |
Create new permission for a user on a class |
edubase_post_class_tag |
Attach tag to a class |
edubase_post_class_transfer |
Transfer class to user |
edubase_post_classes_members |
Assign user(s) to class(es) |
edubase_post_course_permission |
Create new permission for a user on a course |
edubase_post_course_tag |
Attach tag to a course |
edubase_post_course_transfer |
Transfer course to user |
edubase_post_event_permission |
Create new permission for a user on an event |
edubase_post_event_tag |
Attach tag to an event |
edubase_post_event_transfer |
Transfer event to user |
edubase_post_exam |
Create a new exam from an existing Quiz set |
edubase_post_exam_branding |
Configure or update exam branding |
edubase_post_exam_certificates_user_download |
Generate download link for the latest user exam certificate |
edubase_post_exam_permission |
Create new permission for a user on an exam |
edubase_post_exam_summary |
Submit a new AI exam summary |
edubase_post_exam_tag |
Attach tag to an exam |
edubase_post_exam_transfer |
Transfer exam to user |
edubase_post_exam_users |
Assign user(s) to an exam |
edubase_post_filebin_upload |
Generate upload link for a temporary file storage |
edubase_post_integration |
Create a new API or LMS integration |
edubase_post_integration_keys |
Rotate integration keys/secrets |
edubase_post_integration_permission |
Create new permission for a user on an integration |
edubase_post_integration_tag |
Attach tag to an integration |
edubase_post_integration_transfer |
Transfer integration to user |
edubase_post_metrics_custom |
Update a custom metric |
edubase_post_organization |
Create an organization |
edubase_post_organization_members |
Assign user(s) to an organization |
edubase_post_organization_permission |
Create new permission for a user on an organization |
edubase_post_organization_tag |
Attach tag to an organization |
edubase_post_organization_transfer |
Transfer organization to user |
edubase_post_organization_webhook |
Create a webhook for an organization |
edubase_post_organization_webhook_trigger |
Trigger an organizational webhook call with optional custom payload |
edubase_post_organizations_members |
Assign user(s) to organization(s) |
edubase_post_question |
Publish or update a question |
edubase_post_question_export |
Generate download link for exporting the question (in JSON format) |
edubase_post_question_id |
Set external unique question identifier for question identified by a question identification string |
edubase_post_quiz |
Create a new Quiz set |
edubase_post_quiz_permission |
Create new permission for a user on a quiz |
edubase_post_quiz_questions |
Assign question(s) to a Quiz set, or one of its question group |
edubase_post_quiz_tag |
Attach tag to a Quiz |
edubase_post_quiz_transfer |
Transfer Quiz to user |
edubase_post_scorm_permission |
Create new permission for a user on a SCORM learning material |
edubase_post_scorm_tag |
Attach tag to a SCORM learning material |
edubase_post_scorm_transfer |
Transfer SCORM to user |
edubase_post_tag_permission |
Create new permission for a user on a tag |
edubase_post_tag_transfer |
Transfer tag to user |
edubase_post_user |
Create new EduBase user account |
edubase_post_user_assume |
Assume user for next requests with assume token |
edubase_post_user_classes |
Assign user to class(es) |
edubase_post_user_group |
Update a user's group |
edubase_post_user_login |
Generate login link |
edubase_post_user_name |
Update a user's name |
edubase_post_user_organizations |
Assign user to organization(s) |
edubase_post_video_permission |
Create new permission for a user on a video |
edubase_post_video_tag |
Attach tag to a video |
edubase_post_video_transfer |
Transfer video to user |
Tools Details
Tool: edubase_delete_class_members
Remove user(s) from a class.
| Parameters | Type | Description |
|---|---|---|
class |
string |
class identification string |
users |
string |
comma-separated list of user identification strings |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_class_permission
Remove a user permission from a class.
| Parameters | Type | Description |
|---|---|---|
class |
string |
class identification string |
permission |
string |
permission level (view / report / control / modify / grant / admin) |
user |
string |
user identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_class_tag
Remove a tag attachment from a class.
| Parameters | Type | Description |
|---|---|---|
class |
string |
class identification string |
tag |
string |
tag identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_course_permission
Remove a user permission from a course.
| Parameters | Type | Description |
|---|---|---|
course |
string |
course identification string |
permission |
string |
permission level (view / report / control / modify / grant / admin) |
user |
string |
user identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_course_tag
Remove a tag attachment from a course.
| Parameters | Type | Description |
|---|---|---|
course |
string |
course identification string |
tag |
string |
tag identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_event_permission
Remove a user permission from an event.
| Parameters | Type | Description |
|---|---|---|
event |
string |
event identification string |
permission |
string |
permission level (view / report / control / modify / finances / grant / admin) |
user |
string |
user identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_event_tag
Remove a tag attachment from an event.
| Parameters | Type | Description |
|---|---|---|
event |
string |
event identification string |
tag |
string |
tag identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_exam
Remove/archive exam.
| Parameters | Type | Description |
|---|---|---|
exam |
string |
exam identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_exam_branding
Remove branding from an exam.
| Parameters | Type | Description |
|---|---|---|
exam |
string |
exam identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_exam_permission
Remove a user permission from an exam.
| Parameters | Type | Description |
|---|---|---|
exam |
string |
exam identification string |
permission |
string |
permission level (view / report / control / modify / grant / admin) |
user |
string |
user identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_exam_tag
Remove a tag attachment from an exam.
| Parameters | Type | Description |
|---|---|---|
exam |
string |
exam identification string |
tag |
string |
tag identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_exam_users
Remove user(s) from an exam.
| Parameters | Type | Description |
|---|---|---|
exam |
string |
exam identification string |
users |
string |
comma-separated list of user identification strings |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_filebin_upload
Delete an uploaded file and/or temporary file upload link.
| Parameters | Type | Description |
|---|---|---|
id |
string |
external unique filebin identifier of the uploaded file or temporary file upload link |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_integration
Remove integration.
| Parameters | Type | Description |
|---|---|---|
integration |
string |
integration identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_integration_permission
Remove a user permission from an integration.
| Parameters | Type | Description |
|---|---|---|
integration |
string |
integration identification string |
permission |
string |
permission level (view / report / control / modify / grant / admin) |
user |
string |
user identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_integration_tag
Remove a tag attachment from an integration.
| Parameters | Type | Description |
|---|---|---|
integration |
string |
integration identification string |
tag |
string |
tag identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_organization
Remove organization.
| Parameters | Type | Description |
|---|---|---|
organization |
string |
organization identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_organization_members
Remove user(s) from an organization.
| Parameters | Type | Description |
|---|---|---|
organization |
string |
organization identification string |
users |
string |
comma-separated list of user identification strings |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_organization_permission
Remove a user permission from an organization.
| Parameters | Type | Description |
|---|---|---|
organization |
string |
organization identification string |
permission |
string |
permission level (view / report / control / modify / grant / admin) |
user |
string |
user identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_organization_tag
Remove a tag attachment from an organization.
| Parameters | Type | Description |
|---|---|---|
organization |
string |
organization identification string |
tag |
string |
tag identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_organization_webhook
Remove organizational webhook.
| Parameters | Type | Description |
|---|---|---|
organization |
string |
organization identification string |
webhook |
string |
webhook identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_question
Permanently delete a Quiz question.
| Parameters | Type | Description |
|---|---|---|
id |
string |
external unique question identifier |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_quiz
Remove/archive Quiz set.
| Parameters | Type | Description |
|---|---|---|
quiz |
string |
Quiz identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_quiz_permission
Remove a user permission from a quiz.
| Parameters | Type | Description |
|---|---|---|
permission |
string |
permission level (view / report / control / modify / grant / admin) |
quiz |
string |
Quiz identification string |
user |
string |
user identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_quiz_questions
Remove question(s) from a Quiz set, or one of its question group.
| Parameters | Type | Description |
|---|---|---|
questions |
string |
comma-separated list of question identification strings |
quiz |
string |
Quiz identification string |
group |
string optional |
question group title |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_quiz_tag
Remove a tag attachment from a Quiz.
| Parameters | Type | Description |
|---|---|---|
quiz |
string |
Quiz identification string |
tag |
string |
tag identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_scorm_permission
Remove a user permission from a SCORM learning material.
| Parameters | Type | Description |
|---|---|---|
permission |
string |
permission level (view / report / control / modify / grant / admin) |
scorm |
string |
SCORM identification string |
user |
string |
user identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_scorm_tag
Remove a tag attachment from a SCORM learning material.
| Parameters | Type | Description |
|---|---|---|
scorm |
string |
SCORM identification string |
tag |
string |
tag identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_tag_permission
Remove a user permission from a tag.
| Parameters | Type | Description |
|---|---|---|
permission |
string |
permission level (view / report / control / modify / grant / admin) |
tag |
string |
tag identification string |
user |
string |
user identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_user
Delete user.
| Parameters | Type | Description |
|---|---|---|
user |
string |
user identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_user_assume
Revoke assume token.
| Parameters | Type | Description |
|---|---|---|
token |
string |
assume token |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_user_classes
Remove user from class(es).
| Parameters | Type | Description |
|---|---|---|
classes |
string |
comma-separated list of class identification strings |
user |
string |
user identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_user_login
Delete a previously generated login link.
| Parameters | Type | Description |
|---|---|---|
url |
string |
generated login link to be invalidated |
user |
string |
user identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_user_organizations
Remove user from organization(s).
| Parameters | Type | Description |
|---|---|---|
organizations |
string |
comma-separated list of organization identification strings |
user |
string |
user identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_video_permission
Remove a user permission from a video.
| Parameters | Type | Description |
|---|---|---|
permission |
string |
permission level (view / report / control / modify / grant / admin) |
user |
string |
user identification string |
video |
string |
video identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_delete_video_tag
Remove a tag attachment from a video.
| Parameters | Type | Description |
|---|---|---|
tag |
string |
tag identification string |
video |
string |
video identification string |
This tool may perform destructive updates.
This tool is idempotent. Repeated calls with same args have no additional effect.
This tool interacts with external entities.
Tool: edubase_filebin
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.
| Parameters | Type | Description |
|---|---|---|
filebin |
string |
valid EduBase temporary filebin URL |
filename |
string |
the original file name (including extension) |
source |
string |
file URL or local (absolute) file path on user computer |
This tool interacts with external entities.
Tool: edubase_get_class
Get/check class.
| Parameters | Type | Description |
|---|---|---|
class |
string |
class identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_class_assignments
List all assignments in a class.
| Parameters | Type | Description |
|---|---|---|
class |
string |
class identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_class_members
List all members in a class.
| Parameters | Type | Description |
|---|---|---|
class |
string |
class identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_class_permission
Check if a user has permission on a class.
| Parameters | Type | Description |
|---|---|---|
class |
string |
class identification string |
permission |
string |
permission level (view / report / control / modify / grant / admin) |
user |
string |
user identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_class_tag
Check if tag is attached to a class.
| Parameters | Type | Description |
|---|---|---|
class |
string |
class identification string |
tag |
string |
tag identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_class_tags
List all attached tags of a class.
| Parameters | Type | Description |
|---|---|---|
class |
string |
class identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_classes
List owned and managed classes.
| Parameters | Type | Description |
|---|---|---|
limit |
integer optional |
limit number of results (default: 16) |
page |
integer optional |
page number (default: 1), not used in search mode! |
search |
string optional |
search string to filter results |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_course_permission
Check if a user has permission on a course.
| Parameters | Type | Description |
|---|---|---|
course |
string |
course identification string |
permission |
string |
permission level (view / report / control / modify / grant / admin) |
user |
string |
user identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_course_tag
Check if tag is attached to a course.
| Parameters | Type | Description |
|---|---|---|
course |
string |
course identification string |
tag |
string |
tag identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_course_tags
List all attached tags of a course.
| Parameters | Type | Description |
|---|---|---|
course |
string |
course identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_event_permission
Check if a user has permission on an event.
| Parameters | Type | Description |
|---|---|---|
event |
string |
event identification string |
permission |
string |
permission level (view / report / control / modify / finances / grant / admin) |
user |
string |
user identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_event_tag
Check if tag is attached to an event.
| Parameters | Type | Description |
|---|---|---|
event |
string |
event identification string |
tag |
string |
tag identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_event_tags
List all attached tags of an event.
| Parameters | Type | Description |
|---|---|---|
event |
string |
event identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_exam
Get/check exam.
| Parameters | Type | Description |
|---|---|---|
exam |
string |
exam identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_exam_branding
Get exam branding configuration.
| Parameters | Type | Description |
|---|---|---|
exam |
string |
exam identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_exam_certificates_user
Get (the latest) certificate details for a specific exam and user.
| Parameters | Type | Description |
|---|---|---|
exam |
string |
exam identification string |
user |
string |
user identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_exam_permission
Check if a user has permission on an exam.
| Parameters | Type | Description |
|---|---|---|
exam |
string |
exam identification string |
permission |
string |
permission level (view / report / control / modify / grant / admin) |
user |
string |
user identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_exam_results_raw
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!
| Parameters | Type | Description |
|---|---|---|
exam |
string |
exam identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_exam_results_user
Get user results for a specific exam.
| Parameters | Type | Description |
|---|---|---|
exam |
string |
exam identification string |
user |
string |
user identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_exam_tag
Check if tag is attached to an exam.
| Parameters | Type | Description |
|---|---|---|
exam |
string |
exam identification string |
tag |
string |
tag identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_exam_tags
List all attached tags of an exam.
| Parameters | Type | Description |
|---|---|---|
exam |
string |
exam identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_exam_users
List all users on an exam.
| Parameters | Type | Description |
|---|---|---|
exam |
string |
exam identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_exams
List owned and managed exams. Exams are the highest level in the EduBase Quiz hierarchy, built from Quiz sets.
| Parameters | Type | Description |
|---|---|---|
active |
string optional |
optional filter to only include active exams (if true) or inactive exams (if false) |
limit |
integer optional |
limit number of results (default: 16) |
page |
integer optional |
page number (default: 1), not used in search mode! |
search |
string optional |
search string to filter results |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_integration
Get/check integration.
| Parameters | Type | Description |
|---|---|---|
integration |
string |
integration identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_integration_keys
Get integration keys/secrets.
| Parameters | Type | Description |
|---|---|---|
integration |
string |
integration identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_integration_permission
Check if a user has permission on an integration.
| Parameters | Type | Description |
|---|---|---|
integration |
string |
integration identification string |
permission |
string |
permission level (view / report / control / modify / grant / admin) |
user |
string |
user identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_integration_tag
Check if tag is attached to an integration.
| Parameters | Type | Description |
|---|---|---|
integration |
string |
integration identification string |
tag |
string |
tag identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_integration_tags
List all attached tags of an integration.
| Parameters | Type | Description |
|---|---|---|
integration |
string |
integration identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_integrations
List owned and managed integrations.
| Parameters | Type | Description |
|---|---|---|
limit |
integer optional |
limit number of results (default: 16) |
page |
integer optional |
page number (default: 1), not used in search mode! |
search |
string optional |
search string to filter results |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_organization
Get/check organization.
| Parameters | Type | Description |
|---|---|---|
organization |
string |
organization identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_organization_members
List all members in an organization.
| Parameters | Type | Description |
|---|---|---|
organization |
string |
organization identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_organization_permission
Check if a user has permission on an organization.
| Parameters | Type | Description |
|---|---|---|
organization |
string |
organization identification string |
permission |
string |
permission level (view / report / control / modify / grant / admin) |
user |
string |
user identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_organization_tag
Check if tag is attached to an organization.
| Parameters | Type | Description |
|---|---|---|
organization |
string |
organization identification string |
tag |
string |
tag identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_organization_tags
List all attached tags of an organization.
| Parameters | Type | Description |
|---|---|---|
organization |
string |
organization identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_organization_webhook
Get/check webhook configured in organization.
| Parameters | Type | Description |
|---|---|---|
organization |
string |
organization identification string |
webhook |
string |
webhook identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_organizations
List owned and managed organizations.
| Parameters | Type | Description |
|---|---|---|
limit |
integer optional |
limit number of results (default: 16) |
page |
integer optional |
page number (default: 1), not used in search mode! |
search |
string optional |
search string to filter results |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_question
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!
| Parameters | Type | Description |
|---|---|---|
id |
string |
external unique question identifier |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_question_id
Get external unique question identifier by question identification string.
| Parameters | Type | Description |
|---|---|---|
question |
string |
question identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_questions
List owned and managed Quiz questions.
| Parameters | Type | Description |
|---|---|---|
limit |
integer optional |
limit number of results (default: 16) |
page |
integer optional |
page number (default: 1), not used in search mode! |
search |
string optional |
search string to filter results |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_quiz
Get/check Quiz set. Containing questions and powering Exams.
| Parameters | Type | Description |
|---|---|---|
quiz |
string |
Quiz identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_quiz_permission
Check if a user has permission on a quiz.
| Parameters | Type | Description |
|---|---|---|
permission |
string |
permission level (view / report / control / modify / grant / admin) |
quiz |
string |
Quiz identification string |
user |
string |
user identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_quiz_questions
List all questions and question groups in a Quiz set. Quiz sets contain questions (lowest level) and can be used by exams (highest level).
| Parameters | Type | Description |
|---|---|---|
quiz |
string |
Quiz identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_quiz_results_play
Get detailed results for a specific Quiz play.
| Parameters | Type | Description |
|---|---|---|
play |
string |
Quiz play identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_quiz_results_user
Get user results for a specific Quiz set.
| Parameters | Type | Description |
|---|---|---|
quiz |
string |
Quiz set identification string |
user |
string |
user identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_quiz_tag
Check if tag is attached to a Quiz.
| Parameters | Type | Description |
|---|---|---|
quiz |
string |
Quiz identification string |
tag |
string |
tag identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_quiz_tags
List all attached tags of a Quiz.
| Parameters | Type | Description |
|---|---|---|
quiz |
string |
Quiz identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_quizes
List owned and managed Quiz sets. Quiz sets are named collections of questions that sit at the middle level of the EduBase Quiz hierarchy.
| Parameters | Type | Description |
|---|---|---|
limit |
integer optional |
limit number of results (default: 16) |
page |
integer optional |
page number (default: 1), not used in search mode! |
search |
string optional |
search string to filter results |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_scorm_permission
Check if a user has permission on a SCORM learning material.
| Parameters | Type | Description |
|---|---|---|
permission |
string |
permission level (view / report / control / modify / grant / admin) |
scorm |
string |
SCORM identification string |
user |
string |
user identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_scorm_tag
Check if tag is attached to a SCORM learning material.
| Parameters | Type | Description |
|---|---|---|
scorm |
string |
SCORM identification string |
tag |
string |
tag identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_scorm_tags
List all attached tags of a SCORM learning material.
| Parameters | Type | Description |
|---|---|---|
scorm |
string |
SCORM identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_tag
Get/check tag.
| Parameters | Type | Description |
|---|---|---|
tag |
string |
tag identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_tag_permission
Check if a user has permission on a tag.
| Parameters | Type | Description |
|---|---|---|
permission |
string |
permission level (view / report / control / modify / grant / admin) |
tag |
string |
tag identification string |
user |
string |
user identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_tags
List owned and managed tags.
| Parameters | Type | Description |
|---|---|---|
limit |
integer optional |
limit number of results (default: 16) |
page |
integer optional |
page number (default: 1), not used in search mode! |
search |
string optional |
search string to filter results |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_user
Get/check user.
| Parameters | Type | Description |
|---|---|---|
user |
string |
User identification string. Use 'me' to get the current user, but prefer /user:me endpoint instead. |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_user_classes
List all classes a user is member of.
| Parameters | Type | Description |
|---|---|---|
user |
string |
user identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_user_group
Get user's group.
| Parameters | Type | Description |
|---|---|---|
user |
string |
user identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_user_login
Get latest valid login link for user.
| Parameters | Type | Description |
|---|---|---|
user |
string |
user identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_user_me
Get/check current user.
Tool: edubase_get_user_name
Get user's name.
| Parameters | Type | Description |
|---|---|---|
user |
string |
user identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_user_organizations
List all organizations a user is member of.
| Parameters | Type | Description |
|---|---|---|
user |
string |
user identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_user_search
Lookup user by email, username or code.
| Parameters | Type | Description |
|---|---|---|
query |
string |
query string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_users
List managed, non-generated users.
| Parameters | Type | Description |
|---|---|---|
limit |
integer optional |
limit number of results (default: 16) |
page |
integer optional |
page number (default: 1), not used in search mode! |
search |
string optional |
search string to filter results |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_video_permission
Check if a user has permission on a video.
| Parameters | Type | Description |
|---|---|---|
permission |
string |
permission level (view / report / control / modify / grant / admin) |
user |
string |
user identification string |
video |
string |
video identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_video_tag
Check if tag is attached to a video.
| Parameters | Type | Description |
|---|---|---|
tag |
string |
tag identification string |
video |
string |
video identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_get_video_tags
List all attached tags of a video.
| Parameters | Type | Description |
|---|---|---|
video |
string |
video identification string |
This tool is read-only. It does not modify its environment.
This tool interacts with external entities.
Tool: edubase_mcp_server_api
Get the MCP server API URL (only use for debugging).
Tool: edubase_mcp_server_version
Get the MCP server version (only use for debugging).
Tool: edubase_patch_integration
Update integration.
| Parameters | Type | Description |
|---|---|---|
integration |
string |
integration identification string |
active |
boolean optional |
enable or disable the integration |
This tool interacts with external entities.
Tool: edubase_patch_organization
Update organization.
| Parameters | Type | Description |
|---|---|---|
organization |
string |
organization identification string |
This tool interacts with external entities.
Tool: edubase_patch_organization_webhook
Update organizational webhook.
| Parameters | Type | Description |
|---|---|---|
organization |
string |
organization identification string |
webhook |
string |
webhook identification string |
active |
boolean optional |
enable or disable webhook |
This tool interacts with external entities.
Tool: edubase_patch_user
Update user.
| Parameters | Type | Description |
|---|---|---|
user |
string |
user identification string |
active |
boolean optional |
enable or disable user |
This tool interacts with external entities.
Tool: edubase_post_class_members
Assign user(s) to a class. Updates memberships if already member of the class.
| Parameters | Type | Description |
|---|---|---|
class |
string |
class identification string |
users |
string |
comma-separated list of user identification strings |
expires |
string optional |
expiry in days or YYYY-MM-DD HH:ii:ss |
notify |
boolean optional |
notify users (default: false) |
This tool interacts with external entities.
Tool: edubase_post_class_permission
Create new permission for a user on a class.
| Parameters | Type | Description |
|---|---|---|
class |
string |
class identification string |
permission |
string |
permission level (view / report / control / modify / grant / admin) |
user |
string |
user identification string |
This tool interacts with external entities.
Tool: edubase_post_class_tag
Attach tag to a class.
| Parameters | Type | Description |
|---|---|---|
class |
string |
class identification string |
tag |
string |
tag identification string |
This tool interacts with external entities.
Tool: edubase_post_class_transfer
Transfer class to user.
| Parameters | Type | Description |
|---|---|---|
class |
string |
class identification string |
user |
string |
user identification string |
This tool interacts with external entities.
Tool: edubase_post_classes_members
Assign user(s) to class(es). Updates memberships if already member of a class.
| Parameters | Type | Description |
|---|---|---|
classes |
string |
comma-separated list of class identification strings |
users |
string |
comma-separated list of user identification strings |
expires |
string optional |
expiry in days or YYYY-MM-DD HH:ii:ss |
notify |
boolean optional |
notify users (default: false) |
This tool interacts with external entities.
Tool: edubase_post_course_permission
Create new permission for a user on a course.
| Parameters | Type | Description |
|---|---|---|
course |
string |
course identification string |
permission |
string |
permission level (view / report / control / modify / grant / admin) |
user |
string |
user identification string |
This tool interacts with external entities.
Tool: edubase_post_course_tag
Attach tag to a course.
| Parameters | Type | Description |
|---|---|---|
course |
string |
course identification string |
tag |
string |
tag identification string |
This tool interacts with external entities.
Tool: edubase_post_course_transfer
Transfer course to user.
| Parameters | Type | Description |
|---|---|---|
course |
string |
course identification string |
user |
string |
user identification string |
This tool interacts with external entities.
Tool: edubase_post_event_permission
Create new permission for a user on an event.
| Parameters | Type | Description |
|---|---|---|
event |
string |
event identification string |
permission |
string |
permission level (view / report / control / modify / finances / grant / admin) |
user |
string |
user identification string |
This tool interacts with external entities.
Tool: edubase_post_event_tag
Attach tag to an event.
| Parameters | Type | Description |
|---|---|---|
event |
string |
event identification string |
tag |
string |
tag identification string |
This tool interacts with external entities.
Tool: edubase_post_event_transfer
Transfer event to user.
| Parameters | Type | Description |
|---|---|---|
event |
string |
event identification string |
user |
string |
user identification string |
This tool interacts with external entities.
Tool: edubase_post_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.
| Parameters | Type | Description |
|---|---|---|
close |
string |
exam end time (in YYYY-MM-DD HH:ii:ss format) |
open |
string |
exam start time (in YYYY-MM-DD HH:ii:ss format) |
quiz |
string |
the Quiz set (specified using the Quiz identification string) the exam is attached to |
title |
string |
title of the exam |
copy_settings |
string optional |
optional exam identification string to copy settings from |
id |
string optional |
external unique exam identifier |
keep_certificate_settings |
boolean optional |
whether to keep certificate settings from the copied exam (default: false) |
language |
string optional |
desired exam language |
type |
string optional |
type of the exam (default: exam) |
This tool interacts with external entities.
Tool: edubase_post_exam_branding
Configure or update exam branding.
| Parameters | Type | Description |
|---|---|---|
color |
string |
branding color |
exam |
string |
exam identification string |
image |
string |
branding image, either a base64-encoded image or a URL, supported formats: PNG, JPEG, WebP |
type |
string optional |
branding image type (foreground: image is used as a logo, background: image is used as a cover), default: foreground |
This tool interacts with external entities.
Tool: edubase_post_exam_certificates_user_download
Generate download link for the latest user exam certificate. If a previous valid link exists, it will be returned instead.
| Parameters | Type | Description |
|---|---|---|
exam |
string |
exam identification string |
user |
string |
user identification string |
This tool interacts with external entities.
Tool: edubase_post_exam_permission
Create new permission for a user on an exam.
| Parameters | Type | Description |
|---|---|---|
exam |
string |
exam identification string |
permission |
string |
permission level (view / report / control / modify / grant / admin) |
user |
string |
user identification string |
This tool interacts with external entities.
Tool: edubase_post_exam_summary
Submit a new AI exam summary.
| Parameters | Type | Description |
|---|---|---|
exam |
string |
exam identification string |
summary |
string |
summary text (basic HTML formatting allowed, keep concise, avoid personal information) |
language |
string optional |
summary language |
llm |
string optional |
name of the Large Language Model used to generate the summary (preferred: openai / claude / gemini) |
model |
string optional |
exact LLM model name used to generate the summary (requires llm) |
type |
string optional |
type of summary (default: ai) |
This tool interacts with external entities.
Tool: edubase_post_exam_tag
Attach tag to an exam.
| Parameters | Type | Description |
|---|---|---|
exam |
string |
exam identification string |
tag |
string |
tag identification string |
This tool interacts with external entities.
Tool: edubase_post_exam_transfer
Transfer exam to user.
| Parameters | Type | Description |
|---|---|---|
exam |
string |
exam identification string |
user |
string |
user identification string |
This tool interacts with external entities.
Tool: edubase_post_exam_users
Assign user(s) to an exam.
| Parameters | Type | Description |
|---|---|---|
exam |
string |
exam identification string |
users |
string |
comma-separated list of user identification strings |
This tool interacts with external entities.
Tool: edubase_post_filebin_upload
Generate upload link for a temporary file storage.
| Parameters | Type | Description |
|---|---|---|
type |
string |
type of file to be uploaded (IMAGE/AUDIO/SCORM/FILE) |
force |
boolean optional |
force new link for another file even if a previous valid link exists |
This tool interacts with external entities.
Tool: edubase_post_integration
Create a new API or LMS integration.
| Parameters | Type | Description |
|---|---|---|
title |
string |
title of the integration |
description |
string optional |
optional short description |
lti |
string optional |
LTI version, required for LMS integrations |
platform |
string optional |
LMS platform URL, only necessary for LMS integrations! |
type |
string optional |
type of the integration (default: api) |
This tool interacts with external entities.
Tool: edubase_post_integration_keys
Rotate integration keys/secrets.
| Parameters | Type | Description |
|---|---|---|
integration |
string |
integration identification string |
This tool interacts with external entities.
Tool: edubase_post_integration_permission
Create new permission for a user on an integration.
| Parameters | Type | Description |
|---|---|---|
integration |
string |
integration identification string |
permission |
string |
permission level (view / report / control / modify / grant / admin) |
user |
string |
user identification string |
This tool interacts with external entities.
Tool: edubase_post_integration_tag
Attach tag to an integration.
| Parameters | Type | Description |
|---|---|---|
integration |
string |
integration identification string |
tag |
string |
tag identification string |
This tool interacts with external entities.
Tool: edubase_post_integration_transfer
Transfer integration to user.
| Parameters | Type | Description |
|---|---|---|
integration |
string |
integration identification string |
user |
string |
user identification string |
This tool interacts with external entities.
Tool: edubase_post_metrics_custom
Update a custom metric.
| Parameters | Type | Description |
|---|---|---|
metric |
string |
metric name |
value |
string |
target value (also accepts increments with a + prefix) |
This tool interacts with external entities.
Tool: edubase_post_organization
Create an organization.
| Parameters | Type | Description |
|---|---|---|
name |
string |
title of the organization |
description |
string optional |
optional short description |
domain |
string optional |
domain name (FQDN) for the organization without www prefix, needs special privileges to set! |
email |
string optional |
contact email address |
phone |
string optional |
contact phone number |
website |
string optional |
homepage URL |
This tool interacts with external entities.
Tool: edubase_post_organization_members
Assign user(s) to an organization. Updates memberships if already member of the organization.
| Parameters | Type | Description |
|---|---|---|
organization |
string |
organization identification string |
users |
string |
comma-separated list of user identification strings |
department |
string optional |
optional name of department |
notify |
boolean optional |
notify users (default: false) |
permission_content |
string optional |
optional permission level to contents in organization (none / view / report / control / modify / grant / admin) (default: none) |
permission_organization |
string optional |
optional permission level to organization (member / teacher / reporter / supervisor / admin) (default: member) |
This tool interacts with external entities.
Tool: edubase_post_organization_permission
Create new permission for a user on an organization.
| Parameters | Type | Description |
|---|---|---|
organization |
string |
organization identification string |
permission |
string |
permission level (view / report / control / modify / grant / admin) |
user |
string |
user identification string |
This tool interacts with external entities.
Tool: edubase_post_organization_tag
Attach tag to an organization.
| Parameters | Type | Description |
|---|---|---|
organization |
string |
organization identification string |
tag |
string |
tag identification string |
This tool interacts with external entities.
Tool: edubase_post_organization_transfer
Transfer organization to user.
| Parameters | Type | Description |
|---|---|---|
organization |
string |
organization identification string |
user |
string |
user identification string |
This tool interacts with external entities.
Tool: edubase_post_organization_webhook
Create a webhook for an organization.
| Parameters | Type | Description |
|---|---|---|
endpoint |
string |
URL to send webhook notifications to |
name |
string |
title of the webhook |
organization |
string |
organization identification string |
trigger_event |
string |
Type of event to trigger webhook: - exam-play-result: triggers when a user (must be member of the organization) completes an exam in the organization - quiz-play-result: triggers when a user (must be member of the organization) completes a quiz in practice mode in the organization - api: triggers when a manual API call is made (useful for testing and debugging) |
authentication |
string optional |
Type of authentication (default: none): - none: no authentication - key: use a secret key (or password) for authentication |
authentication_key |
string optional |
secret key (or password) to use for authentication, required if authentication is set to key |
authentication_key_custom |
string optional |
custom field name to use as the authentication key, required if authentication is set to key, mutually exclusive with authentication_key |
authentication_send |
string optional |
How to send authentication data (default: data): - header: as header field - bearer: as Bearer token in Authorization header - data: as data field (in body or query string) |
authentication_send_data |
string optional |
name of data field to send authentication data in, required if authentication is set to key and authentication_send is set to data |
authentication_send_header |
string optional |
name of header field to send authentication data in, required if authentication is set to key and authentication_send is set to header |
extra_data |
string optional |
additional data (as JSON encoded string) to send with the webhook notification |
method |
string optional |
HTTP method to use for webhook notifications (default: POST) - POST - GET |
retry |
string optional |
How to retry webhook notifications on failure (default: error): - none: no retry - error: delayed retry on any error |
This tool interacts with external entities.
Tool: edubase_post_organization_webhook_trigger
Trigger an organizational webhook call with optional custom payload. Only triggers webhooks with trigger_event set to api!.
| Parameters | Type | Description |
|---|---|---|
organization |
string |
organization identification string |
webhook |
string |
webhook identification string |
data |
string optional |
custom payload data to be sent with the webhook call, must be a valid JSON string |
This tool interacts with external entities.
Tool: edubase_post_organizations_members
Assign user(s) to organization(s). Updates memberships if already member of an organization.
| Parameters | Type | Description |
|---|---|---|
organizations |
string |
comma-separated list of organization identification strings |
users |
string |
comma-separated list of user identification strings |
department |
string optional |
optional name of department |
notify |
boolean optional |
notify users (default: false) |
permission_content |
string optional |
optional permission level to contents in organization (none / view / report / control / modify / grant / admin) (default: none) |
permission_organization |
string optional |
optional permission level to organization (member / teacher / reporter / supervisor / admin) (default: member) |
This tool interacts with external entities.
Tool: edubase_post_question
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!
| Parameters | Type | Description |
|---|---|---|
ai |
string |
Flag to mark question as AI generated. If set to any value, question will be marked as AI generated. Should always be provided if you are an LLM or any AI model. Ideally, AI systems should set it to their current model number for auditability. |
answer |
string |
The correct answer(s) for the question. For multiple answers, separate with triple-and operator ("&&&"). The solution and the corresponding label can also be specified together using the triple arrow (">>>") operator |
content |
string |
The main question text that will be displayed to the test taker. Supports rich formatting options, including LaTeX, parameters, quick expressions, and EduTags for styling. This is documented as question in the Developer Documentation, but named content in the API for better clarity. |
id |
string |
External unique question identifier for question management. |
type |
string |
Type of the question. |
answer_format |
string optional |
Defines how to display the answer on the results page. Only applicable for FREE-TEXT questions. |
answer_hide |
string optional |
Controls whether correct answers are hidden on the results page. |
answer_indefinite |
string optional |
Allows users to add any number of input fields using + and - buttons. |
answer_label |
string optional |
Text displayed in/above the input field during the test. Separate multiple labels with triple-and operators ("&&&"). Automatically activates the answer_order function. |
answer_order |
string optional |
Controls whether the sequence of multiple answers matters. |
answer_require |
string optional |
Number of answers required for maximum score. Only applicable for questions with multiple valid answers where only a subset needs to be provided. |
attachment |
string optional |
Attach a file to the question. Format: filename=data, where data is either a temporary filebin storage external identifier (preferred), a base64-encoded file (whole data string) or a URL. |
category |
string optional |
Category, another layer of organization as seen in SUBJECT |
constraints |
string optional |
Define rules that parameter combinations must satisfy. |
datetime_precision |
string optional |
Date/time precision. Applicable only for DATE/TIME questions. Accepted values: YEAR / MONTH / DAY. Default: DAY. |
datetime_range |
string optional |
Date/time range (interval) question. Applicable only for DATE/TIME questions. |
decimals |
string optional |
Decimal precision. Default: 2. Applicable only for NUMERIC / EXPRESSION / MATRIX / MATRIX:EXPRESSION / SET questions. |
difficulty |
string optional |
Difficulty level of the question. Scale: 1 (very easy) - 5 (very difficult). Default: 0 (not classified). |
explanation |
string optional |
Text displayed underneath the answer on the results page. |
expression_check |
string optional |
Define how expressions should be validated (RANDOM, EXPLICIT, COMPARE). Default: RANDOM. |
expression_decimals |
string optional |
Sets precision for decimal calculations. Default: 2. |
expression_explicit_goal |
string optional |
Define exact value pairs (format: [x;f(x)]). Format for multiple variables: [x;y;z;...;f(x,y,z,...)]. Multiple pairs: separate with triple-and operators ("&&&"). Only applicable when expression_check=EXPLICIT. |
expression_extended |
string optional |
Enable additional mathematical functions. Activates support for custom base logarithms (e.g., log2(4)). Enables factorial operations (e.g., 5!, 1!+2!+3!). |
expression_functions |
string optional |
Controls whether functions can be used in user inputs. Default: +. |
expression_random_inside |
string optional |
Require values within specific intervals (format: [start-end]). Multiple intervals: separate with triple-or operators (" |
expression_random_outside |
string optional |
Exclude values from specific intervals (format: [start-end]). Multiple intervals: separate with triple-or operators (" |
expression_random_range |
string optional |
Define value generation ranges (format: [min-max]). Specify per variable with triple-and operators ("&&&"). Only applicable when expression_check=RANDOM. |
expression_random_tries |
string optional |
Number of validation points. Default: 5. Only applicable when expression_check=RANDOM. |
expression_random_type |
string optional |
Type of generated test values (INTEGER, FLOAT). Specify per variable with triple-and operators ("&&&"). Only applicable when expression_check=RANDOM. |
expression_variable |
string optional |
Specifies variable names used in expressions (separate multiple variables with &&&). Default: x. |
file_count |
string optional |
Limit the number of files that can be uploaded. Applicable only for FILE questions. Integer between 1-25. |
file_types |
string optional |
Limit the filetypes that can be uploaded. Applicable only for FILE questions. File extensions separated by triple-and operators ("&&&"). |
freetext_characters |
string optional |
Limit the number of characters that can be entered. Applicable only for FREE-TEXT questions. Format: minimum-maximum, but you can specify only a minimum or maximum as well. Integers between 0-4000. |
freetext_rules |
string optional |
Automatic evaluation of free text questions. Applicable only for FREE-TEXT questions. |
freetext_words |
string optional |
Limit the number of words that can be entered. Applicable only for FREE-TEXT questions. Format: minimum-maximum, but you can specify only a minimum or maximum as well. Integers between 0-4000. |
graph |
string optional |
Attach a graph to the question. |
group |
string optional |
Add a question to a question group in a Quiz set. If the group doesn't exist, it will be created automatically as a complex task with default settings. Only applicable when uploading directly to a Quiz set! Existing group settings will not be changed when adding more questions. |
grouping |
string optional |
Used with type=choice or type=multiple-choice when incorrect options should be pulled from other questions assigned to the same grouping number. Not the same as type=grouping or the group field. |
hint |
string optional |
Questions to help (not solution steps, just guiding questions/notes). |
hint_penalty |
string optional |
Point deduction for using hints/solutions/videos during a test. |
hotspot_image |
string optional |
The image on which the points must be marked. Applicable only for HOTSPOT questions. Supported formats: PNG, JPEG, WebP. Format: filename=data, where data is either a temporary filebin storage external identifier (preferred), a base64-encoded image (whole data string) or a URL. |
hotspot_zones |
string optional |
Zones accepted as answers. Applicable only for HOTSPOT questions. |
image |
string optional |
Attach an image to the question. Supported formats: PNG, JPEG, WebP. Format: filename=data, where data is either a temporary filebin storage external identifier (preferred), a base64-encoded image (whole data string) or a URL. |
label |
string optional |
Categorize questions with instance-level labels. Pre-defined values specific to each EduBase instance. Multiple labels separated by triple-and operators ("&&&"). |
language |
string optional |
The language of the question, in Alpha-2 code format (according to ISO 639-1). |
main_category |
string optional |
The name of the category (for which CATEGORY will be a subcategory). |
manual_scoring |
string optional |
Controls when to enable manual scoring. Not applicable for READING and FREE-TEXT questions. |
maximum_choices |
string optional |
Maximum number of options the test taker can select. Only applicable for MULTIPLE-CHOICE questions. |
media_audio |
string optional |
Attach an audio file to the question. Supported formats: MP3, AAC, M4A. Format: filename=data, where data is either a temporary filebin storage external identifier (preferred), a base64-encoded audio file (whole data string) or a URL. |
media_video |
string optional |
Attach a video to the question. The video code of an existing EduBase video can be provided. |
note |
string optional |
The text that appears right below the question. |
numerical_range |
string optional |
Number range (interval) question. Only applicable for NUMERIC questions. |
options |
string optional |
Incorrect options or false statements for choice-based question types. Only applicable for CHOICE, MULTIPLE-CHOICE, and TRUE/FALSE questions. Separate multiple options with triple-and operators ("&&&"). |
options_fix |
string optional |
Controls the arrangement of answers and options. |
options_order |
string optional |
Define exact presentation order of answers and options. |
parameters |
string optional |
Parameter definitions for dynamic question generation. Separate multiple parameters with triple-and operators ("&&&"). Up to 128 parameters can be defined! |
parameters_sync |
string optional |
Controls synchronization of LIST parameter selections. |
path |
string optional |
Path where question will be stored in personal QuestionBase. |
penalty_points |
string optional |
Points deducted for completely incorrect answers. |
penalty_scoring |
string optional |
Controls how penalty points should be applied. |
points |
string optional |
Maximum points for a fully correct answer. Default: 1 point. |
private_note |
string optional |
Private notes (not shown to test takers). |
question_format |
string optional |
Controls question text rendering. |
solution |
string optional |
Step-by-step solution. |
solution_image |
string optional |
Attach an image to the solution steps. Supported formats: PNG, JPEG, WebP. Format: filename=data, where data is either a temporary filebin storage external identifier (preferred), a base64-encoded image (whole data string) or a URL. |
solution_penalty |
string optional |
Point deduction for viewing steps of the solution (NONE, ONCE:N%). Default: NONE. |
source |
string optional |
Specify source of question content (not shown to test takers). |
subject |
string optional |
Subject classification for organizing questions. |
subpoints |
string optional |
Define specific point values for each answer in percentages. Only used when subscoring=CUSTOM. Specify percentage values separated by triple-and operators ("&&&"). Not applicable for CHOICE, READING and FREE-TEXT questions. Values should sum to 100 (for percentage). |
subscoring |
string optional |
Method for calculating partial credit for partially correct answers. Not applicable for CHOICE, READING and FREE-TEXT questions. |
tags |
string optional |
Tag questions with custom user-defined tags. Use ID or code of pre-registered tags. Multiple tags separated by triple-and operators ("&&&"). |
tolerance |
string optional |
Evaluation tolerance method. Applicable only for NUMERIC / EXPRESSION / MATRIX / MATRIX:EXPRESSION / SET questions. |
truefalse_third_options |
string optional |
Activate the third option for TRUE/FALSE questions. Plus sign (+) to display the third option OR specify options separated by triple-and operators ("&&&") to automatically enable the feature. |
truefalse_third_options_label |
string optional |
Label of the third option for TRUE/FALSE questions. If blank, the text "none" is displayed (default). Only applicable when TRUEFALSE_THIRD_OPTIONS is enabled. |
video |
string optional |
EduBase video to help solve the question, revealed on demand. The video code of an existing EduBase video can be provided. |
video_penalty |
string optional |
Point deduction for video assistance used (NONE, ONCE:N%). Default: NONE. |
This tool interacts with external entities.
Tool: edubase_post_question_export
Generate download link for exporting the question (in JSON format). If a previous valid link exists, it will be returned instead.
| Parameters | Type | Description |
|---|---|---|
id |
string |
external unique question identifier |
This tool interacts with external entities.
Tool: edubase_post_question_id
Set external unique question identifier for question identified by a question identification string.
| Parameters | Type | Description |
|---|---|---|
id |
string |
external unique question identifier |
question |
string |
question identification string |
This tool interacts with external entities.
Tool: edubase_post_quiz
Create a new Quiz set. Quiz sets are collections of questions that can be used for practice or to power multiple Exams.
| Parameters | Type | Description |
|---|---|---|
title |
string |
title of the Quiz set |
copy_questions |
string optional |
optional Quiz set identification string to copy questions from |
copy_settings |
string optional |
optional Quiz set identification string to copy settings from |
description |
string optional |
short description |
id |
string optional |
External unique Quiz identifier. Should be maximum 64 characters long! |
language |
string optional |
desired Quiz set language |
mode |
string optional |
Sets how questions are displayed during the Quiz. (default: TEST) - TEST: all questions are displayed at once, user can answer them in any order and switch between them - TURNS: questions are displayed one by one, only one question is visible at a time and the user must answer it before moving to the next question |
type |
string optional |
Type of the Quiz set. (default: set) - set: for practice purposes - exam: for exam purposes - private: for private purposes (e.g testing) |
This tool interacts with external entities.
Tool: edubase_post_quiz_permission
Create new permission for a user on a quiz.
| Parameters | Type | Description |
|---|---|---|
permission |
string |
permission level (view / report / control / modify / grant / admin) |
quiz |
string |
Quiz identification string |
user |
string |
user identification string |
This tool interacts with external entities.
Tool: edubase_post_quiz_questions
Assign question(s) to a Quiz set, or one of its question group. Questions can exist independently from Quiz sets.
| Parameters | Type | Description |
|---|---|---|
questions |
string |
comma-separated list of question identification strings |
quiz |
string |
Quiz identification string |
group |
string optional |
question group title |
This tool interacts with external entities.
Tool: edubase_post_quiz_tag
Attach tag to a Quiz.
| Parameters | Type | Description |
|---|---|---|
quiz |
string |
Quiz identification string |
tag |
string |
tag identification string |
This tool interacts with external entities.
Tool: edubase_post_quiz_transfer
Transfer Quiz to user.
| Parameters | Type | Description |
|---|---|---|
quiz |
string |
Quiz identification string |
user |
string |
user identification string |
This tool interacts with external entities.
Tool: edubase_post_scorm_permission
Create new permission for a user on a SCORM learning material.
| Parameters | Type | Description |
|---|---|---|
permission |
string |
permission level (view / report / control / modify / grant / admin) |
scorm |
string |
SCORM identification string |
user |
string |
user identification string |
This tool interacts with external entities.
Tool: edubase_post_scorm_tag
Attach tag to a SCORM learning material.
| Parameters | Type | Description |
|---|---|---|
scorm |
string |
SCORM identification string |
tag |
string |
tag identification string |
This tool interacts with external entities.
Tool: edubase_post_scorm_transfer
Transfer SCORM to user.
| Parameters | Type | Description |
|---|---|---|
scorm |
string |
SCORM identification string |
user |
string |
user identification string |
This tool interacts with external entities.
Tool: edubase_post_tag_permission
Create new permission for a user on a tag.
| Parameters | Type | Description |
|---|---|---|
permission |
string |
permission level (view / report / control / modify / grant / admin) |
tag |
string |
tag identification string |
user |
string |
user identification string |
This tool interacts with external entities.
Tool: edubase_post_tag_transfer
Transfer tag to user.
| Parameters | Type | Description |
|---|---|---|
tag |
string |
tag identification string |
user |
string |
user identification string |
This tool interacts with external entities.
Tool: edubase_post_user
Create new EduBase user account.
| Parameters | Type | Description |
|---|---|---|
email |
string |
valid email address |
first_name |
string |
first name (1-64 characters) |
last_name |
string |
last name (1-64 characters) |
username |
string |
username (4-64 characters) |
birthdate |
string optional |
date of birth |
color |
string optional |
desired favorite color (default/branding/red/blue/yellow/green/purple/gray) (default: default) |
display_name |
string optional |
override automatic display name (1-255 characters) |
exam |
boolean optional |
user is only allowed to login when accessing exams (default: false) |
full_name |
string optional |
override automatic full name (1-255 characters) |
gender |
string optional |
gender ("male", "female", or "other") |
group |
string optional |
name of the user group |
language |
string optional |
desired account language (default: API application owner's language) |
must_change_password |
boolean optional |
user is forced to change password on first login (default: false) |
notify |
boolean optional |
notify user via email (or SMS) (default: false) |
password |
string optional |
password (4-64 characters) (default: initial random password is automatically generated) |
phone |
string optional |
valid phone number in format "+prefix number" without special characters |
template |
string optional |
a template ID for the new account (default: none) |
timezone |
string optional |
desired timezone (default: API application owner's timezone) |
This tool interacts with external entities.
Tool: edubase_post_user_assume
Assume user for next requests with assume token.
| Parameters | Type | Description |
|---|---|---|
user |
string |
user identification string, username or email address |
password |
string optional |
password or user secret |
This tool interacts with external entities.
Tool: edubase_post_user_classes
Assign user to class(es). Updates membership if already member of a class.
| Parameters | Type | Description |
|---|---|---|
classes |
string |
comma-separated list of class identification strings |
user |
string |
user identification string |
expires |
string optional |
expiry in days or YYYY-MM-DD HH:ii:ss |
notify |
boolean optional |
notify user (default: false) |
This tool interacts with external entities.
Tool: edubase_post_user_group
Update a user's group.
| Parameters | Type | Description |
|---|---|---|
group |
string |
user group code |
user |
string |
user identification string |
This tool interacts with external entities.
Tool: edubase_post_user_login
Generate login link. If a valid link with the same settings exists, it will be returned instead of creating a new one.
| Parameters | Type | Description |
|---|---|---|
user |
string |
user identification string |
exam |
string optional |
the exam identification string to redirect the user to (mutually exclusive with redirect) |
expires |
string optional |
expiry in days (1-30) or YYYY-MM-DD (default: 1 day) |
logins |
integer optional |
total count the link can be used to login users (default: 1) |
redirect |
string optional |
redirect after a successful login (URI path or [{content_type}:{tag}]) |
short |
boolean optional |
generate shortened (eduba.se) link (only if feature is enabled on EduBase) (default: false) |
template |
string optional |
a template ID for the login link |
This tool interacts with external entities.
Tool: edubase_post_user_name
Update a user's name.
| Parameters | Type | Description |
|---|---|---|
first_name |
string |
first name (1-64 characters) |
last_name |
string |
last name (1-64 characters) |
user |
string |
user identification string |
display_name |
string optional |
display name (1-255 characters) |
full_name |
string optional |
full name (1-255 characters) |
This tool interacts with external entities.
Tool: edubase_post_user_organizations
Assign user to organization(s). Updates membership if already member of an organization.
| Parameters | Type | Description |
|---|---|---|
organizations |
string |
comma-separated list of organization identification strings |
user |
string |
user identification string |
department |
string optional |
optional name of department |
notify |
boolean optional |
notify user (default: false) |
permission_content |
string optional |
optional permission level to contents in organization (none / view / report / control / modify / grant / admin) (default: none) |
permission_organization |
string optional |
optional permission level to organization (member / teacher / reporter / supervisor / admin) (default: member) |
This tool interacts with external entities.
Tool: edubase_post_video_permission
Create new permission for a user on a video.
| Parameters | Type | Description |
|---|---|---|
permission |
string |
permission level (view / report / control / modify / grant / admin) |
user |
string |
user identification string |
video |
string |
video identification string |
This tool interacts with external entities.
Tool: edubase_post_video_tag
Attach tag to a video.
| Parameters | Type | Description |
|---|---|---|
tag |
string |
tag identification string |
video |
string |
video identification string |
This tool interacts with external entities.
Tool: edubase_post_video_transfer
Transfer video to user.
| Parameters | Type | Description |
|---|---|---|
user |
string |
user identification string |
video |
string |
video identification string |
This tool interacts with external entities.
Use this MCP Server
{
"mcpServers": {
"edubase": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"EDUBASE_API_APP",
"-e",
"EDUBASE_API_URL",
"-e",
"EDUBASE_API_KEY",
"mcp/edubase"
],
"env": {
"EDUBASE_API_APP": "YOUR_EDUBASE_API_APP",
"EDUBASE_API_URL": "YOUR_EDUBASE_API_URL",
"EDUBASE_API_KEY": "YOUR_EDUBASE_API_KEY"
}
}
}
}