Skip to main content
Glama
OrionPotter

Meilisearch MCP Server

by OrionPotter

reset-filterable-attributes

Restore filterable attributes to default values for a Meilisearch index, clearing custom settings to reset search filtering behavior.

Instructions

Reset the filterable attributes setting to its default value

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
indexUidYesUnique identifier of the index

Implementation Reference

  • Handler function that executes the tool by sending a DELETE request to the Meilisearch API endpoint for filterable-attributes settings of the specified 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);
      }
    }
  • Input schema definition using Zod: requires 'indexUid' as a string.
    {
      indexUid: z.string().describe("Unique identifier of the index"),
    },
  • Tool configuration object in the resetSettingsTools array, defining name, endpoint, and description for registration.
    {
      name: "reset-filterable-attributes",
      endpoint: "filterable-attributes",
      description: "Reset the filterable attributes setting to its default value",
    },
  • Registration loop that calls server.tool for each reset tool, including 'reset-filterable-attributes', providing schema and handler.
    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);
          }
        }
      );
    });
  • src/index.ts:67-67 (registration)
    Top-level call to registerSettingsTools on the MCP server instance, which includes the reset-filterable-attributes tool.
    registerSettingsTools(server);

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.9/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 indicates a mutation ('reset') but doesn't disclose behavioral traits like whether this requires specific permissions, what the default value is, if changes are reversible, or potential side effects. The description is minimal and lacks necessary context 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 directly states the tool's purpose without unnecessary words. It's appropriately sized and front-loaded, with zero waste.

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 inadequate. It lacks information about what the reset entails, what the default value is, potential impacts, or response format. For a tool that modifies system settings, more context is needed.

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' well-documented in the schema. The description doesn't add any parameter-specific information beyond what the schema provides, so it meets the baseline score of 3 for high schema coverage.

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 resource ('filterable attributes setting'), specifying it sets to default value. It distinguishes from siblings like 'update-filterable-attributes' by focusing on resetting rather than modifying, but doesn't explicitly contrast with other reset tools like 'reset-displayed-attributes'.

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 guidance on when to use this tool versus alternatives is provided. The description doesn't mention prerequisites, when resetting is appropriate, or contrast with other tools like 'update-filterable-attributes' or 'get-filterable-attributes'.

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