get-pagination
Retrieve pagination configuration for a Meilisearch index to manage how search results are divided into pages.
Instructions
Get the pagination setting
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| indexUid | Yes | Unique identifier of the index |
Implementation Reference
- src/tools/settings-tools.ts:155-163 (handler)Handler function that executes the get-pagination tool by fetching pagination settings from the Meilisearch API endpoint `/indexes/{indexUid}/settings/pagination`. Uses shared logic from the specificSettingsTools registration loop.
async ({ indexUid }) => { try { const response = await apiClient.get(`/indexes/${indexUid}/settings/${endpoint}`); return { content: [{ type: "text", text: JSON.stringify(response.data, null, 2) }], }; } catch (error) { return createErrorResponse(error); } - src/tools/settings-tools.ts:152-154 (schema)Input schema for the get-pagination tool, validated using Zod. Requires `indexUid` parameter.
{ indexUid: z.string().describe("Unique identifier of the index"), }, - src/tools/settings-tools.ts:140-144 (registration)Configuration object in specificSettingsTools array that defines the tool name, endpoint, and description for dynamic registration of the get-pagination tool.
{ name: "get-pagination", endpoint: "pagination", description: "Get the pagination setting", }, - src/tools/settings-tools.ts:147-166 (registration)Dynamic registration loop using server.tool() for all specific get-settings tools, including get-pagination.
// Create a tool for each specific setting specificSettingsTools.forEach(({ name, endpoint, description }) => { server.tool( name, description, { indexUid: z.string().describe("Unique identifier of the index"), }, async ({ indexUid }) => { try { const response = await apiClient.get(`/indexes/${indexUid}/settings/${endpoint}`); 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(server) in the main MCP server initialization, which registers all settings tools including get-pagination.
registerSettingsTools(server);