get-typo-tolerance
Retrieve typo tolerance configuration for a Meilisearch index to understand how search handles spelling errors.
Instructions
Get the typo tolerance 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 for the get-typo-tolerance tool. Fetches the typo tolerance setting from Meilisearch API endpoint `/indexes/${indexUid}/settings/typo-tolerance`.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-typo-tolerance tool: requires indexUid as string.{ indexUid: z.string().describe("Unique identifier of the index"), },
- src/tools/settings-tools.ts:130-134 (registration)Configuration object in specificSettingsTools array that defines the name, endpoint, and description for registering the get-typo-tolerance tool.{ name: "get-typo-tolerance", endpoint: "typo-tolerance", description: "Get the typo tolerance setting", },
- src/tools/settings-tools.ts:147-166 (registration)Registration loop that dynamically registers the get-typo-tolerance tool (and others) using server.tool with the configuration from the array.// 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); } } ); });