MTA-6607 Download and configure custom analyzer RPC binary

[Pkylas007]

JIRA

• MTA-6607 [Doc] Document Analyzer RPC download and fallback configuration

Version

• 8.1.0

Preview

• 2. Installing the MTA extension for Visual Studio Code
• Configuring and using the MTA analyzer RPC binary in your system

Summary by CodeRabbit

• Documentation
  • Added a new guide explaining how to install and configure the analyzer RPC binary for the VS Code extension in restricted networks, including prerequisites (JDK options, memory, macOS limits), download sources, and two ways to specify the analyzer path.
  • Clarified and restructured the VS Code extension installation docs for readability.
  • Integrated the new guide into the main VS Code extension handbook for easier discovery.

[coderabbitai]

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

• @coderabbitai resume to resume automatic reviews.
• @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

• ▶️ Resume reviews
• 🔍 Trigger review

📝 Walkthrough

Walkthrough

Adds a new VSCode documentation page that explains installing and configuring the analyzer RPC binary locally, updates the VSCode extension installation doc wording, and inserts the new topic into the VS Code extension guide includes.

Changes

Cohort / File(s)	Summary
New Analyzer Installation Guide docs/topics/vscode/proc_installing-analyzer-binary-locally.adoc	Adds a new topic covering prerequisites (JDK options, RAM, macOS maxproc), download source, and two methods to configure the analyzer RPC binary path in the extension, plus reload/start steps.
VSCode Extension Install Doc docs/topics/vscode/proc_installing-vscode-extension.adoc	Minor wording/formatting changes in the abstract and overview text.
VS Code Extension Guide Includes docs/vs-code-extension-guide/master.adoc	Inserts an include for the new analyzer-installation topic into the VS Code extension guide before the LightSpeed IDE settings section.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 I hopped through pages, tidy and quick,
Dropped a guide where the analyzer ticks,
JDK and RAM in a neat little row,
Point the path, reload — let VSCode go! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the primary change: adding documentation for downloading and configuring a custom analyzer RPC binary, which is the core purpose of the three modified documentation files.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch mta-6607-analyzer-rpc-download-fallback

📝 Coding Plan

• Generate coding plan for human review comments

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 3

🤖 Fix all issues with AI agents

