Meilisearch MCP Server

update-settings

Modify configuration parameters for a Meilisearch index by providing a JSON object with updated settings values.

Instructions

Update settings for a Meilisearch index

Input Schema

TableJSON Schema

Name	Required	Description	Default
`indexUid`	Yes	Unique identifier of the index
`settings`	Yes	JSON object containing settings to update

Implementation Reference

src/tools/settings-tools.ts:46-66 (handler)

The handler function for the 'update-settings' tool. It validates and parses the settings JSON input, then sends a PATCH request to the Meilisearch API to update the index settings.

async ({ indexUid, settings }) => {
  try {
    // Parse the settings string to ensure it's valid JSON
    const parsedSettings = JSON.parse(settings);
    
    // Ensure settings is an object
    if (typeof parsedSettings !== 'object' || parsedSettings === null || Array.isArray(parsedSettings)) {
      return {
        isError: true,
        content: [{ type: "text", text: "Settings must be a JSON object" }],
      };
    }
    
    const response = await apiClient.patch(`/indexes/${indexUid}/settings`, parsedSettings);
    return {
      content: [{ type: "text", text: JSON.stringify(response.data, null, 2) }],
    };
  } catch (error) {
    return createErrorResponse(error);
  }
}

src/tools/settings-tools.ts:42-45 (schema)

Input schema for the 'update-settings' tool using Zod, defining indexUid and settings parameters.

{
  indexUid: z.string().describe("Unique identifier of the index"),
  settings: z.string().describe("JSON object containing settings to update"),
},

src/tools/settings-tools.ts:39-67 (registration)

Direct registration of the 'update-settings' tool on the MCP server within the registerSettingsTools function.

server.tool(
  "update-settings",
  "Update settings for a Meilisearch index",
  {
    indexUid: z.string().describe("Unique identifier of the index"),
    settings: z.string().describe("JSON object containing settings to update"),
  },
  async ({ indexUid, settings }) => {
    try {
      // Parse the settings string to ensure it's valid JSON
      const parsedSettings = JSON.parse(settings);
      
      // Ensure settings is an object
      if (typeof parsedSettings !== 'object' || parsedSettings === null || Array.isArray(parsedSettings)) {
        return {
          isError: true,
          content: [{ type: "text", text: "Settings must be a JSON object" }],
        };
      }
      
      const response = await apiClient.patch(`/indexes/${indexUid}/settings`, parsedSettings);
      return {
        content: [{ type: "text", text: JSON.stringify(response.data, null, 2) }],
      };
    } catch (error) {
      return createErrorResponse(error);
    }
  }
);

src/index.ts:67-67 (registration)
Top-level registration call that invokes registerSettingsTools to add the 'update-settings' tool (among others) to the main MCP server instance.
```
registerSettingsTools(server);
```

Schema Changelog

Changes observed during successful MCP inspections.

First observedDec 10, 2025

TDQS

C2.9/5.0

Behavior2/5

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

With no annotations provided, the description carries full burden but only states it 'updates settings' without disclosing behavioral traits like whether this is a partial or full update, if it's idempotent, what happens on errors, or if it triggers asynchronous tasks. 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 with no wasted words. It's front-loaded with the core action and resource, making it easy to parse quickly.

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?

For a mutation tool with no annotations and no output schema, the description is insufficient. It doesn't cover behavioral aspects like side effects, error handling, or return values, leaving the agent with incomplete context for safe and effective use.

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%, so the schema already documents both parameters ('indexUid' and 'settings'). The description adds no additional meaning beyond what's in the schema, such as explaining the structure of the 'settings' JSON or providing examples, meeting the baseline for high 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 ('Update') and resource ('settings for a Meilisearch index'), making the purpose evident. However, it doesn't differentiate from sibling tools like 'update-index' or 'reset-settings', which could cause confusion about scope.

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 is provided on when to use this tool versus alternatives like 'reset-settings' or 'get-settings'. The description lacks context about prerequisites, such as whether the index must exist or if specific permissions are required.

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

Deploy Server