Skip to content

feat(screenshot): add JPEG quality parameter support #184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
OrKoN merged 1 commit into from
Sep 29, 2025
Merged

feat(screenshot): add JPEG quality parameter support #184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/tool-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,7 @@ so returned values have to JSON-serializable.

- **format** (enum: "png", "jpeg") _(optional)_: Type of format to save the screenshot as. Default is "png"
- **fullPage** (boolean) _(optional)_: If set to true takes a screenshot of the full page instead of the currently visible viewport. Incompatible with uid.
- **quality** (number) _(optional)_: Compression quality for JPEG format (0-100). Higher values mean better quality but larger file sizes. Ignored for PNG format.
- **uid** (string) _(optional)_: The uid of an element on the page from the page content snapshot. If omitted takes a pages screenshot.

---
Expand Down
10 changes: 10 additions & 0 deletions src/tools/screenshot.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,14 @@ export const screenshot = defineTool({
.enum(['png', 'jpeg'])
.default('png')
.describe('Type of format to save the screenshot as. Default is "png"'),
quality: z
.number()
.min(0)
.max(100)
.optional()
.describe(
'Compression quality for JPEG format (0-100). Higher values mean better quality but larger file sizes. Ignored for PNG format.',
),
uid: z
.string()
.optional()
Expand Down Expand Up @@ -50,6 +58,8 @@ export const screenshot = defineTool({
const screenshot = await pageOrHandle.screenshot({
type: request.params.format,
fullPage: request.params.fullPage,
quality: request.params.quality,
optimizeForSpeed: true, // Bonus: optimize encoding for speed
});

if (request.params.uid) {
Expand Down
Loading