Skip to content

Commit 1c9e5e8

Browse files
style updates and merging some troubleshooting guidance
1 parent 5e3f725 commit 1c9e5e8

5 files changed

Lines changed: 36 additions & 40 deletions

File tree

content/learning-paths/servers-and-cloud-computing/performix-agentic-dynamic-insights-codex/configure_mcp_codex.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ You need to complete only one method. The MCP server is a local standard input a
2121
Configure the server on the host where Codex runs. In a local Visual Studio Code (VS Code) session, this is your development computer. In a remote development session, confirm which host runs the Codex extension and which Arm Performix data directory it uses.
2222
{{% /notice %}}
2323

24-
## Configure the server in the Codex extension
24+
## Configure the MCP server in the Codex extension
2525

26-
To add the server in VS Code:
26+
To add the MCP server in VS Code:
2727

28-
1. Open the Codex sidebar and select the gear icon.
28+
1. Open the Codex sidebar and select the **gear icon**.
2929
2. Select **MCP servers**, then select **Add server**.
30-
3. Enter `arm-performix` for the server name.
30+
3. For **Server name**, enter `arm-performix`.
3131
4. Select **STDIO** as the transport.
32-
5. Enter the full path to the Arm Performix `apx` executable in the command field.
32+
5. For **Command**, enter the full path to the Arm Performix `apx` executable.
3333

3434
On macOS:
3535

@@ -55,7 +55,7 @@ To add the server in VS Code:
5555
C:\Users\<username>\AppData\Local\Programs\Arm Performix\assets\apx\apx.exe
5656
```
5757
58-
6. Add one argument:
58+
6. Add the following arguments:
5959
6060
```text
6161
mcp
@@ -130,7 +130,7 @@ Record the run ID you want to analyze. A run name can be changed and might not b
130130

131131
## Troubleshoot the MCP connection
132132

133-
Use the following checks to troubleshoot issues with MCP connection:
133+
Use the following checks to diagnore MCP connection issues:
134134

135135
### The Arm Performix MCP server isn't listed
136136

@@ -198,4 +198,4 @@ If the CLI also returns no run, create or import a run. If the CLI returns the r
198198

199199
You've now configured and tested the MCP connection.
200200

201-
Next, you'll create a Code Hotspots run if no supported run is available. If you have an available supported run, skip to [Generate Arm Performix AI insights for a Code Hotspots run](/learning-paths/servers-and-cloud-computing/performix-agentic-dynamic-insights-codex/generate_ai_insights/).
201+
Next, you'll create a Code Hotspots run if no supported run is available. If you already. have a supported run, skip to [Generate Arm Performix AI insights for a Code Hotspots run](/learning-paths/servers-and-cloud-computing/performix-agentic-dynamic-insights-codex/generate_ai_insights/).

content/learning-paths/servers-and-cloud-computing/performix-agentic-dynamic-insights-codex/create_a_code_hotspots_run.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Choose the correct target, then ask Codex to run Code Hotspots. Keep collection
3434
Use Arm Performix to run the Code Hotspots recipe on target "<target-name>" with workload "<command>". Before starting, repeat the target and workload and ask me to confirm them. When the run completes, return its run ID and collection status.
3535
```
3636

37-
Replace:
37+
Replace the following placeholders:
3838

3939
- `<target-name>` with the Performix target name returned by Codex
4040
- `<command>` with the command that starts your workload on the target
@@ -45,9 +45,9 @@ For example:
4545
Use Arm Performix to run the Code Hotspots recipe on target "graviton-dev" with workload "/opt/myapp/bin/my_app --input /data/input.dat". Before starting, repeat the target and workload and ask me to confirm them. When the run completes, return its run ID and collection status.
4646
```
4747

48-
After you confirm, Codex uses the MCP server to start the recipe. Review any permission request before allowing the assistant to run a command on the target.
48+
After you confirm the target, Codex uses the MCP server to start the recipe. Review any permission request before allowing the assistant to run a command on the target.
4949

