list_records
Fetch and display records from PocketBase databases using the MCP protocol. This tool simplifies data retrieval and supports efficient database interactions within the pocketbase-mcp-server ecosystem.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/server.ts:496-522 (handler)Primary registration and handler for the 'list_records' tool in the main PocketBase MCP server. Defines input schema using Zod and implements the PocketBase getList query.server.tool( 'list_records', { collection: z.string().describe('Collection name'), filter: z.string().optional().describe('Filter query'), sort: z.string().optional().describe('Sort field and direction'), page: z.number().optional().describe('Page number'), perPage: z.number().optional().describe('Items per page') }, async ({ collection, filter, sort, page = 1, perPage = 50 }) => { try { const options: any = {}; if (filter) options.filter = filter; if (sort) options.sort = sort; const result = await this.pb.collection(collection).getList(page, perPage, options); return { content: [{ type: 'text', text: JSON.stringify(result, null, 2) }] }; } catch (error: any) { return { content: [{ type: 'text', text: `Failed to list records: ${error.message}` }], isError: true }; } } );
- src/agent-worker-compatible.ts:365-391 (handler)Handler function listRecords in the worker-compatible PocketBase MCP agent, called from the tool dispatch switch statement.private async listRecords(collection: string, options: any = {}) { if (!this.pb) { throw new Error('PocketBase not configured'); } try { const records = await this.pb.collection(collection).getList( options.page || 1, options.perPage || 30, { filter: options.filter, sort: options.sort } ); return { content: [ { type: "text", text: JSON.stringify(records, null, 2) } ] }; } catch (error: any) { throw new Error(`Failed to list records: ${error.message}`); } }
- Input schema definition for the list_records tool in the ListTools response of the worker-compatible agent.name: "list_records", description: "List records from a collection", inputSchema: { type: "object", properties: { collection: { type: "string", description: "Collection name" }, page: { type: "number", description: "Page number (default: 1)" }, perPage: { type: "number", description: "Records per page (default: 30)" }, filter: { type: "string", description: "Filter expression" }, sort: { type: "string", description: "Sort expression" } }, required: ["collection"] } },
- src/agent-cloudflare.ts:387-416 (handler)Registration and inline handler for list_records tool in the Cloudflare Agent implementation of PocketBase MCP server.this.server.tool( "list_records", "List records from a collection with optional filtering and pagination", { collection: z.string().describe('Collection name'), page: z.number().optional().default(1).describe('Page number'), perPage: z.number().optional().default(30).describe('Records per page'), sort: z.string().optional().describe('Sort order (e.g., "-created")'), filter: z.string().optional().describe('Filter expression'), expand: z.string().optional().describe('Relations to expand') }, async ({ collection, page, perPage, sort, filter, expand }) => { if (!this.pb) { throw new Error('PocketBase not initialized'); } const records = await this.pb.collection(collection).getList(page, perPage, { sort, filter, expand }); return { content: [{ type: 'text', text: JSON.stringify(records, null, 2) }] }; } );