update-pagination
Modify pagination settings for a Meilisearch index to control how search results are divided into pages, enabling customization of 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)The inline async handler function that parses the input value, makes a PUT request to the Meilisearch API to update the pagination settings for the specified index, and returns the response or error.
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)Zod input schema defining parameters: indexUid (string) and value (JSON string 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 that specifies the name, Meilisearch endpoint, and description for the update-pagination tool, used to dynamically register it.
{ name: "update-pagination", endpoint: "pagination", description: "Update the pagination setting", }, - src/tools/settings-tools.ts:227-250 (registration)The forEach loop that registers the update-pagination tool (and others) by calling server.tool with the name from the array, description, schema, and shared handler logic.
// 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)Top-level call to registerSettingsTools on the MCP server instance, which includes registration of the update-pagination tool.
registerSettingsTools(server);