get-synonyms
Retrieve synonyms configuration for a Meilisearch index to enhance search relevance by understanding alternative terms users might use.
Instructions
Get the synonyms setting
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| indexUid | Yes | Unique identifier of the index |
Implementation Reference
- src/tools/settings-tools.ts:155-164 (handler)Core handler function for the 'get-synonyms' tool (shared with other specific settings getters). Retrieves synonyms settings from Meilisearch API at `/indexes/${indexUid}/settings/synonyms` using apiClient, formats response as JSON text, or returns formatted error.
async ({ indexUid }) => { try { const response = await apiClient.get(`/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:152-154 (schema)Input schema using Zod for the 'get-synonyms' tool: requires 'indexUid' as a string.
{ indexUid: z.string().describe("Unique identifier of the index"), }, - src/tools/settings-tools.ts:120-124 (registration)Configuration entry in specificSettingsTools array defining name, endpoint ('synonyms'), and description for dynamic registration of 'get-synonyms' tool.
{ name: "get-synonyms", endpoint: "synonyms", description: "Get the synonyms setting", }, - src/tools/settings-tools.ts:147-166 (registration)Dynamic registration loop that calls server.tool() for each tool in specificSettingsTools, including 'get-synonyms', providing schema, handler, etc.
// Create a tool for each specific setting specificSettingsTools.forEach(({ name, endpoint, description }) => { server.tool( name, description, { indexUid: z.string().describe("Unique identifier of the index"), }, async ({ indexUid }) => { try { const response = await apiClient.get(`/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)Top-level registration call to registerSettingsTools(server), which dynamically registers the 'get-synonyms' tool and other settings tools.
registerSettingsTools(server);