Skip to main content
Glama
OrionPotter

Meilisearch MCP Server

by OrionPotter

update-distinct-attribute

Modify the distinct attribute setting in a Meilisearch index to control how duplicate results are handled during search operations.

Instructions

Update the distinct attribute setting

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
indexUidYesUnique identifier of the index
valueYesJSON value for the setting

Implementation Reference

  • Configuration object in the updateSettingsTools array that defines the name, endpoint, and description for registering the 'update-distinct-attribute' tool.
    {
      name: "update-distinct-attribute",
      endpoint: "distinct-attribute",
      description: "Update the distinct attribute setting",
    },
  • Shared Zod input schema for all update tools, including 'update-distinct-attribute': requires indexUid (string) and value (stringified JSON).
      indexUid: z.string().describe("Unique identifier of the index"),
      value: z.string().describe("JSON value for the setting"),
    },
  • Handler function shared by update tools: parses the JSON value input, performs a PUT request to the Meilisearch API at `/indexes/${indexUid}/settings/${endpoint}` (where endpoint is 'distinct-attribute' for this tool), and returns the JSON response or handles errors.
      async ({ indexUid, value }) => {
        try {
          // Parse the value string to ensure it's valid JSON
          const parsedValue = JSON.parse(value);
          
          const response = await apiClient.put(`/indexes/${indexUid}/settings/${endpoint}`, parsedValue);
          return {
            content: [{ type: "text", text: JSON.stringify(response.data, null, 2) }],
          };
        } catch (error) {
          return createErrorResponse(error);
        }
      }
    );
  • The forEach loop that dynamically registers the 'update-distinct-attribute' tool (and other update tools) on the MCP server using server.tool, incorporating the configuration, schema, and handler.
    updateSettingsTools.forEach(({ name, endpoint, description }) => {
      server.tool(
        name,
        description,
        {
          indexUid: z.string().describe("Unique identifier of the index"),
          value: z.string().describe("JSON value for the setting"),
        },
        async ({ indexUid, value }) => {
          try {
            // Parse the value string to ensure it's valid JSON
            const parsedValue = JSON.parse(value);
            
            const response = await apiClient.put(`/indexes/${indexUid}/settings/${endpoint}`, parsedValue);
            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

C2.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 for behavioral disclosure. 'Update' implies a mutation, but the description doesn't specify whether this requires specific permissions, what the effect is on existing data, whether changes are reversible, or any rate limits. It mentions a 'setting' but doesn't explain what that entails. This is inadequate for a mutation tool with zero annotation coverage.

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 with zero wasted words. It's front-loaded and appropriately sized for the tool's complexity, though this conciseness comes at the cost of clarity and completeness. Every word earns its place, even if the content is insufficient.

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 tool's complexity (a mutation operation with no annotations and no output schema), the description is incomplete. It doesn't explain what a 'distinct attribute' is, what the update does, potential side effects, or return values. While the schema covers parameters well, the overall context for safe and correct usage is lacking, especially compared to sibling tools that have more descriptive names like 'update-settings'.

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 both parameters ('indexUid' and 'value') clearly documented in the schema. The description adds no additional meaning about these parameters—it doesn't clarify what 'distinct attribute' means, what format 'value' should take beyond 'JSON value', or how this interacts with the index. 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.

Purpose2/5

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

The description 'Update the distinct attribute setting' is essentially a tautology that restates the tool name 'update-distinct-attribute' without adding meaningful specificity. It doesn't clarify what a 'distinct attribute' is, what resource it modifies, or how it differs from sibling tools like 'get-distinct-attribute' or 'reset-distinct-attribute'. The purpose remains vague despite the clear verb 'update'.

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

Usage Guidelines1/5

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

There is no guidance on when to use this tool versus alternatives. The description doesn't mention prerequisites, when this operation is appropriate, or how it relates to sibling tools like 'reset-distinct-attribute' (which likely clears the setting) or 'get-distinct-attribute' (which retrieves it). Without any usage context, the agent lacks direction.

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