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
docs: add initial documentation for MCP server tools
Adds documentation for the tools available in the Angular CLI MCP server. This includes:
- get_best_practices
- search_documentation
- list_projects
Also includes a section for providing feedback and ideas for new capabilities.
Copy file name to clipboardExpand all lines: adev/src/content/ai/mcp-server-setup.md
+31Lines changed: 31 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -65,3 +65,34 @@ For these IDEs, create a configuration file and add the following snippet. Note
65
65
}
66
66
}
67
67
```
68
+
69
+
## Available Tools
70
+
71
+
The Angular CLI MCP server provides several tools to assist you in your development workflow. Here's an overview of the available tools:
72
+
73
+
### Get Angular Coding Best Practices Guide (`get_best_practices`)
74
+
75
+
This tool provides a guide on modern Angular coding best practices. Before you start writing or modifying code, you can use this tool to ensure your work aligns with current standards, such as using standalone components, typed forms, and the latest control flow syntax.
76
+
77
+
***Inputs:** None
78
+
***Outputs:** The content of the best practices guide.
This tool allows you to search the official Angular documentation at [angular.dev](https://angular.dev). It's the recommended way to find up-to-date information on Angular APIs, tutorials, and guides. The search is powered by Algolia.
83
+
84
+
***Inputs:**
85
+
*`query`: The search term (e.g., "ngif", "standalone components").
86
+
*`includeTopContent` (optional, default: `true`): When `true`, the content of the top search result is returned along with the search results.
87
+
***Outputs:** A list of search results, including title, breadcrumbs, and URL. If `includeTopContent` is enabled, it also returns the content of the top-ranked page.
88
+
89
+
### List Angular Projects (`list_projects`)
90
+
91
+
This tool lists all the applications and libraries in your current Angular workspace. It reads the `angular.json` file to identify and provide details about each project.
92
+
93
+
***Inputs:** None
94
+
***Outputs:** A list of project objects, with details for each project like its name, type (`application` or `library`), root directory, and component selector prefix.
95
+
96
+
## Feedback and New Ideas
97
+
98
+
The Angular team welcomes your feedback on the existing MCP capabilities and any ideas you have for new tools or features. Please share your thoughts by opening an issue on the [angular/angular GitHub repository](https://github.com/angular/angular/issues).
0 commit comments