50-
## Create a run with the Performix CLI
50+
## Create a run with the Arm Performix CLI
5151

5252
If you prefer to control collection from a terminal, first check that the recipe dependencies and workload are ready:
5353

@@ -96,6 +96,6 @@ apx target test --target <target-name>
9696

9797
## What you've accomplished and what's next
9898

99-
You've now got the stable identifier Codex needs to analyze the intended profile.
99+
You now have the stable identifier Codex needs to analyze the intended profile.
100100

101101
Next, you'll generate AI insights from a Code Hotspots run.

content/learning-paths/servers-and-cloud-computing/performix-agentic-dynamic-insights-codex/generate_ai_insights.md

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ title: Generate Arm Performix AI insights for a Code Hotspots run
33

44
weight: 5
55

6-
description: Ask Codex for an Arm Performix AI Insight tied to a specific run and assess whether the response is supported by profile evidence.
6+
description: Ask Codex for an Arm Performix AI insight tied to a specific run and assess whether the response is supported by profile evidence.
77

88
layout: learningpathall
99
---
1010
## Select the exact run
1111

12-
Use a run ID whenever possible. It prevents Codex from selecting a similarly named run or a more recent run from a different workload.
12+
Use a run ID whenever possible. A run ID prevents Codex from selecting a similarly named run or a more recent run from a different workload.
1313

1414
If you don't have the ID, ask Codex to list supported runs:
1515

@@ -35,11 +35,21 @@ Use Arm Performix to explain why function "<function-name>" is hot in run ID "<r
3535

3636
Focused prompts usually produce more useful results than broad application-wide prompts.
3737

38-
## Evaluate the response
38+
## Evaluate and refine AI insights
3939

40-
A useful response identifies the run it analyzed and connects its conclusion to measured evidence, such as sample percentages, call paths, source attribution, or disassembly. It should also state when the available data can't establish a root cause.
40+
A useful AI insight identifies the run it analyzed and connects its conclusion to measured evidence, such as sample percentages, call paths, source attribution, or disassembly. It should also state when the available data can't establish a root cause.
4141

42-
Ask follow-up questions when a recommendation isn't traceable:
42+
If a recommendation isn't traceable, ask for one finding and its evidence:
43+
44+
```text
45+
Focus on the highest-impact finding in run ID "<run-id>". Cite the measured evidence, distinguish hypotheses from observations, and identify the next Performix view or recipe to inspect.
46+
```
47+
You can ask a similar question for a known hotspot:
48+
49+
```text
50+
For function "<function-name>" in run ID "<run-id>", summarize what Code Hotspots proves, what it doesn't prove, and which additional evidence is needed to identify the root cause.
51+
```
52+
The following are some other questions that you can ask:
4353

4454
```text
4555
Which measured evidence in this Performix run supports that recommendation?
@@ -51,21 +61,7 @@ Which additional Performix recipe or view would distinguish between those explan
5161
What is the first optimization I should try, and why?
5262
```
5363

54-
## Improve a generic AI Insight
55-
56-
Ask for one finding and its evidence:
57-
58-
```text
59-
Focus on the highest-impact finding in run ID "<run-id>". Cite the measured evidence, distinguish hypotheses from observations, and identify the next Performix view or recipe to inspect.
60-
```
61-
62-
For a known hotspot:
63-
64-
```text
65-
For function "<function-name>" in run ID "<run-id>", summarize what Code Hotspots proves, what it doesn't prove, and which additional evidence is needed to identify the root cause.
66-
```
67-
68-
If the response remains generic, confirm that the run has enough samples, symbols, source mapping, and disassembly. Code Hotspots locates sampled CPU time; use a more specific Performix recipe when you need evidence about microarchitecture, instruction mix, or memory access.
64+
Code Hotspots locates sampled CPU time. If you need evidence about microarchitecture, instruction mix, or memory access, use a more specific Performix recipe.
6965

7066
## Iterate and measure
7167

@@ -82,6 +78,6 @@ Codex can help with more of this loop if your environment exposes build, deploym
8278

8379
## What you've accomplished and what's next
8480

