get-settings
Retrieve all configuration settings for a specific Meilisearch index by providing its unique identifier, facilitating efficient index management and customization.
Instructions
Get all settings for a Meilisearch index
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| indexUid | Yes | Unique identifier of the index |
Implementation Reference
- src/tools/settings-tools.ts:26-35 (handler)The async handler function that fetches settings from the Meilisearch API for the given indexUid and returns them as JSON text content.async ({ indexUid }) => { try { const response = await apiClient.get(`/indexes/${indexUid}/settings`); return { content: [{ type: "text", text: JSON.stringify(response.data, null, 2) }], }; } catch (error) { return createErrorResponse(error); } }
- src/tools/settings-tools.ts:23-25 (schema)Input schema using Zod to validate the indexUid parameter.{ indexUid: z.string().describe("Unique identifier of the index"), },
- src/tools/settings-tools.ts:20-36 (registration)Registration of the get-settings tool using server.tool(), specifying name, description, input schema, and inline handler.server.tool( "get-settings", "Get all settings for a Meilisearch index", { indexUid: z.string().describe("Unique identifier of the index"), }, async ({ indexUid }) => { try { const response = await apiClient.get(`/indexes/${indexUid}/settings`); 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 which includes the get-settings tool.registerSettingsTools(server);