get-pagination
Retrieve pagination settings for a Meilisearch index to control how search results are divided into pages.
Instructions
Get the pagination setting
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:155-164 (handler)Handler function that executes the get-pagination tool logic: retrieves pagination settings from Meilisearch API using the dynamic endpoint.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 validation for the get-pagination tool, requiring the indexUid parameter.{ indexUid: z.string().describe("Unique identifier of the index"), },
- src/tools/settings-tools.ts:140-144 (registration)Tool configuration object that defines the name, endpoint, and description for dynamic registration of get-pagination.{ name: "get-pagination", endpoint: "pagination", description: "Get the pagination setting", },
- src/tools/settings-tools.ts:149-165 (registration)Dynamic server.tool registration call that registers the get-pagination tool using the configuration.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 registration of the settings tools module, which includes get-pagination.registerSettingsTools(server);