stats
Retrieve statistics for all indexes or a specific index in Meilisearch to monitor performance and track data metrics.
Instructions
Get statistics about all indexes or a specific index
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| indexUid | No | Unique identifier of the index (optional, if not provided stats for all indexes will be returned) |
Implementation Reference
- src/tools/system-tools.ts:77-87 (handler)The handler function for the 'stats' tool that fetches statistics from the Meilisearch API (/stats for all indexes or /indexes/{indexUid}/stats for specific index) and returns formatted JSON response or error.
async ({ indexUid }) => { try { const endpoint = indexUid ? `/indexes/${indexUid}/stats` : '/stats'; const response = await apiClient.get(endpoint); return { content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }], }; } catch (error) { return createErrorResponse(error); } } - src/tools/system-tools.ts:74-76 (schema)Input schema validating the optional indexUid parameter using Zod.
{ indexUid: z.string().optional().describe('Unique identifier of the index (optional, if not provided stats for all indexes will be returned)'), }, - src/tools/system-tools.ts:71-88 (registration)Direct registration of the 'stats' tool on the MCP server within the registerSystemTools function, including name, description, schema, and handler.
server.tool( 'stats', 'Get statistics about all indexes or a specific index', { indexUid: z.string().optional().describe('Unique identifier of the index (optional, if not provided stats for all indexes will be returned)'), }, async ({ indexUid }) => { try { const endpoint = indexUid ? `/indexes/${indexUid}/stats` : '/stats'; const response = await apiClient.get(endpoint); return { content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }], }; } catch (error) { return createErrorResponse(error); } } ); - src/index.ts:69-69 (registration)Invocation of registerSystemTools on the main MCP server instance, which registers the 'stats' tool among other system tools.
registerSystemTools(server);