@edubase/mcp 1.0.23

package/dist/tools/classes.js

@@ -0,0 +1,348 @@
+/* Tool definitions */
+export const EDUBASE_API_TOOLS_CLASSES = [
+    // GET /classes - List owned and managed classes
+    {
+        name: 'edubase_get_classes',
+        description: "List owned and managed classes.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                search: {
+                    type: 'string',
+                    description: 'search string to filter results',
+                },
+                limit: {
+                    type: 'number',
+                    description: 'limit number of results (default: 16)',
+                },
+                page: {
+                    type: 'number',
+                    description: 'page number (default: 1), not used in search mode!',
+                },
+            },
+            required: [],
+        },
+    },
+    // GET /class - Get/check class
+    {
+        name: 'edubase_get_class',
+        description: "Get/check class.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                class: {
+                    type: 'string',
+                    description: 'class identification string',
+                },
+            },
+            required: ['class'],
+        },
+    },
+    // GET /class:assignments - List all assignments in a class
+    {
+        name: 'edubase_get_class_assignments',
+        description: "List all assignments in a class.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                class: {
+                    type: 'string',
+                    description: 'class identification string',
+                },
+            },
+            required: ['class'],
+        },
+    },
+    // GET /class:members - List all members in a class
+    {
+        name: 'edubase_get_class_members',
+        description: "List all members in a class.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                class: {
+                    type: 'string',
+                    description: 'class identification string',
+                },
+            },
+            required: ['class'],
+        },
+    },
+    // POST /class:members - Assign user(s) to a class
+    {
+        name: 'edubase_post_class_members',
+        description: "Assign user(s) to a class. Updates memberships if already member of the class.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                class: {
+                    type: 'string',
+                    description: 'class identification string',
+                },
+                users: {
+                    type: 'string',
+                    description: 'comma-separated list of user identification strings',
+                },
+                expires: {
+                    type: 'string',
+                    description: 'expiry in days or YYYY-MM-DD HH:ii:ss',
+                },
+                notify: {
+                    type: 'boolean',
+                    description: 'notify users (default: false)',
+                },
+            },
+            required: ['class', 'users'],
+        },
+    },
+    // DELETE /class:members - Remove user(s) from a class
+    {
+        name: 'edubase_delete_class_members',
+        description: "Remove user(s) from a class.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                class: {
+                    type: 'string',
+                    description: 'class identification string',
+                },
+                users: {
+                    type: 'string',
+                    description: 'comma-separated list of user identification strings',
+                },
+            },
+            required: ['class', 'users'],
+        },
+    },
+    // POST /classes:members - Assign user(s) to class(es)
+    {
+        name: 'edubase_post_classes_members',
+        description: "Assign user(s) to class(es). Updates memberships if already member of a class.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                classes: {
+                    type: 'string',
+                    description: 'comma-separated list of class identification strings',
+                },
+                users: {
+                    type: 'string',
+                    description: 'comma-separated list of user identification strings',
+                },
+                expires: {
+                    type: 'string',
+                    description: 'expiry in days or YYYY-MM-DD HH:ii:ss',
+                },
+                notify: {
+                    type: 'boolean',
+                    description: 'notify users (default: false)',
+                },
+            },
+            required: ['classes', 'users'],
+        },
+    },
+    // GET /user:classes - List all classes a user is member of
+    {
+        name: 'edubase_get_user_classes',
+        description: "List all classes a user is member of.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                user: {
+                    type: 'string',
+                    description: 'user identification string',
+                },
+            },
+            required: ['user'],
+        },
+    },
+    // POST /user:classes - Assign user to class(es)
+    {
+        name: 'edubase_post_user_classes',
+        description: "Assign user to class(es). Updates membership if already member of a class.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                user: {
+                    type: 'string',
+                    description: 'user identification string',
+                },
+                classes: {
+                    type: 'string',
+                    description: 'comma-separated list of class identification strings',
+                },
+                expires: {
+                    type: 'string',
+                    description: 'expiry in days or YYYY-MM-DD HH:ii:ss',
+                },
+                notify: {
+                    type: 'boolean',
+                    description: 'notify user (default: false)',
+                },
+            },
+            required: ['user', 'classes'],
+        },
+    },
+    // DELETE /user:classes - Remove user from class(es)
+    {
+        name: 'edubase_delete_user_classes',
+        description: "Remove user from class(es).",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                user: {
+                    type: 'string',
+                    description: 'user identification string',
+                },
+                classes: {
+                    type: 'string',
+                    description: 'comma-separated list of class identification strings',
+                },
+            },
+            required: ['user', 'classes'],
+        },
+    },
+];
+/* Output schema definitions */
+export const EDUBASE_API_TOOLS_CLASSES_OUTPUT_SCHEMA = {
+    // GET /classes - List owned and managed classes
+    edubase_get_classes: {
+        type: 'array',
+        items: {
+            type: 'object',
+            properties: {
+                class: {
+                    type: 'string',
+                    description: 'class identification string',
+                },
+                id: {
+                    type: 'string',
+                    description: 'external unique class identifier (if set for the class)',
+                },
+                name: {
+                    type: 'string',
+                    description: 'title of the class',
+                },
+            },
+        },
+    },
+    // GET /class - Get/check class
+    edubase_get_class: {
+        type: 'object',
+        properties: {
+            class: {
+                type: 'string',
+                description: 'class identification string',
+            },
+            id: {
+                type: 'string',
+                description: 'external unique class identifier (if set for the class)',
+            },
+            name: {
+                type: 'string',
+                description: 'title of the class',
+            },
+            start: {
+                type: 'string',
+                description: 'start date and time (if set)',
+            },
+            end: {
+                type: 'string',
+                description: 'end date and time (if set)',
+            },
+        },
+    },
+    // GET /class:assignments - List all assignments in a class
+    edubase_get_class_assignments: {
+        type: 'array',
+        items: {
+            type: 'object',
+            properties: {
+                assignment: {
+                    type: 'string',
+                    description: 'assignment identification string',
+                },
+                name: {
+                    type: 'string',
+                    description: 'title of the assignment',
+                },
+                link: {
+                    type: 'string',
+                    description: 'link to the assignment page',
+                },
+                status: {
+                    type: 'string',
+                    description: 'assignment and submission state (INACTIVE, ACTIVE, STARTED, SUBMITTED, GRADED)',
+                },
+                starts: {
+                    type: 'string',
+                    description: 'when the assignment submission starts',
+                },
+                ends: {
+                    type: 'string',
+                    description: 'when the assignment submission ends',
+                },
+            },
+        },
+    },
+    // GET /class:members - List all members in a class
+    edubase_get_class_members: {
+        type: 'array',
+        items: {
+            type: 'object',
+            properties: {
+                user: {
+                    type: 'string',
+                    description: 'user identification string',
+                },
+                name: {
+                    type: 'string',
+                    description: 'name of the member',
+                },
+                active: {
+                    type: 'boolean',
+                    description: 'active membership (approved and not expired)',
+                },
+            },
+        },
+    },
+    // POST /class:members - Assign user(s) to a class
+    edubase_post_class_members: {},
+    // DELETE /class:members - Remove user(s) from a class
+    edubase_delete_class_members: {},
+    // POST /classes:members - Assign user(s) to class(es)
+    edubase_post_classes_members: {},
+    // GET /user:classes - List all classes a user is member of
+    edubase_get_user_classes: {
+        type: 'array',
+        items: {
+            type: 'object',
+            properties: {
+                class: {
+                    type: 'string',
+                    description: 'class identification string',
+                },
+                id: {
+                    type: 'string',
+                    description: 'external unique class identifier (if set for the class)',
+                },
+                name: {
+                    type: 'string',
+                    description: 'title of the class',
+                },
+                link: {
+                    type: 'string',
+                    description: 'link to the class page',
+                },
+                active: {
+                    type: 'boolean',
+                    description: 'active membership (approved and not expired)',
+                },
+            },
+        },
+    },
+    // POST /user:classes - Assign user to class(es)
+    edubase_post_user_classes: {},
+    // DELETE /user:classes - Remove user from class(es)
+    edubase_delete_user_classes: {},
+};

