list_queue
Monitor pending documentation URLs in the processing queue to verify additions and check backlog status before execution.
Instructions
List all URLs currently waiting in the documentation processing queue. Shows pending documentation sources that will be processed when run_queue is called. Use this to monitor queue status, verify URLs were added correctly, or check processing backlog. Returns URLs in the order they will be processed.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/handlers/list-queue.ts:13-69 (handler)ListQueueHandler class that implements the execution logic for the 'list_queue' tool, reading from queue.txt and returning the list of queued URLs or appropriate status messages.
export class ListQueueHandler extends BaseHandler { constructor(server: Server, apiClient: ApiClient) { super(server, apiClient); } async handle(_args: any) { try { // Check if queue file exists try { await fs.access(QUEUE_FILE); } catch { return { content: [ { type: 'text', text: 'Queue is empty (queue file does not exist)', }, ], }; } // Read queue file const content = await fs.readFile(QUEUE_FILE, 'utf-8'); const urls = content.split('\n').filter(url => url.trim() !== ''); if (urls.length === 0) { return { content: [ { type: 'text', text: 'Queue is empty', }, ], }; } return { content: [ { type: 'text', text: `Queue contains ${urls.length} URLs:\n${urls.join('\n')}`, }, ], }; } catch (error) { return { content: [ { type: 'text', text: `Failed to read queue: ${error}`, }, ], isError: true, }; } } } - src/handler-registry.ts:114-121 (schema)Input schema and metadata definition for the 'list_queue' tool, provided in the ListToolsRequest response.
{ name: 'list_queue', description: 'List all URLs currently waiting in the documentation processing queue. Shows pending documentation sources that will be processed when run_queue is called. Use this to monitor queue status, verify URLs were added correctly, or check processing backlog. Returns URLs in the order they will be processed.', inputSchema: { type: 'object', properties: {}, }, } as ToolDefinition, - src/handler-registry.ts:42-42 (registration)Registers the ListQueueHandler for the 'list_queue' tool name in the handlers Map used by CallToolRequest.
this.handlers.set('list_queue', new ListQueueHandler(this.server, this.apiClient)); - src/tools/list-queue.ts:14-24 (schema)Alternative tool definition (schema) for 'list_queue' in the tools directory, possibly for client-side or other usage.
get definition(): ToolDefinition { return { name: 'list_queue', description: 'List all URLs currently in the documentation processing queue', inputSchema: { type: 'object', properties: {}, required: [], }, }; } - src/handler-registry.ts:16-16 (registration)Import of ListQueueHandler class used for registration.
ListQueueHandler,