Skip to content

Commit 31354af

Browse files
committed
Clarify analyze_jfr tool expects stdout text, not binary file
The previous description said "from jfr summary <file>" without making clear the input is the command's stdout. Updated both the tool description and parameter hint to explicitly say this is the text output, not the binary .jfr file itself.
1 parent 71a8e63 commit 31354af

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -339,11 +339,11 @@ function formatBytes(bytes: number): string {
339339
// --- Tool: analyze_jfr ---
340340
server.tool(
341341
"analyze_jfr",
342-
"Parse JDK Flight Recorder summary output (from `jfr summary <file>`) and analyze event distribution, detect performance hotspots, GC pressure, lock contention, I/O patterns, and excessive allocations.",
342+
"Parse JDK Flight Recorder summary output and analyze event distribution, detect performance hotspots, GC pressure, lock contention, I/O patterns, and excessive allocations. Input must be the text printed to stdout by `jfr summary <recording.jfr>` — not the binary .jfr file itself.",
343343
{
344344
jfr_summary: z
345345
.string()
346-
.describe("The output text from `jfr summary <recording.jfr>`"),
346+
.describe("The stdout text from running `jfr summary <recording.jfr>` (a text table of event types, counts, and sizes — not the binary .jfr file)"),
347347
},
348348
async ({ jfr_summary }) => {
349349
try {

0 commit comments

Comments
 (0)