update-stop-words
Modify stop words for a Meilisearch index to exclude common terms from search results, improving relevance by filtering out non-meaningful words.
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 logic for the update-stop-words tool: parses JSON value and sends PUT request to /indexes/{indexUid}/settings/stop-words via apiClient, returns formatted response or handles errors.
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)Input schema using Zod: indexUid (string), value (string as JSON). Used for all update-* tools including update-stop-words.
{ 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)Tool configuration object in updateSettingsTools array defining name, endpoint, and description for update-stop-words.
{ name: "update-stop-words", endpoint: "stop-words", description: "Update the stop words setting", }, - src/tools/settings-tools.ts:227-249 (registration)forEach loop that registers the update-stop-words tool (and others) by calling server.tool with name, description, schema, and shared handler using the endpoint 'stop-words'.
// 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 registration call to registerSettingsTools(server), which registers all settings tools including update-stop-words.
registerSettingsTools(server);