@edubase/mcp 1.0.23

package/dist/tools/users.js

@@ -0,0 +1,611 @@
+/* Tool definitions */
+export const EDUBASE_API_TOOLS_USERS = [
+    // GET /users - List managed, non-generated users
+    {
+        name: 'edubase_get_users',
+        description: "List managed, non-generated users.",
+        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 /user:me - Get/check current user
+    {
+        name: 'edubase_get_user_me',
+        description: "Get/check current user.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                user: {
+                    type: 'string',
+                    description: "User identification string.\n" +
+                        "- Use 'me' to get the current user."
+                },
+            },
+            required: ['user'],
+        },
+    },
+    // GET /user - Get/check user
+    {
+        name: 'edubase_get_user',
+        description: "Get/check user.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                user: {
+                    type: 'string',
+                    description: "User identification string.\n" +
+                        "- Use 'me' to get the current user, but prefer /user:me endpoint instead."
+                },
+            },
+            required: ['user'],
+        },
+    },
+    // POST /user - Create new user account
+    {
+        name: 'edubase_post_user',
+        description: "Create new EduBase user account.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                username: {
+                    type: 'string',
+                    description: 'username (4-64 characters)',
+                },
+                password: {
+                    type: 'string',
+                    description: 'password (4-64 characters) (default: initial random password is automatically generated)',
+                },
+                first_name: {
+                    type: 'string',
+                    description: 'first name (1-64 characters)',
+                },
+                last_name: {
+                    type: 'string',
+                    description: 'last name (1-64 characters)',
+                },
+                full_name: {
+                    type: 'string',
+                    description: 'override automatic full name (1-255 characters)',
+                },
+                display_name: {
+                    type: 'string',
+                    description: 'override automatic display name (1-255 characters)',
+                },
+                email: {
+                    type: 'string',
+                    description: 'valid email address',
+                },
+                phone: {
+                    type: 'string',
+                    description: 'valid phone number in format "+prefix number" without special characters',
+                },
+                gender: {
+                    type: 'string',
+                    description: 'gender ("male", "female", or "other")',
+                },
+                birthdate: {
+                    type: 'string',
+                    description: 'date of birth',
+                },
+                exam: {
+                    type: 'boolean',
+                    description: 'user is only allowed to login when accessing exams (default: false)',
+                },
+                group: {
+                    type: 'string',
+                    description: 'name of the user group',
+                },
+                template: {
+                    type: 'string',
+                    description: 'a template ID for the new account (default: none)',
+                },
+                language: {
+                    type: 'string',
+                    description: 'desired account language (default: API application owner\'s language)',
+                },
+                timezone: {
+                    type: 'string',
+                    description: 'desired timezone (default: API application owner\'s timezone)',
+                },
+                color: {
+                    type: 'string',
+                    description: 'desired favorite color (default/branding/red/blue/yellow/green/purple) (default: default)',
+                },
+                must_change_password: {
+                    type: 'boolean',
+                    description: 'user is forced to change password on first login (default: false)',
+                },
+                notify: {
+                    type: 'boolean',
+                    description: 'notify user via email (or SMS) (default: false)',
+                },
+            },
+            required: ['username', 'first_name', 'last_name', 'email'],
+        },
+    },
+    // PATCH /user - Update user
+    {
+        name: 'edubase_patch_user',
+        description: "Update user.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                user: {
+                    type: 'string',
+                    description: 'user identification string',
+                },
+                active: {
+                    type: 'boolean',
+                    description: 'enable or disable user',
+                },
+            },
+            required: ['user'],
+        },
+    },
+    // DELETE /user - Delete user
+    {
+        name: 'edubase_delete_user',
+        description: "Delete user.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                user: {
+                    type: 'string',
+                    description: 'user identification string',
+                },
+            },
+            required: ['user'],
+        },
+    },
+    // GET /user:name - Get user's name
+    {
+        name: 'edubase_get_user_name',
+        description: "Get user's name.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                user: {
+                    type: 'string',
+                    description: 'user identification string',
+                },
+            },
+            required: ['user'],
+        },
+    },
+    // POST /user:name - Update a user's name
+    {
+        name: 'edubase_post_user_name',
+        description: "Update a user's name.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                user: {
+                    type: 'string',
+                    description: 'user identification string',
+                },
+                first_name: {
+                    type: 'string',
+                    description: 'first name (1-64 characters)',
+                },
+                last_name: {
+                    type: 'string',
+                    description: 'last name (1-64 characters)',
+                },
+                full_name: {
+                    type: 'string',
+                    description: 'full name (1-255 characters)',
+                },
+                display_name: {
+                    type: 'string',
+                    description: 'display name (1-255 characters)',
+                },
+            },
+            required: ['user', 'first_name', 'last_name'],
+        },
+    },
+    // GET /user:group - Get user's group
+    {
+        name: 'edubase_get_user_group',
+        description: "Get user's group.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                user: {
+                    type: 'string',
+                    description: 'user identification string',
+                },
+            },
+            required: ['user'],
+        },
+    },
+    // POST /user:group - Update a user's group
+    {
+        name: 'edubase_post_user_group',
+        description: "Update a user's group.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                user: {
+                    type: 'string',
+                    description: 'user identification string',
+                },
+                group: {
+                    type: 'string',
+                    description: 'user group code',
+                },
+            },
+            required: ['user', 'group'],
+        },
+    },
+    // GET /user:login - Get latest valid login link for user
+    {
+        name: 'edubase_get_user_login',
+        description: "Get latest valid login link for user.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                user: {
+                    type: 'string',
+                    description: 'user identification string',
+                },
+            },
+            required: ['user'],
+        },
+    },
+    // POST /user:login - Generate login link
+    {
+        name: 'edubase_post_user_login',
+        description: "Generate login link. If a valid link with the same settings exists, it will be returned instead of creating a new one.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                user: {
+                    type: 'string',
+                    description: 'user identification string',
+                },
+                redirect: {
+                    type: 'string',
+                    description: 'redirect after a successful login (URI path or [{content_type}:{tag}])',
+                },
+                expires: {
+                    type: 'string',
+                    description: 'expiry in days (1-30) or YYYY-MM-DD (default: 1 day)',
+                },
+                logins: {
+                    type: 'number',
+                    description: 'total count the link can be used to login users (default: 1)',
+                },
+                template: {
+                    type: 'string',
+                    description: 'a template ID for the login link',
+                },
+                short: {
+                    type: 'boolean',
+                    description: 'generate shortened (eduba.se) link (only if feature is enabled on EduBase) (default: false)',
+                },
+            },
+            required: ['user'],
+        },
+    },
+    // DELETE /user:login - Delete a previously generated login link
+    {
+        name: 'edubase_delete_user_login',
+        description: "Delete a previously generated login link.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                user: {
+                    type: 'string',
+                    description: 'user identification string',
+                },
+                url: {
+                    type: 'string',
+                    description: 'generated login link to be invalidated',
+                },
+            },
+            required: ['user', 'url'],
+        },
+    },
+    // GET /user:search - Lookup user by email, username or code
+    {
+        name: 'edubase_get_user_search',
+        description: "Lookup user by email, username or code.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                query: {
+                    type: 'string',
+                    description: 'query string',
+                },
+            },
+            required: ['query'],
+        },
+    },
+    // POST /user:assume - Assume user for next requests with assume token
+    {
+        name: 'edubase_post_user_assume',
+        description: "Assume user for next requests with assume token.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                user: {
+                    type: 'string',
+                    description: 'user identification string, username or email address',
+                },
+                password: {
+                    type: 'string',
+                    description: 'password or user secret',
+                },
+            },
+            required: ['user'],
+        },
+    },
+    // DELETE /user:assume - Revoke assume token
+    {
+        name: 'edubase_delete_user_assume',
+        description: "Revoke assume token.",
+        inputSchema: {
+            type: 'object',
+            properties: {
+                token: {
+                    type: 'string',
+                    description: 'assume token',
+                },
+            },
+            required: ['token'],
+        },
+    },
+];
+/* Output schema definitions */
+export const EDUBASE_API_TOOLS_USERS_OUTPUT_SCHEMA = {
+    // GET /users - List managed, non-generated users
+    edubase_get_users: {
+        type: 'array',
+        items: {
+            type: 'object',
+            properties: {
+                user: {
+                    type: 'string',
+                    description: 'user identification string',
+                },
+                name: {
+                    type: 'string',
+                    description: 'full name of the user',
+                },
+            },
+        },
+    },
+    // GET /user:me - Get/check current user
+    edubase_get_user_me: {
+        type: 'object',
+        properties: {
+            user: {
+                type: 'string',
+                description: 'user identification string',
+            },
+            name: {
+                type: 'string',
+                description: 'full name',
+            },
+            status: {
+                type: 'boolean',
+                description: 'user is enabled',
+            },
+            exam: {
+                type: 'boolean',
+                description: 'exam (generated) account',
+            },
+        },
+    },
+    // GET /user - Get/check user
+    edubase_get_user: {
+        type: 'object',
+        properties: {
+            user: {
+                type: 'string',
+                description: 'user identification string',
+            },
+            name: {
+                type: 'string',
+                description: 'full name',
+            },
+            status: {
+                type: 'boolean',
+                description: 'user is enabled',
+            },
+            exam: {
+                type: 'boolean',
+                description: 'exam (generated) account',
+            },
+        },
+    },
+    // POST /user - Create new user account
+    edubase_post_user: {
+        type: 'object',
+        properties: {
+            user: {
+                type: 'string',
+                description: 'user identification string',
+            },
+            username: {
+                type: 'string',
+                description: 'username, only if exam=false',
+            },
+            password: {
+                type: 'string',
+                description: 'password, only if exam=false',
+            },
+        },
+    },
+    // PATCH /user - Update user
+    edubase_patch_user: {},
+    // DELETE /user - Delete user
+    edubase_delete_user: {},
+    // GET /user:name - Get user's name
+    edubase_get_user_name: {
+        type: 'object',
+        properties: {
+            user: {
+                type: 'string',
+                description: 'the user identification string',
+            },
+            first_name: {
+                type: 'string',
+                description: 'first name',
+            },
+            last_name: {
+                type: 'string',
+                description: 'last name',
+            },
+            full_name: {
+                type: 'string',
+                description: 'full name',
+            },
+            display_name: {
+                type: 'string',
+                description: 'display name',
+            },
+        },
+    },
+    // POST /user:name - Update a user's name
+    edubase_post_user_name: {
+        type: 'object',
+        properties: {
+            user: {
+                type: 'string',
+                description: 'the user identification string',
+            },
+            success: {
+                type: 'boolean',
+                description: 'operation is successful',
+            },
+            changed: {
+                type: 'boolean',
+                description: 'name has been changed',
+            },
+        },
+    },
+    // GET /user:group - Get user's group
+    edubase_get_user_group: {
+        type: 'object',
+        properties: {
+            user: {
+                type: 'string',
+                description: 'the user identification string',
+            },
+            group: {
+                type: 'string',
+                description: 'user group code',
+            },
+        },
+    },
+    // POST /user:group - Update a user's group
+    edubase_post_user_group: {
+        type: 'object',
+        properties: {
+            user: {
+                type: 'string',
+                description: 'the user identification string',
+            },
+            success: {
+                type: 'boolean',
+                description: 'operation is successful',
+            },
+            changed: {
+                type: 'boolean',
+                description: 'name has been changed',
+            },
+        },
+    },
+    // GET /user:login - Get latest valid login link for user
+    edubase_get_user_login: {
+        type: 'object',
+        properties: {
+            user: {
+                type: 'string',
+                description: 'the user identification string',
+            },
+            url: {
+                type: 'string',
+                description: 'the login link',
+            },
+            valid: {
+                type: 'string',
+                description: 'validity (end of day) of the generated link',
+            },
+        },
+    },
+    // POST /user:login - Generate login link
+    edubase_post_user_login: {
+        type: 'object',
+        properties: {
+            user: {
+                type: 'string',
+                description: 'the user identification string',
+            },
+            url: {
+                type: 'string',
+                description: 'the login link',
+            },
+            valid: {
+                type: 'string',
+                description: 'validity of the generated link',
+            },
+            count: {
+                type: 'number',
+                description: 'maximum number the link can be used to login',
+            },
+        },
+    },
+    // DELETE /user:login - Delete a previously generated login link
+    edubase_delete_user_login: {},
+    // GET /user:search - Lookup user by email, username or code
+    edubase_get_user_search: {
+        type: 'object',
+        properties: {
+            user: {
+                type: 'string',
+                description: 'user identification string',
+            },
+            exam: {
+                type: 'boolean',
+                description: 'exam (generated) account',
+            },
+        },
+    },
+    // POST /user:assume - Assume user for next requests with assume token
+    edubase_post_user_assume: {
+        type: 'object',
+        properties: {
+            user: {
+                type: 'string',
+                description: 'user identification string',
+            },
+            token: {
+                type: 'string',
+                description: 'assume token',
+            },
+            valid: {
+                type: 'string',
+                description: 'validity of the generated token',
+            },
+        },
+    },
+    // DELETE /user:assume - Revoke assume token
+    edubase_delete_user_assume: {},
+};

