list-tasks

Instructions

Implementation Reference

• src/tools/task-tools.ts:58-75 (handler)

  Handler function that implements the core logic of the 'list-tasks' tool by building query parameters and fetching tasks from the Meilisearch API.

  async ({ limit, from, statuses, types, indexUids, uids }: ListTasksParams) => {
    try {
      const params: Record<string, any> = {};
      if (limit !== undefined) params.limit = limit;
      if (from !== undefined) params.from = from;
      if (statuses && statuses.length > 0) params.statuses = statuses.join(',');
      if (types && types.length > 0) params.types = types.join(',');
      if (indexUids && indexUids.length > 0) params.indexUids = indexUids.join(',');
      if (uids && uids.length > 0) params.uids = uids.join(',');
      
      const response = await apiClient.get('/tasks', { params });
      return {
        content: [{ type: "text", text: JSON.stringify(response.data, null, 2) }],
      };
    } catch (error) {
      return createErrorResponse(error);
    }
  }

• src/tools/task-tools.ts:50-57 (schema)

  Zod schema defining the input parameters and validation for the 'list-tasks' tool.

  {
    limit: z.number().min(0).optional().describe("Maximum number of tasks to return"),
    from: z.number().min(0).optional().describe("Task uid from which to start fetching"),
    statuses: z.array(z.enum(["enqueued", "processing", "succeeded", "failed", "canceled"])).optional().describe("Statuses of tasks to return"),
    types: z.array(z.enum(["indexCreation", "indexUpdate", "indexDeletion", "documentAddition", "documentUpdate", "documentDeletion", "settingsUpdate", "dumpCreation", "taskCancelation"])).optional().describe("Types of tasks to return"),
    indexUids: z.array(z.string()).optional().describe("UIDs of the indexes on which tasks were performed"),
    uids: z.array(z.number()).optional().describe("UIDs of specific tasks to return"),
  },

• src/tools/task-tools.ts:48-76 (registration)

  Registers the 'list-tasks' tool on the MCP server, including name, description, input schema, and handler function.

    "list-tasks",
    "List tasks with optional filtering",
    {
      limit: z.number().min(0).optional().describe("Maximum number of tasks to return"),
      from: z.number().min(0).optional().describe("Task uid from which to start fetching"),
      statuses: z.array(z.enum(["enqueued", "processing", "succeeded", "failed", "canceled"])).optional().describe("Statuses of tasks to return"),
      types: z.array(z.enum(["indexCreation", "indexUpdate", "indexDeletion", "documentAddition", "documentUpdate", "documentDeletion", "settingsUpdate", "dumpCreation", "taskCancelation"])).optional().describe("Types of tasks to return"),
      indexUids: z.array(z.string()).optional().describe("UIDs of the indexes on which tasks were performed"),
      uids: z.array(z.number()).optional().describe("UIDs of specific tasks to return"),
    },
    async ({ limit, from, statuses, types, indexUids, uids }: ListTasksParams) => {
      try {
        const params: Record<string, any> = {};
        if (limit !== undefined) params.limit = limit;
        if (from !== undefined) params.from = from;
        if (statuses && statuses.length > 0) params.statuses = statuses.join(',');
        if (types && types.length > 0) params.types = types.join(',');
        if (indexUids && indexUids.length > 0) params.indexUids = indexUids.join(',');
        if (uids && uids.length > 0) params.uids = uids.join(',');
        
        const response = await apiClient.get('/tasks', { params });
        return {
          content: [{ type: "text", text: JSON.stringify(response.data, null, 2) }],
        };
      } catch (error) {
        return createErrorResponse(error);
      }
    }
  );

• src/index.ts:70-70 (registration)

  Top-level call to register all task management tools, including 'list-tasks', on the main MCP server instance.

  registerTaskTools(server);

• src/tools/task-tools.ts:14-21 (schema)

  TypeScript interface defining the parameter types used in the 'list-tasks' handler.

  interface ListTasksParams {
    limit?: number;
    from?: number;
    statuses?: string[];
    types?: string[];
    indexUids?: string[];
    uids?: number[];
  }