Skip to main content
Glama
OrionPotter

Meilisearch MCP Server

by OrionPotter

reset-sortable-attributes

Reset sortable attributes to default values in a Meilisearch index to restore original search sorting behavior.

Instructions

Reset the sortable attributes setting to its default value

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
indexUidYesUnique identifier of the index

Implementation Reference

  • Handler function that performs a DELETE request to reset the 'sortable-attributes' setting for the specified Meilisearch index using the apiClient.
    async ({ indexUid }) => {
      try {
        const response = await apiClient.delete(`/indexes/${indexUid}/settings/${endpoint}`);
        return {
          content: [{ type: "text", text: JSON.stringify(response.data, null, 2) }],
        };
      } catch (error) {
        return createErrorResponse(error);
      }
    }
  • Input schema definition for the tool, requiring an 'indexUid' string parameter.
    {
      indexUid: z.string().describe("Unique identifier of the index"),
    },
  • Configuration entry in the resetSettingsTools array that defines the tool name, endpoint, and description for registration.
    {
      name: "reset-sortable-attributes",
      endpoint: "sortable-attributes",
      description: "Reset the sortable attributes setting to its default value",
    },
  • Registration logic via forEach loop over resetSettingsTools array, calling server.tool for each, including 'reset-sortable-attributes'.
    // Create a reset tool for each specific setting
    resetSettingsTools.forEach(({ name, endpoint, description }) => {
      server.tool(
        name,
        description,
        {
          indexUid: z.string().describe("Unique identifier of the index"),
        },
        async ({ indexUid }) => {
          try {
            const response = await apiClient.delete(`/indexes/${indexUid}/settings/${endpoint}`);
            return {
              content: [{ type: "text", text: JSON.stringify(response.data, null, 2) }],
            };
          } catch (error) {
            return createErrorResponse(error);
          }
        }
      );
    });

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.3/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 full burden. It mentions 'reset' to 'default value', which implies a mutation, but doesn't disclose behavioral traits like whether this is destructive (likely yes, as it changes settings), requires specific permissions, has side effects, or provides confirmation. For a mutation tool with zero annotation coverage, this is a significant gap in transparency.

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

Conciseness5/5

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

The description is a single, efficient sentence that front-loads the key action ('reset') and target ('sortable attributes setting'), with no wasted words. It's appropriately sized for a simple tool with one parameter and clear purpose.

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

Completeness3/5

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

Given the tool's complexity (simple mutation with one parameter), no annotations, and no output schema, the description is minimally adequate. It states what the tool does but lacks details on behavior, output, or error handling. For a mutation tool, this leaves gaps that could hinder an AI agent's correct invocation without additional context.

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 single parameter 'indexUid' documented as 'Unique identifier of the index'. The description adds no additional meaning beyond this, such as format examples or constraints. With high schema coverage, the baseline is 3, as the schema adequately handles parameter documentation.

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

Purpose4/5

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

The description clearly states the action ('reset') and the target resource ('sortable attributes setting'), specifying it returns to 'its default value'. This distinguishes it from sibling tools like 'update-sortable-attributes' or 'get-sortable-attributes'. However, it doesn't explicitly mention the index context, which is implied but could be more specific.

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

Usage Guidelines3/5

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

The description implies usage when reverting sortable attributes to defaults, but provides no explicit guidance on when to use this versus alternatives like 'update-sortable-attributes' or 'get-sortable-attributes'. It lacks context about prerequisites, such as needing an existing index, or exclusions, like not being applicable to non-sortable attributes.

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