You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+7-3
Original file line number
Diff line number
Diff line change
@@ -18,21 +18,25 @@ We are trying to keep GitHub issues for bug reports and feature requests. Stack
18
18
19
19
Alternatively, if you are using IntelliJ IDEA to develop Nx Console, it can take care of the java installation for you.
20
20
21
-
## Running the Extension locally
21
+
## Development
22
22
23
-
### VSCode
23
+
### Running the Extension locally
24
+
25
+
#### VSCode
24
26
25
27
In order to start Nx Console in development mode, the repo needs to be built. Running `yarn watch` via the terminal or using the command prompt to execute `Tasks: Run Task -> Build and watch Nx Console` will automatically generate build artifacts whenever the code changes. </br>
26
28
Use the `F5` key or the debug menu option `Launch Client + Server` to start the Extension Development Host.
27
29
28
30
> :warning: Even though builds will be generated automatically, the Extension Development Host needs to be restarted in order to apply a new set of changes.
29
31
30
-
### IntelliJ
32
+
####IntelliJ
31
33
32
34
The `runIde` gradle task takes care of building Nx Console and starting a development instance of IntelliJ. Run the `nx-console [runIde]` gradle config in your IDE or use `nx run intellij:runIde` (which executes `./gradlew :apps:intellij:runIde` under the hood).
33
35
34
36
When debugging the JCEF-based generate UI, you can attach an instance of Chrome Devtools to the browser. To enable this, make sure to [set the corresponding registry key](https://plugins.jetbrains.com/docs/intellij/jcef.html#debugging).
Copy file name to clipboardexpand all lines: README.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -56,7 +56,7 @@ Nx Console enhances your editors AI features by providing relevant context to th
56
56
57
57
In VSCode, access the enhancements via the `@nx` chat participant. Learn more [in our blog post](https://nx.dev/blog/nx-just-made-your-llm-smarter) or the [Nx docs](https://nx.dev/features/enhance-AI#vs-code-with-github-copilot)
58
58
59
-
In Cursor or anywhere else, use the Nx MCP server. Learn more [in our Cursor blog](https://nx.dev/blog/nx-made-cursor-smarter) post or [the Nx docs](https://nx.dev/features/enhance-AI#cursor)
59
+
In Cursor or anywhere else, use the [Nx MCP server](./apps/nx-mcp/README.md). Learn more [in our Cursor blog](https://nx.dev/blog/nx-made-cursor-smarter) post or [the Nx docs](https://nx.dev/features/enhance-AI#cursor)
Copy file name to clipboardexpand all lines: apps/nx-mcp/README.md
+20-2
Original file line number
Diff line number
Diff line change
@@ -6,9 +6,15 @@ A [Model Context Protocol](https://modelcontextprotocol.io/introduction) server
6
6
7
7
## Overview
8
8
9
-
The Nx MCP Server provides structured context about your Nx workspace to AI assistant models, enabling them to better understand and interact with your Nx projects. It serves as a bridge between AI models and your Nx workspace and documentation.
9
+
The Nx MCP server gives LLMs deep access to your monorepo’s structure: project relationships, file mappings, runnable tasks, ownership info, tech stacks, Nx generators, and even Nx documentation. With this context, LLMs can generate code tailored to your stack, understand the impact of a change, and apply modifications across connected files with precision. This is possible because Nx already understands the higher-level architecture of your workspace, and monorepos bring all relevant projects into one place.
10
10
11
-
## Installation
11
+
Read more in [our blog post](https://nx.dev/blog/nx-made-cursor-smarter) and [in our docs](https://nx.dev/features/enhance-AI).
12
+
13
+
## Installation and Usage
14
+
15
+
There are two ways to use this MCP server:
16
+
17
+
### a) Run it via the nx-mcp package
12
18
13
19
Simply invoke the MCP server via `npx` or your package manager's equivalent.
14
20
@@ -22,6 +28,15 @@ If you want to host the server instead of communicating via `stdio`, you can use
22
28
23
29
Run `nx-mcp --help` to see what options are available.
24
30
31
+
### b) Use the Nx Console extension
32
+
33
+
If you're using Cursor you can directly install the Nx Console extension which automatically manages the MCP server for you.
0 commit comments