delete-tasks

Instructions

Implementation Reference

• src/tools/system-tools.ts:134-153 (handler)

  The handler function for the 'delete-tasks' tool. It builds a request body from the input parameters and performs a POST request to the Meilisearch '/tasks/delete' endpoint via apiClient, returning the JSON response or an error response.

  async ({ statuses, types, indexUids, uids, canceledBy, beforeUid, beforeStartedAt, beforeFinishedAt }) => {
    try {
      const body: Record<string, any> = {};
      if (statuses && statuses.length > 0) body.statuses = statuses;
      if (types && types.length > 0) body.types = types;
      if (indexUids && indexUids.length > 0) body.indexUids = indexUids;
      if (uids && uids.length > 0) body.uids = uids;
      if (canceledBy && canceledBy.length > 0) body.canceledBy = canceledBy;
      if (beforeUid !== undefined) body.beforeUid = beforeUid;
      if (beforeStartedAt) body.beforeStartedAt = beforeStartedAt;
      if (beforeFinishedAt) body.beforeFinishedAt = beforeFinishedAt;
      
      const response = await apiClient.post('/tasks/delete', body);
      return {
        content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }],
      };
    } catch (error) {
      return createErrorResponse(error);
    }
  }

• src/tools/system-tools.ts:124-133 (schema)

  Zod schema defining the input parameters for the 'delete-tasks' tool, including optional filters like statuses, types, indexUids, uids, etc.

  {
    statuses: z.array(z.enum(['succeeded', 'failed', 'canceled'])).optional().describe('Statuses of tasks to delete'),
    types: z.array(z.enum(['indexCreation', 'indexUpdate', 'indexDeletion', 'documentAddition', 'documentUpdate', 'documentDeletion', 'settingsUpdate', 'dumpCreation', 'taskCancelation'])).optional().describe('Types of tasks to delete'),
    indexUids: z.array(z.string()).optional().describe('UIDs of the indexes on which tasks to delete were performed'),
    uids: z.array(z.number()).optional().describe('UIDs of the tasks to delete'),
    canceledBy: z.array(z.number()).optional().describe('UIDs of the tasks that canceled tasks to delete'),
    beforeUid: z.number().optional().describe('Delete tasks whose uid is before this value'),
    beforeStartedAt: z.string().optional().describe('Delete tasks that started processing before this date (ISO 8601 format)'),
    beforeFinishedAt: z.string().optional().describe('Delete tasks that finished processing before this date (ISO 8601 format)'),
  },

• src/tools/system-tools.ts:121-154 (registration)

  The server.tool() call that registers the 'delete-tasks' tool with the MCP server, specifying name, description, input schema, and handler function.

  server.tool(
    'delete-tasks',
    'Delete tasks based on provided filters',
    {
      statuses: z.array(z.enum(['succeeded', 'failed', 'canceled'])).optional().describe('Statuses of tasks to delete'),
      types: z.array(z.enum(['indexCreation', 'indexUpdate', 'indexDeletion', 'documentAddition', 'documentUpdate', 'documentDeletion', 'settingsUpdate', 'dumpCreation', 'taskCancelation'])).optional().describe('Types of tasks to delete'),
      indexUids: z.array(z.string()).optional().describe('UIDs of the indexes on which tasks to delete were performed'),
      uids: z.array(z.number()).optional().describe('UIDs of the tasks to delete'),
      canceledBy: z.array(z.number()).optional().describe('UIDs of the tasks that canceled tasks to delete'),
      beforeUid: z.number().optional().describe('Delete tasks whose uid is before this value'),
      beforeStartedAt: z.string().optional().describe('Delete tasks that started processing before this date (ISO 8601 format)'),
      beforeFinishedAt: z.string().optional().describe('Delete tasks that finished processing before this date (ISO 8601 format)'),
    },
    async ({ statuses, types, indexUids, uids, canceledBy, beforeUid, beforeStartedAt, beforeFinishedAt }) => {
      try {
        const body: Record<string, any> = {};
        if (statuses && statuses.length > 0) body.statuses = statuses;
        if (types && types.length > 0) body.types = types;
        if (indexUids && indexUids.length > 0) body.indexUids = indexUids;
        if (uids && uids.length > 0) body.uids = uids;
        if (canceledBy && canceledBy.length > 0) body.canceledBy = canceledBy;
        if (beforeUid !== undefined) body.beforeUid = beforeUid;
        if (beforeStartedAt) body.beforeStartedAt = beforeStartedAt;
        if (beforeFinishedAt) body.beforeFinishedAt = beforeFinishedAt;
        
        const response = await apiClient.post('/tasks/delete', body);
        return {
          content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }],
        };
      } catch (error) {
        return createErrorResponse(error);
      }
    }
  );