package/dist/tools/exams.js

@@ -0,0 +1,309 @@
+/*
+# Exams (Highest Level in EduBase Hierarchy)
+
+Exams are time-limited, secure instances of Quiz sets in EduBase.
+They represent the highest level in the EduBase hierarchy, above both Questions and Quiz sets.
+
+Key characteristics:
+- Exams are always created from existing Quiz sets
+- They have specific start and end times
+- They include additional security features (cheating detection, prevention of simultaneous account access during exam)
+- Usually restrict access to hints/solutions
+- Generally limited to one attempt per user
+- Questions cannot exist directly in Exams without being part of a Quiz set
+*/
+/* Tool definitions */
+export const EDUBASE_API_TOOLS_EXAMS = [
+    // GET /exams - List owned and managed exams
+    {
+        name: 'edubase_get_exams',
+        description: "List owned and managed exams. Exams are the highest level in the EduBase Quiz hierarchy, built from Quiz sets.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                search: {
+                    type: 'string',
+                    description: 'search string to filter results',
+                },
+                limit: {
+                    type: 'number',
+                    description: 'limit number of results (default: 16)',
+                },
+                page: {
+                    type: 'number',
+                    description: 'page number (default: 1), not used in search mode!',
+                },
+            },
+            required: [],
+        },
+    },
+    // GET /exam - Get/check exam
+    {
+        name: 'edubase_get_exam',
+        description: "Get/check exam.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                exam: {
+                    type: 'string',
+                    description: 'exam identification string',
+                },
+            },
+            required: ['exam'],
+        },
+    },
+    // POST /exam - Create a new exam from an existing Quiz set
+    {
+        name: 'edubase_post_exam',
+        description: "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.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                language: {
+                    type: 'string',
+                    description: 'desired exam language',
+                },
+                title: {
+                    type: 'string',
+                    description: 'title of the exam',
+                },
+                id: {
+                    type: 'string',
+                    description: "External unique exam identifier.\n" +
+                        "Should be maximum 64 characters long!"
+                },
+                type: {
+                    type: 'string',
+                    description: "Type of the exam. (default: exam)\n" +
+                        "- exam: regular exam\n" +
+                        "- championship: exam with championship features enabled\n" +
+                        "- homework: homework assignment, can be paused and continued during the exam period\n" +
+                        "- survey: survey (optionally anonymous) with no grading"
+                },
+                quiz: {
+                    type: 'string',
+                    description: 'the Quiz set (specified using the quiz identification string) the exam is attached to',
+                },
+                open: {
+                    type: 'string',
+                    description: 'exam start time (in YYYY-mm-dd HH:ii:ss format)',
+                },
+                close: {
+                    type: 'string',
+                    description: 'exam end time (in YYYY-mm-dd HH:ii:ss format)',
+                },
+            },
+            required: ['title', 'quiz', 'open', 'close'],
+        },
+    },
+    // DELETE /exam - Remove/archive exam
+    {
+        name: 'edubase_delete_exam',
+        description: "Remove/archive exam.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                exam: {
+                    type: 'string',
+                    description: 'exam identification string',
+                },
+            },
+            required: ['exam'],
+        },
+    },
+    // GET /exam:users - List all users on an exam
+    {
+        name: 'edubase_get_exam_users',
+        description: "List all users on an exam.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                exam: {
+                    type: 'string',
+                    description: 'exam identification string',
+                },
+            },
+            required: ['exam'],
+        },
+    },
+    // POST /exam:users - Assign user(s) to an exam
+    {
+        name: 'edubase_post_exam_users',
+        description: "Assign user(s) to an exam.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                exam: {
+                    type: 'string',
+                    description: 'exam identification string',
+                },
+                users: {
+                    type: 'string',
+                    description: 'comma-separated list of user identification strings',
+                },
+            },
+            required: ['exam', 'users'],
+        },
+    },
+    // DELETE /exam:users - Remove user(s) from an exam
+    {
+        name: 'edubase_delete_exam_users',
+        description: "Remove user(s) from an exam.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                exam: {
+                    type: 'string',
+                    description: 'exam identification string',
+                },
+                users: {
+                    type: 'string',
+                    description: 'comma-separated list of user identification strings',
+                },
+            },
+            required: ['exam', 'users'],
+        },
+    },
+    // POST /exam:summary - Submit a new exam summary
+    {
+        name: 'edubase_post_exam_summary',
+        description: "Submit a new AI exam summary.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                exam: {
+                    type: 'string',
+                    description: 'exam identification string',
+                },
+                language: {
+                    type: 'string',
+                    description: 'summary language',
+                },
+                type: {
+                    type: 'string',
+                    description: "Type of summary. (default: ai)\n" +
+                        "- ai: AI-generated summary"
+                },
+                summary: {
+                    type: 'string',
+                    description: "Summary text. \n" +
+                        "- basic HTML formatting allowed, but avoid complex designs\n" +
+                        "- keep the summary short and concise\n" +
+                        "- try to avoid including personal information (such as usernames, names and contact addresses)"
+                },
+                llm: {
+                    type: 'string',
+                    description: "Name of the Large Language Model used to generate the summary.\n" +
+                        "- preferred values: openai / claude / gemini"
+                },
+                model: {
+                    type: 'string',
+                    description: 'Exact LLM model name used to generate the summary',
+                },
+            },
+            required: ['exam', 'type', 'summary', 'llm', 'model'],
+        },
+    },
+];
+/* Output schema definitions */
+export const EDUBASE_API_TOOLS_EXAMS_OUTPUT_SCHEMA = {
+    // GET /exams - List owned and managed exams
+    edubase_get_exams: {
+        type: 'array',
+        items: {
+            type: 'object',
+            properties: {
+                exam: {
+                    type: 'string',
+                    description: 'exam identification string',
+                },
+                id: {
+                    type: 'string',
+                    description: 'external unique exam identifier (if set for the exam)',
+                },
+                name: {
+                    type: 'string',
+                    description: 'title of the exam',
+                },
+                active: {
+                    type: 'boolean',
+                    description: 'exam is active',
+                },
+            },
+        },
+    },
+    // GET /exam - Get/check exam
+    edubase_get_exam: {
+        type: 'object',
+        properties: {
+            exam: {
+                type: 'string',
+                description: 'exam identification string',
+            },
+            id: {
+                type: 'string',
+                description: 'external unique exam identifier (if set for the exam)',
+            },
+            name: {
+                type: 'string',
+                description: 'title of the exam',
+            },
+            quiz: {
+                type: 'string',
+                description: "Quiz identification string.\n" +
+                    "- The Quiz set the exam is attached to"
+            },
+            active: {
+                type: 'boolean',
+                description: 'exam is active',
+            },
+            status: {
+                type: 'string',
+                description: 'exam status (INACTIVE, ACTIVE, PAUSED, REVIEW, EXPIRED)',
+            },
+            start: {
+                type: 'string',
+                description: 'start date and time',
+            },
+            end: {
+                type: 'string',
+                description: 'end date and time',
+            },
+        },
+    },
+    // GET /exam - Get/check exam
+    edubase_post_exam: {
+        type: 'object',
+        properties: {
+            exam: {
+                type: 'string',
+                description: 'exam identification string',
+            },
+        },
+    },
+    // DELETE /exam - Remove/archive exam
+    edubase_delete_exam: {},
+    // GET /exam:users - List all users on an exam
+    edubase_get_exam_users: {
+        type: 'array',
+        items: {
+            type: 'object',
+            properties: {
+                user: {
+                    type: 'string',
+                    description: 'user identification string',
+                },
+                name: {
+                    type: 'string',
+                    description: 'name of the examinee',
+                },
+            },
+        },
+    },
+    // POST /exam:users - Assign user(s) to an exam
+    edubase_post_exam_users: {},
+    // DELETE /exam:users - Remove user(s) from an exam
+    edubase_delete_exam_users: {},
+    // POST /exam:summary - Submit a new exam summary
+    edubase_post_exam_summary: {},
+};