get-task
Retrieve detailed status and progress information for a specific Meilisearch task using its unique identifier to monitor indexing or search operations.
Instructions
Get information about a specific task
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| taskUid | Yes | Unique identifier of the task |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"taskUid": {
"description": "Unique identifier of the task",
"type": "number"
}
},
"required": [
"taskUid"
],
"type": "object"
}
Implementation Reference
- src/tools/task-tools.ts:85-94 (handler)Executes the get-task tool logic: fetches the specific task by UID from Meilisearch API and returns formatted JSON response or error.async ({ taskUid }: GetTaskParams) => { try { const response = await apiClient.get(`/tasks/${taskUid}`); return { content: [{ type: "text", text: JSON.stringify(response.data, null, 2) }], }; } catch (error) { return createErrorResponse(error); } }
- src/tools/task-tools.ts:82-84 (schema)Zod schema defining the input parameters for the get-task tool.{ taskUid: z.number().describe("Unique identifier of the task"), },
- src/tools/task-tools.ts:80-95 (registration)Registers the 'get-task' tool with the MCP server, specifying name, description, input schema, and handler function."get-task", "Get information about a specific task", { taskUid: z.number().describe("Unique identifier of the task"), }, async ({ taskUid }: GetTaskParams) => { try { const response = await apiClient.get(`/tasks/${taskUid}`); return { content: [{ type: "text", text: JSON.stringify(response.data, null, 2) }], }; } catch (error) { return createErrorResponse(error); } } );
- src/tools/task-tools.ts:23-25 (helper)TypeScript interface for the parameters accepted by the get-task handler.interface GetTaskParams { taskUid: number; }
- src/index.ts:70-70 (registration)Top-level registration call that includes the get-task tool via the task-tools module.registerTaskTools(server);