get-stop-words
Retrieve stop words configuration for a Meilisearch index to control which words are ignored during search queries.
Instructions
Get the stop words 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 implements the core logic of the 'get-stop-words' tool by retrieving the stop-words settings from the Meilisearch API endpoint `/indexes/{indexUid}/settings/stop-words`.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 an 'indexUid' parameter.{ indexUid: z.string().describe("Unique identifier of the index"), },
- src/tools/settings-tools.ts:115-119 (registration)Configuration object in the specificSettingsTools array that defines the name, endpoint ('stop-words'), and description for the 'get-stop-words' tool.{ name: "get-stop-words", endpoint: "stop-words", description: "Get the stop words setting", },
- src/tools/settings-tools.ts:147-166 (registration)Registration loop that dynamically registers the 'get-stop-words' tool (and others) using server.tool() with the shared schema and handler, using the endpoint from the configuration.// 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(server), which triggers the registration of the 'get-stop-words' tool among others.registerSettingsTools(server);