get-stop-words
Retrieve configured stop words from a Meilisearch index to understand which common words are excluded from search queries for improved 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 logic: retrieves the stop-words setting from the Meilisearch API for the specified indexUid using the 'stop-words' endpoint.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)Zod 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:147-166 (registration)Registration code that dynamically creates and registers the get-stop-words tool (via the specificSettingsTools array) with the MCP server.// 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, which includes registration of the get-stop-words tool.registerSettingsTools(server);
- src/tools/settings-tools.ts:115-119 (helper)Configuration object in specificSettingsTools array that specifies the name, endpoint, and description for the get-stop-words tool.{ name: "get-stop-words", endpoint: "stop-words", description: "Get the stop words setting", },