get-stop-words
Retrieve the stop words configuration for a Meilisearch index to understand which words are excluded from search queries for better relevance.
Instructions
Get the stop words 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)Handler function that executes the get-stop-words tool by calling the Meilisearch API to retrieve stop-words settings for the given 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/tools/settings-tools.ts:152-154 (schema)Input schema for the get-stop-words tool, requiring the indexUid parameter.{ indexUid: z.string().describe("Unique identifier of the index"), },
- src/tools/settings-tools.ts:115-119 (registration)Configuration entry in specificSettingsTools array used for dynamic registration of the get-stop-words tool.{ name: "get-stop-words", endpoint: "stop-words", description: "Get the stop words setting", },
- src/tools/settings-tools.ts:148-166 (registration)Loop that dynamically registers the get-stop-words tool (and others) using the configuration from specificSettingsTools.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 which includes registration of get-stop-words.registerSettingsTools(server);