reset-synonyms
Reset synonyms to default values for a Meilisearch index to restore standard search behavior and remove custom synonym mappings.
Instructions
Reset the synonyms setting to its default value
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| indexUid | Yes | Unique identifier of the index |
Implementation Reference
- src/tools/settings-tools.ts:319-328 (handler)Handler function that executes the reset-synonyms tool by sending a DELETE request to the Meilisearch API endpoint `/indexes/{indexUid}/settings/synonyms` to reset synonyms to default values, returning the API response as JSON or an error response.
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/tools/settings-tools.ts:316-318 (schema)Zod input schema for the reset-synonyms tool, requiring a string indexUid parameter.
{ indexUid: z.string().describe("Unique identifier of the index"), }, - src/tools/settings-tools.ts:284-288 (registration)Configuration object in resetSettingsTools array that defines the name, endpoint, and description for the reset-synonyms tool.
{ name: "reset-synonyms", endpoint: "synonyms", description: "Reset the synonyms setting to its default value", }, - src/tools/settings-tools.ts:312-330 (registration)Dynamic registration loop that calls server.tool() for each reset tool config, including reset-synonyms, using the shared schema and handler template.
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)Invocation of registerSettingsTools on the MCP server instance, which registers the reset-synonyms tool among others.
registerSettingsTools(server);