get_credit_categories

Instructions

Implementation Reference

• src/tools/credit_categories.ts:7-31 (handler)

  Handler function that registers and implements the 'get_credit_categories' tool. It calls the Eduframe API's /credit_categories endpoint (via apiList), logs the response, formats the results, and handles pagination via cursor.

  export function registerCreditCategorieTools(server: McpServer): void {
    server.registerTool(
      "get_credit_categories",
      {
        description: "Get all credit category records",
        annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },
        inputSchema: {
          cursor: z.string().optional().describe("Cursor for fetching the next page of results"),
          per_page: z.number().int().positive().optional().describe("Number of results per page (default: 25)"),
        },
      },
      async ({ cursor, per_page }) => {
        try {
          const result = await apiList<EduframeRecord>("/credit_categories", { cursor, per_page });
          void logResponse("get_credit_categories", { cursor, per_page }, result);
          const toolResult = formatList(result.records, "credit categories");
          if (result.nextCursor) {
            toolResult.content.push({ type: "text", text: `\nNext page cursor: ${result.nextCursor}` });
          }
          return toolResult;
        } catch (error) {
          return formatError(error);
        }
      },
    );

• src/tools/credit_categories.ts:13-16 (schema)

  Input schema for the tool: optional 'cursor' (string) for pagination and optional 'per_page' (positive integer) for page size.

  inputSchema: {
    cursor: z.string().optional().describe("Cursor for fetching the next page of results"),
    per_page: z.number().int().positive().optional().describe("Number of results per page (default: 25)"),
  },

• src/tools/index.ts:64-132 (registration)

  Registration of all tools including registerCreditCategorieTools in the tools array, which is then called by registerAllTools to register them on the MCP server.

  const tools: Array<(server: McpServer) => void> = [
    registerAccountTools,
    registerAffiliationTools,
    registerAttendanceTools,
    registerAuthenticationTools,
    registerCatalogProductTools,
    registerCatalogVariantTools,
    registerCategorieTools,
    registerCertificateTools,
    registerCommentTools,
    registerCourseLocationTools,
    registerCourseTabTools,
    registerCourseVariantTools,
    registerCourseTools,
    registerCreditCategorieTools,
    registerCreditTools,
    registerCustomAssociationTools,
    registerCustomFieldOptionTools,
    registerCustomObjectTools,
    registerCustomRecordTools,
    registerDiscountCodeTools,
    registerEditionDescriptionSectionTools,
    registerEducatorTools,
    registerEmailTools,
    registerEnrollmentTools,
    registerGradeTools,
    registerInvoiceVatTools,
    registerInvoiceTools,
    registerLabelTools,
    registerLeadTools,
    registerMaterialGroupTools,
    registerMaterialTools,
    registerMeetingLocationTools,
    registerMeetingTools,
    registerOrderTools,
    registerOrganizationTools,
    registerPaymentMethodTools,
    registerPaymentOptionTools,
    registerPaymentTools,
    registerPlannedCourseTools,
    registerPlanningAttendeeTools,
    registerPlanningConflictTools,
    registerPlanningEventTools,
    registerPlanningLocationTools,
    registerPlanningMaterialTools,
    registerPlanningRequiredTeacherGroupAttendeeTools,
    registerPlanningTeacherTools,
    registerProgramEditionTools,
    registerProgramElementTools,
    registerProgramEnrollmentTools,
    registerProgramPersonalProgramElementTools,
    registerProgramProgramTools,
    registerReferralTools,
    registerSignupQuestionTools,
    registerTaskTools,
    registerTeacherEnrollmentTools,
    registerTeacherRoleTools,
    registerTeacherTools,
    registerTheseTools,
    registerUserTools,
    registerWebhookNotificationTools,
    registerWebhookTools,
  ];
  
  export function registerAllTools(server: McpServer): void {
    for (const register of tools) {
      register(server);
    }
  }

• src/api.ts:122-137 (helper)

  Helper function apiList used by the tool handler to perform a paginated GET request to the Eduframe API. Returns typed records and a nextCursor for pagination.

  export async function apiList<T>(path: string, query?: Record<string, QueryValue>): Promise<ListResult<T>> {
    const { token } = getConfig();
    const url = buildUrl(path, query);
  
    const response = await fetch(url.toString(), {
      method: "GET",
      headers: buildHeaders(token),
    });
  
    await checkResponse(response);
  
    const records = (await response.json()) as T[];
    const nextCursor = parseNextCursor(response.headers.get("Link"));
  
    return { records, nextCursor };
  }

• src/formatters.ts:40-60 (helper)

  Helper function formatList used by the tool handler to format the API response into a human-readable CallToolResult.

  export function formatList(records: EduframeRecord[], resourceName: string): CallToolResult {
    if (records.length === 0) {
      return {
        content: [
          {
            type: "text",
            text: `No ${resourceName} found.`,
          },
        ],
      };
    }
  
    return {
      content: [
        {
          type: "text",
          text: `Found ${records.length} ${resourceName}:\n\n${formatJSON(records)}${RESPONSE_LOG_HINT}`,
        },
      ],
    };
  }