mirror of
https://github.com/angular/angular.git
synced 2026-09-14 13:54:52 +08:00
docs: Updated MCP docs to include latest experimental tools and recent renames
(cherry picked from commit c963f35d2c)
This commit is contained in:
committed by
Jessica Janiuk
parent
95bc06d6c3
commit
985bdeefd3
@@ -22,10 +22,12 @@ Some tools are provided in experimental / preview status since they are new or n
|
||||
| Name | Description | `local-only` | `read-only` |
|
||||
| :------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :----------: | :---------: |
|
||||
| `build` | Perform a one-off, non-watched build using `ng build`. | ✅ | ❌ |
|
||||
| `modernize` | Performs code migrations and provides further instructions on how to modernize Angular code to align with the latest best practices and syntax. [Learn more](/reference/migrations) | ✅ | ❌ |
|
||||
| `devserver.start` | Asynchronously starts a development server that watches the workspace for changes, similar to running `ng serve`. Since this is asynchronous it returns immediately. To manage the resulting server, use the `devserver.stop` and `devserver.wait_for_build` tools. | ✅ | ✅ |
|
||||
| `devserver.stop` | Stops a development server started by `devserver.start`. | ✅ | ✅ |
|
||||
| `devserver.wait_for_build` | Returns the output logs of the most recent build in a running development server started by `devserver.start`. If a build is currently ongoing, it will first wait for that build to complete and then return the logs. | ✅ | ✅ |
|
||||
| `e2e` | Executes the end-to-end tests configured in the project. | ✅ | ✅ |
|
||||
| `modernize` | Performs code migrations and provides further instructions on how to modernize Angular code to align with the latest best practices and syntax. [Learn more](https://angular.dev/reference/migrations) | ✅ | ❌ |
|
||||
| `test` | Runs the project's unit tests. | ✅ | ✅ |
|
||||
|
||||
## Get Started
|
||||
|
||||
@@ -133,11 +135,11 @@ For other IDEs, check your IDE's documentation for the proper location of the MC
|
||||
|
||||
The `mcp` command can be configured with the following options passed as arguments in your IDE's MCP configuration:
|
||||
|
||||
| Option | Type | Description | Default |
|
||||
| :---------------------------- | :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------ |
|
||||
| `--read-only` | `boolean` | Only register tools that do not make changes to the project. Your editor or coding agent may still perform edits. | `false` |
|
||||
| `--local-only` | `boolean` | Only register tools that do not require an internet connection. Your editor or coding agent may still send data over the network. | `false` |
|
||||
| `--experimental-tool`<br>`-E` | `string` | Enable an [experimental tool](#experimental-tools). Separate multiple options by spaces, e.g. `-E tool_a tool_b`. You can also enable tool groups like `devserver` to enable all related tools at once, e.g. `-E devserver`. | |
|
||||
| Option | Type | Description | Default |
|
||||
| :---------------------------- | :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------ |
|
||||
| `--read-only` | `boolean` | Only register tools that do not make changes to the project. Your editor or coding agent may still perform edits. | `false` |
|
||||
| `--local-only` | `boolean` | Only register tools that do not require an internet connection. Your editor or coding agent may still send data over the network. | `false` |
|
||||
| `--experimental-tool`<br>`-E` | `string` | Enable an [experimental tool](#experimental-tools). Separate multiple options by spaces, e.g. `-E tool_a tool_b`. Enable all `devserver.x` tools by using `-E devserver`. | |
|
||||
|
||||
For example, to run the server in read-only mode in VS Code, you would update your `mcp.json` like this:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user