Skip to main content
Glama
OrionPotter

Meilisearch MCP Server

by OrionPotter

get-task

Retrieve detailed status and progress information for a specific Meilisearch task using its unique identifier to monitor indexing or operation completion.

Instructions

Get information about a specific task

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
taskUidYesUnique identifier of the task

Implementation Reference

  • The handler function that implements the core logic of the 'get-task' tool. It makes an API call to retrieve details of the specified task and returns the result as formatted JSON or an error response.
    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);
      }
    }
  • Zod schema for validating the input parameters of the 'get-task' tool, specifically requiring a 'taskUid' number.
    {
      taskUid: z.number().describe("Unique identifier of the task"),
    },
  • TypeScript interface defining the expected parameters for the 'get-task' tool handler.
    interface GetTaskParams {
      taskUid: number;
    }
  • The registration of the 'get-task' tool using server.tool(), including name, description, input schema, and handler function.
    server.tool(
      "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/index.ts:70-70 (registration)
    Top-level call to register the task tools module, which includes the 'get-task' tool.
    registerTaskTools(server);

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.6/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden. It states it 'gets information,' implying a read-only operation, but doesn't disclose behavioral traits such as permissions required, rate limits, error handling, or what happens if the taskUid doesn't exist. This leaves significant gaps for a tool that likely interacts with a task management system.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, straightforward sentence that efficiently conveys the core purpose without unnecessary words. It's appropriately sized for a simple tool, though it could be slightly more informative without losing conciseness.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity of task-related operations (with many sibling tools), no annotations, and no output schema, the description is incomplete. It doesn't explain what information is returned, how errors are handled, or how it fits into the broader context of task management, making it inadequate for full understanding.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, with the parameter 'taskUid' documented as 'Unique identifier of the task.' The description adds no additional meaning beyond this, as it doesn't explain the format, range, or source of taskUid. Since the schema does the heavy lifting, the baseline score of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'Get information about a specific task' clearly states the verb ('Get') and resource ('task'), but it's vague about what information is retrieved. It distinguishes from siblings like 'list-tasks' (which lists multiple tasks) but doesn't specify how it differs from 'get-tasks' (plural) or what makes a task 'specific' beyond the parameter.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No explicit guidance on when to use this tool versus alternatives like 'get-tasks' or 'list-tasks' is provided. The description implies usage for a single task via the parameter, but it doesn't clarify prerequisites, error conditions, or when other tools might be more appropriate.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.