doc_list
Retrieve and paginate all documents within a Pickaxe studio to manage knowledge bases and content 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:507-512 (handler)Handler function for the 'doc_list' tool. It extracts skip and take parameters from args, constructs the Pickaxe API endpoint `/studio/document/list`, calls pickaxeRequest to fetch the list of documents, and returns the JSON stringified 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); } - src/index.ts:213-226 (schema)Input schema definition for the 'doc_list' tool, specifying properties for studio (optional), skip, and take parameters with types and descriptions.
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:210-227 (registration)Registration of the 'doc_list' tool in the tools array, including name, description, and inputSchema. This array is returned by the ListToolsRequestHandler.
{ 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", }, }, }, },