update-stop-words
Modify stop words for a Meilisearch index to control which common words are ignored during searches, improving search relevance by excluding non-essential terms.
Instructions
Update the stop words 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 that parses the input value as JSON and sends a PUT request to the Meilisearch API endpoint for updating stop-words (and other specific settings).
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)Zod input schema defining parameters: indexUid (string) and value (JSON string for the stop-words list).
{ indexUid: z.string().describe("Unique identifier of the index"), value: z.string().describe("JSON value for the setting"), }, - src/tools/settings-tools.ts:195-199 (registration)Configuration entry in the updateSettingsTools array that specifies the tool name 'update-stop-words', its API endpoint 'stop-words', and description; used by the registration loop.
{ name: "update-stop-words", endpoint: "stop-words", description: "Update the stop words setting", }, - src/tools/settings-tools.ts:227-250 (registration)forEach loop that registers all specific update tools, including 'update-stop-words', by calling server.tool with dynamic name, shared schema, and shared 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); } } ); }); - src/index.ts:67-67 (registration)Top-level call to registerSettingsTools which includes the registration of 'update-stop-words' among other settings tools.
registerSettingsTools(server);