EduBase MCP Server

import { Tool } from "@modelcontextprotocol/sdk/types.js"; /* Tool definitions */ export const EDUBASE_API_TOOLS_PLAYS: Tool[] = [ // GET /quiz:results:play - Get detailed results for a specific Quiz play { name: 'edubase_get_quiz_play_results', description: "Get detailed results for a specific Quiz play.", inputSchema: { type: 'object', properties: { play: { type: 'string', description: 'Quiz play identification string', }, }, required: ['play'], }, }, // GET /quiz:results:user - Get user results for a specific Quiz set { name: 'edubase_get_quiz_results_user', description: "Get user results for a specific Quiz set.", inputSchema: { type: 'object', properties: { quiz: { type: 'string', description: 'Quiz set identification string', }, user: { type: 'string', description: 'user identification string', }, }, required: ['quiz', 'user'], }, }, // GET /exam:results:user - Get user results for a specific exam { name: 'edubase_get_exam_results_user', description: "Get user results for a specific exam.", inputSchema: { type: 'object', properties: { exam: { type: 'string', description: 'exam identification string', }, user: { type: 'string', description: 'user identification string', }, }, required: ['exam', 'user'], }, }, // GET /exam:results:raw - Get raw results for a specific exam { name: 'edubase_get_exam_results_raw', description: "Get raw results for a specific exam.\n" + "- This endpoint returns raw results, including all answers given by the user. It is not meant to be displayed to the user.\n" + "- This might require additional permissions.", inputSchema: { type: 'object', properties: { exam: { type: 'string', description: 'exam identification string', }, }, required: ['exam'], }, }, // GET /exam:certificates:user - Get (the latest) certificate details for a specific exam and user { name: 'edubase_get_exam_certificates_user', description: "Get (the latest) certificate details for a specific exam and user.", inputSchema: { type: 'object', properties: { exam: { type: 'string', description: 'exam identification string', }, user: { type: 'string', description: 'user identification string', }, }, required: ['exam', 'user'], }, }, // POST /exam:certificates:user:download - Generate download link for the latest user exam certificate { name: 'edubase_post_exam_certificates_user_download', description: "Generate download link for the latest user exam certificate. If a previous valid link exists, it will be returned instead.", inputSchema: { type: 'object', properties: { exam: { type: 'string', description: 'exam identification string', }, user: { type: 'string', description: 'user identification string', }, }, required: ['exam', 'user'], }, }, ]; /* Output schema definitions */ export const EDUBASE_API_TOOLS_PLAYS_OUTPUT_SCHEMA: object = { // GET /quiz:results:play - Get detailed results for a specific Quiz play edubase_get_quiz_play_results: { type: 'object', properties: { play: { type: 'string', description: 'Quiz play identification string', }, user: { type: 'string', description: 'user identification string', }, time_start: { type: 'string', description: 'start time', }, time_end: { type: 'string', description: 'end time', }, questions_total: { type: 'number', description: 'total number of questions asked', }, questions_correct: { type: 'number', description: 'number of correctly answered questions', }, points_total: { type: 'number', description: 'total points', }, points_correct: { type: 'number', description: 'total points scored', }, valid: { type: 'boolean', description: 'result is valid', }, questions: { type: 'array', items: { type: 'object', properties: { index: { type: 'string', description: 'question index', }, id: { type: 'string', description: 'external unique question identifier (if present)', }, question: { type: 'string', description: 'question identification string', }, time_answer: { type: 'number', description: 'number of seconds spent on question (if available)', }, points_maximum: { type: 'number', description: 'maximum points', }, points: { type: 'number', description: 'points scored', }, }, }, }, }, }, // GET /quiz:results:user - Get user results for a specific Quiz set edubase_get_quiz_results_user: { type: 'array', items: { type: 'object', properties: { play: { type: 'string', description: 'Quiz play identification string', }, user: { type: 'string', description: 'user identification string', }, time_start: { type: 'string', description: 'start time', }, time_end: { type: 'string', description: 'end time', }, questions_total: { type: 'number', description: 'total number of questions asked', }, questions_correct: { type: 'number', description: 'number of correctly answered questions', }, points_total: { type: 'number', description: 'total points', }, points_correct: { type: 'number', description: 'total points scored', }, valid: { type: 'boolean', description: 'result is valid', }, }, }, }, // GET /exam:results:user - Get user results for a specific exam edubase_get_exam_results_user: { type: 'array', items: { type: 'object', properties: { play: { type: 'string', description: 'Quiz play identification string', }, user: { type: 'string', description: 'user identification string', }, time_start: { type: 'string', description: 'start time', }, time_end: { type: 'string', description: 'end time', }, questions_total: { type: 'number', description: 'total number of questions asked', }, questions_correct: { type: 'number', description: 'number of correctly answered questions', }, points_total: { type: 'number', description: 'total points', }, points_correct: { type: 'number', description: 'total points scored', }, attempt: { type: 'number', description: 'index of attempt', }, valid: { type: 'boolean', description: 'result is valid', }, }, }, }, // GET /exam:results:raw - Get raw results for a specific exam edubase_get_exam_results_raw: { type: 'object', properties: { exam: { type: 'string', description: 'exam identification string', }, users: { type: 'array', items: { type: 'object', description: 'details of the user and their results', properties: { results: { type: 'number', description: 'achieved score in percentage', }, play: { type: 'object', description: 'Quiz play details', }, ready: { type: 'boolean', description: 'all questions are evaluated, not requiring further review', }, points: { type: 'object', properties: { correct: { type: 'object', description: 'total points scored', }, total: { type: 'object', description: 'maximum points', }, }, }, flow: { type: 'object', description: 'Quiz Flow data, describing detailed user interaction and logs about the test attempt', }, stats: { type: 'object', description: 'detailed evaluation data', }, time: { type: 'object', description: 'time needed for the test and each question', }, }, }, }, questions: { type: 'object', description: 'most important details about the questions asked', }, }, }, // GET /exam:certificates:user - Get (the latest) certificate details for a specific exam and user edubase_get_exam_certificates_user: { type: 'object', properties: { play: { type: 'string', description: 'Quiz play identification string', }, user: { type: 'string', description: 'user identification string', }, eligible: { type: 'boolean', description: 'result is eligible for a certificate', }, certified: { type: 'boolean', description: 'result is eligible and also certified', }, serial: { type: 'string', description: 'serial number of the certificate, only present if the result is certified and serial numbering is enabled', }, expires: { type: 'string', description: 'date of expiration, only present if the result is certified and expiration is configured', }, }, }, // POST /exam:certificates:user:download - Generate download link for the latest user exam certificate edubase_get_exam_certificates_user_download: { type: 'object', properties: { play: { type: 'string', description: 'Quiz play identification string', }, user: { type: 'string', description: 'user identification string', }, url: { type: 'string', description: 'download link for the certificate', }, valid: { type: 'string', description: 'date of link expiration', }, }, }, };