update-settings
Modify configuration parameters for a Meilisearch search index to customize search behavior, ranking rules, and filtering options.
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)Handler function for the 'update-settings' tool. Parses the settings JSON input, validates it's an object, and sends a PATCH request to update the Meilisearch index settings via apiClient. Handles errors with createErrorResponse.
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 using Zod for the tool: requires indexUid (string) and settings (string representing JSON object).
{ 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)Registration of the 'update-settings' tool on the MCP server using server.tool(), including name, description, input schema, and handler 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(server), which includes the 'update-settings' tool among other settings tools.
registerSettingsTools(server);