get-synonyms
Retrieve configured synonyms for a Meilisearch index to improve search relevance by expanding query terms.
Instructions
Get the synonyms setting
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| indexUid | Yes | Unique identifier of the index |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"indexUid": {
"description": "Unique identifier of the index",
"type": "string"
}
},
"required": [
"indexUid"
],
"type": "object"
}
Implementation Reference
- src/tools/settings-tools.ts:155-164 (handler)Handler function that executes the get-synonyms tool. Retrieves synonyms settings from Meilisearch via API call to `/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 for the get-synonyms tool, defining the required 'indexUid' parameter.{ indexUid: z.string().describe("Unique identifier of the index"), },
- src/tools/settings-tools.ts:120-124 (registration)Configuration entry in specificSettingsTools array that specifies 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:149-165 (registration)Dynamic registration of the get-synonyms tool via server.tool() in the forEach loop over specificSettingsTools.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 invocation of registerSettingsTools(server), which registers the get-synonyms tool among other settings tools.registerSettingsTools(server);