get-settings
Retrieve all configuration settings for a specific Meilisearch index to manage search behavior and optimize performance.
Instructions
Get all settings for a Meilisearch index
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:26-35 (handler)The async handler function for the 'get-settings' tool. It makes a GET request to the Meilisearch API to retrieve all settings for the specified index and returns the JSON response, or an error response if failed.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 for the 'get-settings' tool, defining the required 'indexUid' parameter.{ 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 using server.tool(), specifying name, description, input schema, and inline handler function.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)Invocation of registerSettingsTools on the main MCP server instance, which registers the 'get-settings' tool (among other settings tools).registerSettingsTools(server);