delete_teacher_enrollment
DestructiveIdempotent
Remove a teacher enrollment record by providing the enrollment ID.
Instructions
Delete a teacher enrollment.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ID of the teacher enrollment to delete |
Implementation Reference
- src/tools/teacher_enrollments.ts:94-110 (handler)Handler function for delete_teacher_enrollment tool. Takes an 'id' parameter, sends a DELETE request to /teacher_enrollments/:id, logs the response, and formats the deletion result.
server.registerTool( "delete_teacher_enrollment", { description: "Delete a teacher enrollment.", annotations: { readOnlyHint: false, destructiveHint: true, idempotentHint: true }, inputSchema: { id: z.number().int().positive().describe("ID of the teacher enrollment to delete") }, }, async ({ id }) => { try { const record = await apiDelete<EduframeRecord>(`/teacher_enrollments/${id}`); void logResponse("delete_teacher_enrollment", { id }, record); return formatDelete(record, "teacher enrollment"); } catch (error) { return formatError(error); } }, ); - Input schema for delete_teacher_enrollment: requires a positive integer 'id'.
inputSchema: { id: z.number().int().positive().describe("ID of the teacher enrollment to delete") }, - src/tools/teacher_enrollments.ts:94-110 (registration)Registration of delete_teacher_enrollment via server.registerTool() inside registerTeacherEnrollmentTools.
server.registerTool( "delete_teacher_enrollment", { description: "Delete a teacher enrollment.", annotations: { readOnlyHint: false, destructiveHint: true, idempotentHint: true }, inputSchema: { id: z.number().int().positive().describe("ID of the teacher enrollment to delete") }, }, async ({ id }) => { try { const record = await apiDelete<EduframeRecord>(`/teacher_enrollments/${id}`); void logResponse("delete_teacher_enrollment", { id }, record); return formatDelete(record, "teacher enrollment"); } catch (error) { return formatError(error); } }, ); - src/tools/index.ts:128-130 (registration)Global registration: registerTeacherEnrollmentTools is included in the tools array that registerAllTools iterates over.
export function registerAllTools(server: McpServer): void { for (const register of tools) { register(server); - src/api.ts:219-229 (helper)Helper function apiDelete that performs the actual HTTP DELETE request to the Eduframe API.
export async function apiDelete<T>(path: string): Promise<T> { const { token } = getConfig(); const url = buildUrl(path); const response = await fetch(url.toString(), { method: "DELETE", headers: buildHeaders(token), }); return handleResponse<T>(response); }