wait_job_completion
Monitor PDF processing jobs for completion by checking status at specified intervals until finished or timeout occurs.
Instructions
Wait for a job to complete
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| job_id | Yes | The ID of the job to get the status of | |
| interval | No | The interval to check the status of the job (seconds) | |
| timeout | No | The timeout to wait for the job to complete (seconds) | |
| api_key | No | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
Implementation Reference
- pdfco/mcp/tools/apis/job.py:57-107 (handler)The primary handler function for the 'wait_job_completion' tool. Decorated with @mcp.tool() to register it with the MCP server. Polls the job status at specified intervals until completion, failure, or timeout, aggregating credits and providing tips.@mcp.tool() async def wait_job_completion( job_id: str = Field(description="The ID of the job to get the status of"), interval: int = Field( description="The interval to check the status of the job (seconds)", default=1 ), timeout: int = Field( description="The timeout to wait for the job to complete (seconds)", default=300 ), api_key: str = Field( description="PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional)", default="", ), ) -> BaseResponse: """ Wait for a job to complete """ start_time = time.time() job_check_count = 0 credits_used = 0 credits_remaining = 0 while True: response = await _get_job_status(job_id, api_key=api_key) job_check_count += 1 credits_used += response.credits_used or 0 credits_remaining = response.credits_remaining or 0 if response.status == "success": return BaseResponse( status="success", content=response.content, credits_used=credits_used, credits_remaining=credits_remaining, tips=f"Job check count: {job_check_count}", ) elif response.status == "failed": return BaseResponse( status="error", content=response.content, credits_used=credits_used, credits_remaining=credits_remaining, ) await asyncio.sleep(interval) if time.time() - start_time > timeout: return BaseResponse( status="error", content="Job timed out", credits_used=credits_used, credits_remaining=credits_remaining, tips=f"Job check count: {job_check_count}", )
- pdfco/mcp/tools/apis/job.py:10-35 (helper)Supporting helper function _get_job_status that queries the PDF.co API for job status. Used internally by wait_job_completion (and get_job_check) without MCP decoration.async def _get_job_status(job_id: str, api_key: str = "") -> BaseResponse: """ Internal helper function to check job status without MCP tool decoration """ try: async with PDFCoClient(api_key=api_key) as client: response = await client.post( "/v1/job/check", json={ "jobId": job_id, }, ) json_data = response.json() return BaseResponse( status=json_data["status"], content=json_data, credits_used=json_data.get("credits"), credits_remaining=json_data.get("remainingCredits"), tips="You can download the result if status is success", ) except Exception as e: return BaseResponse( status="error", content=str(e), )
- pdfco/mcp/tools/apis/job.py:58-69 (schema)Input schema defined via Pydantic Field descriptions in the function signature, which MCP uses for tool input validation. Returns BaseResponse model.async def wait_job_completion( job_id: str = Field(description="The ID of the job to get the status of"), interval: int = Field( description="The interval to check the status of the job (seconds)", default=1 ), timeout: int = Field( description="The timeout to wait for the job to complete (seconds)", default=300 ), api_key: str = Field( description="PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional)", default="", ),