get-settings
Retrieve all configuration settings for a Meilisearch index to manage search behavior, ranking rules, and display options.
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 retrieves all settings for the specified Meilisearch index using the apiClient and returns formatted JSON or error response.
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)Zod input schema defining the required 'indexUid' parameter as a string.
{ indexUid: z.string().describe("Unique identifier of the index"), }, - src/tools/settings-tools.ts:20-36 (registration)Direct registration of the 'get-settings' tool on the MCP server, including name, description, 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 call to registerSettingsTools during MCP server initialization, which includes the 'get-settings' tool.
registerSettingsTools(server);