Skip to content

fix: add core web vitals to performance_start_trace description #168

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
jackfranklin merged 3 commits into from
Sep 26, 2025
Merged

fix: add core web vitals to performance_start_trace description #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fc77293
fix: add core web vitals to performance_start_trace description
jackfranklin Sep 26, 2025
30bda0b
fix docs
jackfranklin Sep 26, 2025
bdb16d0
Merge branch 'main' into jackfr/addCWVToDescription
jackfranklin Sep 26, 2025
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
4 changes: 2 additions & 2 deletions docs/tool-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,12 +229,12 @@

### `performance_start_trace`

**Description:** Starts a performance trace recording on the selected page.
**Description:** Starts a performance trace recording on the selected page. This can be used to look for performance problems and insights to improve the performance of the page. It will also report Core Web Vital (CWV) scores for the page.

**Parameters:**

- **autoStop** (boolean) **(required)**: Determines if the trace recording should be automatically stopped.
- **reload** (boolean) **(required)**: Determines if, once tracing has started, the page should be automatically reloaded
- **reload** (boolean) **(required)**: Determines if, once tracing has started, the page should be automatically reloaded.

---

Expand Down
5 changes: 3 additions & 2 deletions src/tools/performance.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ import {defineTool} from './ToolDefinition.js';

export const startTrace = defineTool({
name: 'performance_start_trace',
description: 'Starts a performance trace recording on the selected page.',
description:
'Starts a performance trace recording on the selected page. This can be used to look for performance problems and insights to improve the performance of the page. It will also report Core Web Vital (CWV) scores for the page.',
annotations: {
category: ToolCategories.PERFORMANCE,
readOnlyHint: true,
Expand All @@ -31,7 +32,7 @@ export const startTrace = defineTool({
reload: z
.boolean()
.describe(
'Determines if, once tracing has started, the page should be automatically reloaded',
'Determines if, once tracing has started, the page should be automatically reloaded.',
),
autoStop: z
.boolean()
Expand Down
Loading