In `@docs/topics/vscode/proc_installing-analyzer-binary-locally.adoc`:
- Line 31: The shortcut string "Cmd+Sihft+P" is misspelled; update the text in
the docs to replace "Cmd+Sihft+P" with the correct "Cmd+Shift+P" (keep the
existing "Ctrl+Shift+P" example intact) so the Command Palette shortcut reads
"Ctrl+Shift+P or Cmd+Shift+P".
- Line 30: Replace the imprecise sentence "Enter the analyzer RPC binary in the
`Analyzer Path`" with a clearer instruction that explicitly asks for a
filesystem path, e.g. "Enter the path to the analyzer RPC binary in the
`Analyzer Path` field" (keep reference to the `Analyzer Path` label and ensure
wording conveys that a path, not the binary contents, is expected).
- Around line 28-34: The instructions for configuring the analyzer path are
ambiguous; update the procedure under the "Configure the path to the analyzer
RPC binary..." step to explicitly present two configuration methods (Method A:
"Click `Extensions > MTA Extension for VSCode > Settings`" and Method B: "Enter
the analyzer RPC binary in the `Analyzer Path`") as separate numbered/lettered
options, then add a clearly marked "After configuring the path" section
containing the common follow-up steps ("Open the Command Palette by typing
`Ctrl+Shift+P` or `Cmd+Shift+P`", "Reload the Visual Studio Code window by
typing `Developer: Reload Window`", "Type `MTA: Open Analysis View`", and "Click
*Start*"). Ensure the wording around the two methods makes it explicit that
steps after that section apply regardless of which method was chosen.

🧹 Nitpick comments (1)

docs/topics/vscode/proc_installing-vscode-extension.adoc (1)

6-8: Consider the formatting purpose of the blank line.

The abstract paragraph has been reformatted with a blank line separating the two sentences. While this creates visual separation in the source, verify this produces the desired rendering in the final documentation output. In AsciiDoc, a blank line within a paragraph block can sometimes create unexpected spacing or even split the paragraph.

[coderabbitai]

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

docs/topics/vscode/proc_installing-vscode-extension.adoc (1)

24-24: ⚠️ Potential issue | 🟡 Minor

Inconsistent terminology: align product name with line 6.

Line 6 uses "Visual Studio Code plugin" while this line uses "Visual Studio (VS) Code plugin". For consistency throughout the document, consider using the same terminology.

📝 Proposed fix for consistency

-* Install the {ProductShortName} {ProductVersion} Visual Studio (VS) Code plugin from the link:https://marketplace.visualstudio.com/search?term=migration%20toolkit&target=VSCode&category=All%20categories&sortBy=Relevance[VS Code marketplace]. 
+* Install the {ProductShortName} {ProductVersion} Visual Studio Code plugin from the link:https://marketplace.visualstudio.com/search?term=migration%20toolkit&target=VSCode&category=All%20categories&sortBy=Relevance[VS Code marketplace]. 

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@docs/topics/vscode/proc_installing-analyzer-binary-locally.adoc`:
- Line 36: Update the command label text so it matches VS Code's exact command:
change the string "Developer:Reload Window" to "Developer: Reload Window" in the
docs (look for the line containing the Command Palette instruction in
docs/topics/vscode/proc_installing-analyzer-binary-locally.adoc).

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@docs/topics/vscode/proc_installing-analyzer-binary-locally.adoc`:
- Line 29: Replace the missing space in the Developer command string: locate the
text "Developer:Reload Window" and change it to "Developer: Reload Window" so it
follows the VS Code "Category: Title" convention; ensure the
file/docs/topics/vscode/proc_installing-analyzer-binary-locally.adoc entry that
currently shows Developer:Reload Window is updated to Developer: Reload Window.

🧹 Nitpick comments (1)

docs/topics/vscode/proc_installing-analyzer-binary-locally.adoc (1)

6-6: Consider more precise wording for the extension description.

"consists of an analyzer RPC binary" implies the extension is composed solely of the binary. More accurate phrasing would be "includes" or "uses" an analyzer RPC binary, since the extension comprises additional components beyond just the binary.

📝 Suggested wording improvement

-The {ProductFullName} Visual Studio Code extension consists of an analyzer RPC binary that runs an analysis for `Java`, `Go`, `Python`, `Node.js` and `C#` or `.NET` applications. 
+The {ProductFullName} Visual Studio Code extension includes an analyzer RPC binary that runs an analysis for `Java`, `Go`, `Python`, `Node.js` and `C#` or `.NET` applications. 

[Pkylas007]

@djzager I've written a procedure to download analyzer RPC binary offline and configure it in the MTA VS Code IDE.

Could you take a look at it and let me know if any information is missing or needs modification? Thanks very much!

Note: Ramon mentioned OpenVSX and Microsoft Visual Studio marketplace downloads in the JIRA attached to this PR. Please confirm what information I need to add about MS VS Code marketplace/OpenVSX registry.

[djzager]

The actual content of the procedure looks good to me. My only concern is with the abstract and it not being correct for the 8.1.0 architecture. I tried to provide the relevant context for you as I failed several time to briefly explain it in a way suitable for this document.

[mpershina]

Some minor changes needed, otherwise, LGTM!

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (2)

docs/topics/vscode/proc_installing-analyzer-binary-locally.adoc (2)

10-10: Simplify the phrasing for better readability.

"cannot access the link to download the analyzer RPC binary" is verbose and awkward. Consider simplifying to "cannot download" or "does not have internet access to download."

📝 Suggested rewording

-In a restricted network environment where the {ProductShortName} extension cannot access the link to download the analyzer RPC binary, you can download the binary in your system and configure its path in the Visual Studio Code extension.
+In a restricted network environment where the {ProductShortName} extension cannot download the analyzer RPC binary, you can download the binary to your system and configure its path in the Visual Studio Code extension.

Note: This also changes "in your system" to "to your system" for consistency with line 26.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/topics/vscode/proc_installing-analyzer-binary-locally.adoc` at line 10,
Replace the verbose phrase "cannot access the link to download the analyzer RPC
binary" with a simpler alternative like "cannot download the analyzer RPC
binary" or "does not have internet access to download the analyzer RPC binary",
and change "download the binary in your system" to "download the binary to your
system" to match the wording used elsewhere; update the sentence in the docs
topic text accordingly.

---

6-6: Improve the wording for clarity.

"consists of an analyzer RPC binary" is imprecise. The extension doesn't consist of the binary; rather, it uses or includes the binary.

📝 Suggested rewording

-The {ProductFullName} Visual Studio Code extension consists of an analyzer RPC binary that runs an analysis for `Java`, `Go`, `Python`, `Node.js` and `C#` or `.NET` applications. 
+The {ProductFullName} Visual Studio Code extension uses an analyzer RPC binary to run an analysis for `Java`, `Go`, `Python`, `Node.js`, and `C#` or `.NET` applications.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/topics/vscode/proc_installing-analyzer-binary-locally.adoc` at line 6,
Replace the imprecise phrase "consists of an analyzer RPC binary" in the
sentence that starts with "{ProductFullName} Visual Studio Code extension" with
clearer wording such as "includes" or "uses" (e.g., "{ProductFullName} Visual
Studio Code extension includes an analyzer RPC binary that runs analysis for
Java, Go, Python, Node.js, and C#/.NET applications") so the sentence correctly
states the extension ships/uses the binary and normalize the language list to
"C#/.NET"; update the sentence containing "{ProductFullName} Visual Studio Code
extension" and the phrase "consists of an analyzer RPC binary".

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/topics/vscode/proc_installing-vscode-extension.adoc`:
- Line 8: Change the plural form in the sentence containing "all the supported
language-specific extension" to "extensions"; locate the sentence that currently
reads "You can download the {ProductShortName} plugin version 8.1.0 as an
extension pack that bundles the Core extension along with all the supported
language-specific extension." and replace the final word with "extensions" so it
reads "...along with all the supported language-specific extensions."

---

Nitpick comments:
In `@docs/topics/vscode/proc_installing-analyzer-binary-locally.adoc`:
- Line 10: Replace the verbose phrase "cannot access the link to download the
analyzer RPC binary" with a simpler alternative like "cannot download the
analyzer RPC binary" or "does not have internet access to download the analyzer
RPC binary", and change "download the binary in your system" to "download the
binary to your system" to match the wording used elsewhere; update the sentence
in the docs topic text accordingly.
- Line 6: Replace the imprecise phrase "consists of an analyzer RPC binary" in
the sentence that starts with "{ProductFullName} Visual Studio Code extension"
with clearer wording such as "includes" or "uses" (e.g., "{ProductFullName}
Visual Studio Code extension includes an analyzer RPC binary that runs analysis
for Java, Go, Python, Node.js, and C#/.NET applications") so the sentence
correctly states the extension ships/uses the binary and normalize the language
list to "C#/.NET"; update the sentence containing "{ProductFullName} Visual
Studio Code extension" and the phrase "consists of an analyzer RPC binary".

[Pkylas007]

Some minor changes needed, otherwise, LGTM!

Thanks very much! 😄

[Pkylas007]

@djzager Could you review the MTA VS Code extension description, please?

[djzager]

Looks good.

[djzager]

Ack from me.

[djzager]

Looks good.

[Pkylas007]

@dymurray Can you please review the developer preview note for the extensions? Many thanks!

[rromannissen]

LGTM!

[Pkylas007]

LGTM!

Thanks much!