doc_list
Retrieve and browse documents from the Pickaxe studio with pagination controls to manage large collections efficiently.
Instructions
List all documents in the Pickaxe studio with pagination.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| studio | No | Studio name to use. Available: STAGING, MAIN, DEV, PRODUCTION. Default: PRODUCTION | |
| skip | No | Number of documents to skip. Default: 0 | |
| take | No | Number of documents to return. Default: 10 |
Implementation Reference
- src/index.ts:210-227 (registration)Registration of the 'doc_list' tool in the tools array, including name, description, and input schema definition.{ name: "doc_list", description: "List all documents in the Pickaxe studio with pagination.", inputSchema: { type: "object", properties: { studio: studioParam, skip: { type: "number", description: "Number of documents to skip. Default: 0", }, take: { type: "number", description: "Number of documents to return. Default: 10", }, }, }, },
- src/index.ts:213-226 (schema)Input schema for the 'doc_list' tool defining parameters for studio, skip, and take.inputSchema: { type: "object", properties: { studio: studioParam, skip: { type: "number", description: "Number of documents to skip. Default: 0", }, take: { type: "number", description: "Number of documents to return. Default: 10", }, }, },
- src/index.ts:507-512 (handler)Handler implementation for 'doc_list' tool that makes a GET request to Pickaxe API for listing documents with pagination and returns JSON result.case "doc_list": { const skip = args.skip ?? 0; const take = args.take ?? 10; const result = await pickaxeRequest(`/studio/document/list?skip=${skip}&take=${take}`, "GET", undefined, studio); return JSON.stringify(result, null, 2); }