list_queue
View pending documentation URLs in the processing queue to monitor status, verify additions, or check backlog before running the queue.
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: executes the list_queue tool by reading queue.txt, parsing URLs, and returning the queue contents or 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:115-121 (schema)Tool schema definition for list_queue including name, description, and empty inputSchema as exposed in ListTools 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 instance for the 'list_queue' tool name in the handlers Map.this.handlers.set('list_queue', new ListQueueHandler(this.server, this.apiClient));
- src/tools/list-queue.ts:16-23 (schema)Alternative tool definition/schema in ListQueueTool class with inputSchema.name: 'list_queue', description: 'List all URLs currently in the documentation processing queue', inputSchema: { type: 'object', properties: {}, required: [], }, };
- src/tools/list-queue.ts:26-76 (handler)ListQueueTool execute method: duplicate implementation of queue listing logic (possibly client-side tool).async execute(_args: any): Promise<McpToolResponse> { 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, }; } }