get-synonyms
Retrieve configured synonyms for a specific Meilisearch index to enhance search relevance and expand query understanding.
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:154-163 (handler)The core handler function for the 'get-synonyms' tool. It fetches the synonyms settings from the Meilisearch API endpoint `/indexes/${indexUid}/settings/synonyms` where endpoint='synonyms'.}, 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 validation using Zod for the 'get-synonyms' tool, requiring the indexUid parameter.{ indexUid: z.string().describe("Unique identifier of the index"), },
- src/tools/settings-tools.ts:120-124 (registration)Configuration object in the specificSettingsTools array that defines the name, endpoint, and description for registering the 'get-synonyms' tool.{ name: "get-synonyms", endpoint: "synonyms", description: "Get the synonyms setting", },
- src/tools/settings-tools.ts:147-166 (registration)The dynamic registration loop that creates and registers the 'get-synonyms' tool (and others) on the MCP server using the configuration from specificSettingsTools.// 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 call to registerSettingsTools on the MCP server instance, which in turn registers the 'get-synonyms' tool.registerSettingsTools(server);