Skip to main content
Glama
OrionPotter

Meilisearch MCP Server

by OrionPotter

reset-settings

Reset all settings for a Meilisearch index to their default values using the index's unique identifier.

Instructions

Reset all settings for a Meilisearch index to their default values

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
indexUidYesUnique identifier of the index

Implementation Reference

  • The asynchronous handler function for the "reset-settings" tool. It performs a DELETE request to the Meilisearch API to reset all index settings to defaults, returning the response as formatted JSON or an error.
    async ({ indexUid }) => {
      try {
        const response = await apiClient.delete(`/indexes/${indexUid}/settings`);
        return {
          content: [{ type: "text", text: JSON.stringify(response.data, null, 2) }],
        };
      } catch (error) {
        return createErrorResponse(error);
      }
    }
  • Zod input schema defining the required 'indexUid' parameter as a string.
    {
      indexUid: z.string().describe("Unique identifier of the index"),
    },
  • Registration of the "reset-settings" tool via server.tool() call within the settings tools module, including name, description, schema, and handler.
    server.tool(
      "reset-settings",
      "Reset all settings for a Meilisearch index to their default values",
      {
        indexUid: z.string().describe("Unique identifier of the index"),
      },
      async ({ indexUid }) => {
        try {
          const response = await apiClient.delete(`/indexes/${indexUid}/settings`);
          return {
            content: [{ type: "text", text: JSON.stringify(response.data, null, 2) }],
          };
        } catch (error) {
          return createErrorResponse(error);
        }
      }
    );
  • src/index.ts:67-67 (registration)
    Top-level invocation of registerSettingsTools on the MCP server instance, which registers the "reset-settings" tool (and other settings tools).
    registerSettingsTools(server);

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/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 states the tool resets settings to defaults, implying a mutation, but doesn't disclose behavioral traits like whether this is destructive (likely yes, as it overwrites settings), requires specific permissions, has side effects, or returns any output. This leaves significant gaps for a mutation tool.

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 core action ('Reset all settings') and outcome ('to their default values'), with no wasted words. It's appropriately sized for a 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.

Completeness2/5

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

Given this is a mutation tool with no annotations and no output schema, the description is incomplete. It lacks details on behavioral aspects (e.g., destructiveness, permissions), return values, or error handling. While the purpose is clear, the context for safe and effective use is insufficient.

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.

Purpose5/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 ('all settings for a Meilisearch index'), specifying the outcome ('to their default values'). It distinguishes from sibling tools like 'update-settings' (which modifies settings) and various 'reset-' tools for specific setting categories (e.g., 'reset-ranking-rules'), making the scope explicit.

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 default settings are needed, but lacks explicit guidance on when to use this versus alternatives like 'update-settings' or individual 'reset-' tools for specific settings. No prerequisites or exclusions are mentioned, leaving the agent to infer context from the tool's purpose alone.

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