update-synonyms
Modify synonyms in a Meilisearch index to improve search relevance by mapping related terms for better query matching.
Instructions
Update the synonyms setting
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| indexUid | Yes | Unique identifier of the index | |
| value | Yes | JSON value for the setting |
Implementation Reference
- src/tools/settings-tools.ts:236-248 (handler)Handler function for the 'update-synonyms' tool. Parses the provided JSON string 'value' as synonyms and sends a PUT request to update the synonyms setting in the specified Meilisearch index.
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); } } - src/tools/settings-tools.ts:232-235 (schema)Input schema using Zod for the update-synonyms tool: requires indexUid (string) and value (string containing JSON for synonyms).
{ indexUid: z.string().describe("Unique identifier of the index"), value: z.string().describe("JSON value for the setting"), }, - src/tools/settings-tools.ts:228-250 (registration)Registration logic for 'update-synonyms' (and other update tools) via a forEach loop calling server.tool with the tool name from updateSettingsTools array (where update-synonyms is defined at lines 200-204), shared schema, and shared 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); } } ); }); - src/tools/settings-tools.ts:200-204 (helper)Configuration object in the updateSettingsTools array specifically for the 'update-synonyms' tool, providing its name, the Meilisearch endpoint '/synonyms', and description used during registration.
{ name: "update-synonyms", endpoint: "synonyms", description: "Update the synonyms setting", },