85-
You've now generated an evidence-based hypothesis.
81+
You've now generated an AI insight and reviewed its supporting evidence.
8682

8783
Next, you'll open the same run in Arm Performix to inspect the underlying profile views.

content/learning-paths/servers-and-cloud-computing/performix-agentic-dynamic-insights-codex/open-in-performix.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Open the run in Arm Performix for deeper inspection
33

44
weight: 6
55

6-
description: Validate an AI Insight by inspecting flame graphs, functions, call paths, source, and disassembly from the same Arm Performix run.
6+
description: Validate an AI insight by inspecting flame graphs, functions, call paths, source, and disassembly from the same Arm Performix run.
77

88
layout: learningpathall
99
---

content/learning-paths/servers-and-cloud-computing/performix-agentic-dynamic-insights-codex/overview.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,25 @@ layout: learningpathall
99
---
1010
## Arm Performix local MCP server
1111

12-
[Arm Performix](https://developer.arm.com/servers-and-cloud-computing/arm-performix) is a performance toolkit designed to help developers identify bottlenecks and validate improvements on Arm-based systems. It simplifies the process of turning low-level performance data into actionable insights through guided analysis paths called recipes. These recipes help you answer common performance questions and move quickly from observation to root cause.
12+
[Arm Performix](https://developer.arm.com/servers-and-cloud-computing/arm-performix) is a performance toolkit designed to help developers identify bottlenecks and validate improvements on Arm-based systems. The toolkit turns low-level performance data into actionable insights through guided analysis paths called recipes. You can use these recipes to answer common performance questions and move quickly from observation to root cause.
1313

1414
Arm Performix includes a local Model Context Protocol (MCP) server. MCP is a standard way for an AI assistant to discover and call tools. The server lets Codex query Performix recipes, targets, and runs from Visual Studio Code instead of relying on source-code analysis alone.
1515

16-
You'll connect the server to Codex, select or create a Code Hotspots run, and ask for an AI Insight. The response should connect each recommendation to evidence from the selected run.
16+
You'll connect the server to Codex, select or create a Code Hotspots run, and ask for an AI insight. The response should connect each recommendation to evidence from the selected run.
1717

1818
{{% notice Important %}}
1919
The MCP server runs on the same host as Codex. It can make profile data, symbols, source excerpts, disassembly excerpts, and performance metrics available to the assistant. Before you continue, confirm that this use complies with your organization's data-handling policy.
2020
{{% /notice %}}
2121

2222
Use AI-generated responses to support performance investigation. Validate important findings by reviewing the relevant data in Arm Performix and by rerunning the workload after making changes.
2323

24-
## Arm Performix insights workflow
24+
## How AI-assisted Arm Performix insights are generated
2525

26-
Arm Performix stores profiling runs, target information, and rendered analysis data. The local MCP server exposes select Performix capabilities as tools that an MCP-compatible assistant can call.
26+
Arm Performix stores profiling runs, target information, and rendered analysis data. The local MCP server exposes specific Performix capabilities as tools that an MCP-compatible assistant can call.
2727

2828
When you ask for insights, the flow is:
2929

30-
1. You ask an AI Assisant, in this case, Codex in VS Code for an Arm Performix insight.
30+
1. You ask an AI assistant — in this case, Codex in VS Code for an Arm Performix insight.
3131
2. Codex calls the Arm Performix MCP server.
3232
3. Arm Performix gathers relevant run data and profile evidence.
3333
4. Codex uses that evidence to identify likely bottlenecks, explain why they matter, and suggest the next investigation step.
@@ -36,6 +36,6 @@ The available evidence depends on how the run was collected. Debug symbols and s
3636

3737
## What you've learned and what's next
3838

39-
You've learned about Arm Performix's local MCP server and the workflow that's executed when you ask for insights using Codex.
39+
You've learned about Arm Performix's local MCP server and how AI-assisted insights are generated.
4040

4141
Next, you'll configure the local MCP server and verify that Codex can use its tools.

0 commit comments

Comments
 (0)