octoperf-export-bench-report-pdf

OctoPerf — Export a benchReport as PDF

OctoPerf prints reports server-side with a headless Playwright render. The work is async: the MCP tool submits the task, the LLM polls until it settles, then pulls the PDF off the report's first bench result.

When this applies

The user wants a static, shareable artefact of an existing bench report — a stakeholder review, an attachment to a ticket, an offline archive. If the user just wants to read metrics, use the report value tools (get_report_summary_values, get_report_table_values, …) instead. The PDF is for hand-off, not analysis.

Prerequisites

• A benchReportId (find it with list_bench_reports_by_project).
• The underlying bench run is terminal (FINISHED / ABORTED / ERROR). Printing a report whose run is still RUNNING is allowed but the metrics inside the PDF will be partial.
• The report's data is up to date. export_bench_report_pdf refuses otherwise, rather than rendering a document of empty report items: run get_report_data_status, then update_report_data, and print once the update tasks reach SUCCESS. See octoperf-bench-reports.

The three-step chain

1. Submit the print task

export_bench_report_pdf(benchReportId)
# returns { benchReportId, taskId }

The tool returns immediately with a taskId. Defaults are sensible (portrait A4, empty cover page, en-US locale, UTC timezone) — no extra parameters needed for the common case.

2. Poll until the task settles

get_task_result(taskId)
# returns { taskId, status, message }

status cycles through PENDING while Playwright is rendering. Stop on:

• SUCCESS → the PDF has been uploaded to the report's first bench result. Continue with step 3.
• FAILED → message carries the backend stack trace. Surface it to the user verbatim and stop.

Typical render time is 10–30 seconds; expect more on large reports (many report items, long trend series). For the polling cadence and the sleep-between-polls discipline, read octoperf-async-polling — the PDF task is in its table (3s between polls, ~5 min outer deadline).