package/dist/tools.js

@@ -0,0 +1,68 @@
+/*
+# EduBase Quiz Hierarchical Structure
+
+EduBase Quiz follows a clear three-level hierarchical structure that AI models should understand when generating content:
+
+1. **Questions** (lowest level):
+   - Basic building blocks of the Quiz system
+   - Multiple question types (choice, numerical, expression, text, etc.)
+   - Can be parametrized for dynamic content generation
+   - Questions are stored in QuestionBase or directly in Quiz sets
+
+2. **Quiz sets** (middle level):
+   - Collections of questions and/or question groups
+   - Can have various settings (time limits, scoring rules, etc.)
+   - Quiz sets can be used for practice or converted to exams
+   - Questions from one Quiz set can be used in multiple exams with different configurations
+
+3. **Exams** (highest level):
+   - Time-limited, secure instances of Quiz sets
+   - Have specific start and end times
+   - Include additional security features (cheating detection, prevention of simultaneous account access during exam)
+   - Usually restrict access to hints/solutions
+   - Limited to one attempt per user (typically)
+   - Draw their questions from existing Quiz sets
+
+The relationship is strictly hierarchical: Exams contain Quiz sets, which contain Questions. Questions cannot exist directly in Exams without being part of a Quiz set.
+
+When generating content for EduBase, maintain awareness of which level you're operating at and respect the constraints of each level in the hierarchy.
+*/
+import { EDUBASE_API_TOOLS_QUESTIONS, EDUBASE_API_TOOLS_QUESTIONS_OUTPUT_SCHEMA } from "./tools/questions.js";
+import { EDUBASE_API_TOOLS_EXAMS, EDUBASE_API_TOOLS_EXAMS_OUTPUT_SCHEMA } from "./tools/exams.js";
+import { EDUBASE_API_TOOLS_QUIZES, EDUBASE_API_TOOLS_QUIZES_OUTPUT_SCHEMA } from "./tools/quizes.js";
+import { EDUBASE_API_TOOLS_PLAYS, EDUBASE_API_TOOLS_PLAYS_OUTPUT_SCHEMA } from "./tools/plays.js";
+import { EDUBASE_API_TOOLS_USERS, EDUBASE_API_TOOLS_USERS_OUTPUT_SCHEMA } from "./tools/users.js";
+import { EDUBASE_API_TOOLS_CLASSES, EDUBASE_API_TOOLS_CLASSES_OUTPUT_SCHEMA } from "./tools/classes.js";
+import { EDUBASE_API_TOOLS_ORGANIZATIONS, EDUBASE_API_TOOLS_ORGANIZATIONS_OUTPUT_SCHEMA } from "./tools/organizations.js";
+import { EDUBASE_API_TOOLS_INTEGRATIONS, EDUBASE_API_TOOLS_INTEGRATIONS_OUTPUT_SCHEMA } from "./tools/integrations.js";
+import { EDUBASE_API_TOOLS_TAGS, EDUBASE_API_TOOLS_TAGS_OUTPUT_SCHEMA } from "./tools/tags.js";
+import { EDUBASE_API_TOOLS_PERMISSIONS, EDUBASE_API_TOOLS_PERMISSIONS_OUTPUT_SCHEMA } from "./tools/permissions.js";
+import { EDUBASE_API_TOOLS_METRICS, EDUBASE_API_TOOLS_METRICS_OUTPUT_SCHEMA } from "./tools/metrics.js";
+/* Tool definitions */
+export const EDUBASE_API_TOOLS = [
+    ...EDUBASE_API_TOOLS_QUESTIONS,
+    ...EDUBASE_API_TOOLS_EXAMS,
+    ...EDUBASE_API_TOOLS_PLAYS,
+    ...EDUBASE_API_TOOLS_QUIZES,
+    ...EDUBASE_API_TOOLS_USERS,
+    ...EDUBASE_API_TOOLS_CLASSES,
+    ...EDUBASE_API_TOOLS_ORGANIZATIONS,
+    ...EDUBASE_API_TOOLS_INTEGRATIONS,
+    ...EDUBASE_API_TOOLS_TAGS,
+    ...EDUBASE_API_TOOLS_PERMISSIONS,
+    ...EDUBASE_API_TOOLS_METRICS
+];
+/* Output schema definitions */
+export const EDUBASE_API_TOOLS_OUTPUT_SCHEMA = {
+    ...EDUBASE_API_TOOLS_QUESTIONS_OUTPUT_SCHEMA,
+    ...EDUBASE_API_TOOLS_EXAMS_OUTPUT_SCHEMA,
+    ...EDUBASE_API_TOOLS_QUIZES_OUTPUT_SCHEMA,
+    ...EDUBASE_API_TOOLS_PLAYS_OUTPUT_SCHEMA,
+    ...EDUBASE_API_TOOLS_USERS_OUTPUT_SCHEMA,
+    ...EDUBASE_API_TOOLS_CLASSES_OUTPUT_SCHEMA,
+    ...EDUBASE_API_TOOLS_ORGANIZATIONS_OUTPUT_SCHEMA,
+    ...EDUBASE_API_TOOLS_INTEGRATIONS_OUTPUT_SCHEMA,
+    ...EDUBASE_API_TOOLS_TAGS_OUTPUT_SCHEMA,
+    ...EDUBASE_API_TOOLS_PERMISSIONS_OUTPUT_SCHEMA,
+    ...EDUBASE_API_TOOLS_METRICS_OUTPUT_SCHEMA
+};