update-pagination
Modify pagination settings for a Meilisearch index to control how search results are divided into pages, enabling customized result display and navigation.
Instructions
Update the pagination setting
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| indexUid | Yes | Unique identifier of the index | |
| value | Yes | JSON value for the setting |
Implementation Reference
- src/tools/settings-tools.ts:236-248 (handler)Handler function for the update-pagination tool (shared with other update-* tools). It JSON-parses the 'value' parameter and issues a PUT request to `/indexes/${indexUid}/settings/pagination` via apiClient to update the pagination settings.
async ({ indexUid, value }) => { try { // Parse the value string to ensure it's valid JSON const parsedValue = JSON.parse(value); const response = await apiClient.put(`/indexes/${indexUid}/settings/${endpoint}`, parsedValue); return { content: [{ type: "text", text: JSON.stringify(response.data, null, 2) }], }; } catch (error) { return createErrorResponse(error); } } - src/tools/settings-tools.ts:232-235 (schema)Input schema (Zod) for the update-pagination tool: requires 'indexUid' (string) and 'value' (stringified JSON for pagination settings).
{ indexUid: z.string().describe("Unique identifier of the index"), value: z.string().describe("JSON value for the setting"), }, - src/tools/settings-tools.ts:220-224 (registration)Configuration entry in updateSettingsTools array used to dynamically register the 'update-pagination' tool with name, endpoint ('pagination'), and description.
{ name: "update-pagination", endpoint: "pagination", description: "Update the pagination setting", }, - src/tools/settings-tools.ts:227-250 (registration)forEach loop over updateSettingsTools array that calls server.tool() to register each update tool, including 'update-pagination', with its specific endpoint.
// Create an update tool for each specific setting updateSettingsTools.forEach(({ name, endpoint, description }) => { server.tool( name, description, { indexUid: z.string().describe("Unique identifier of the index"), value: z.string().describe("JSON value for the setting"), }, async ({ indexUid, value }) => { try { // Parse the value string to ensure it's valid JSON const parsedValue = JSON.parse(value); const response = await apiClient.put(`/indexes/${indexUid}/settings/${endpoint}`, parsedValue); 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(server) in main server setup, which registers all settings tools including 'update-pagination'.
registerSettingsTools(server);