update-synonyms
Modify search synonyms in a Meilisearch index to improve query matching and enhance search relevance.
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:200-204 (registration)Configuration object defining the 'update-synonyms' tool, specifying its name, endpoint ('synonyms'), and description for registration.
{ name: "update-synonyms", endpoint: "synonyms", description: "Update the synonyms setting", }, - src/tools/settings-tools.ts:232-235 (schema)Zod input schema for the 'update-synonyms' tool, requiring indexUid (string) and value (JSON string 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:236-248 (handler)Handler function for 'update-synonyms': parses JSON value and performs PUT request to `/indexes/{indexUid}/settings/synonyms` via apiClient.
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:227-249 (registration)Loop that registers the 'update-synonyms' tool (and others) by calling server.tool with dynamic name, endpoint 'synonyms', shared schema, and handler.
// Create an update tool for each specific setting 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); } } );