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);