-
Notifications
You must be signed in to change notification settings - Fork 12k
feat(@angular/cli): add initial MCP server implementation #30601
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+239
−5
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
/** | ||
* @license | ||
* Copyright Google LLC All Rights Reserved. | ||
* | ||
* Use of this source code is governed by an MIT-style license that can be | ||
* found in the LICENSE file at https://angular.dev/license | ||
*/ | ||
|
||
import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js'; | ||
import { Argv } from 'yargs'; | ||
import { CommandModule, CommandModuleImplementation } from '../../command-builder/command-module'; | ||
import { isTTY } from '../../utilities/tty'; | ||
import { createMcpServer } from './mcp-server'; | ||
|
||
const INTERACTIVE_MESSAGE = ` | ||
To start using the Angular CLI MCP Server, add this configuration to your host: | ||
{ | ||
"mcpServers": { | ||
"angular-cli": { | ||
"command": "npx", | ||
"args": ["@angular/cli", "mcp"] | ||
} | ||
} | ||
} | ||
Exact configuration may differ depending on the host. | ||
`; | ||
|
||
export default class McpCommandModule extends CommandModule implements CommandModuleImplementation { | ||
command = 'mcp'; | ||
describe = false as const; | ||
longDescriptionPath = undefined; | ||
|
||
builder(localYargs: Argv): Argv { | ||
return localYargs; | ||
} | ||
|
||
async run(): Promise<void> { | ||
if (isTTY()) { | ||
this.context.logger.info(INTERACTIVE_MESSAGE); | ||
|
||
return; | ||
} | ||
|
||
const server = await createMcpServer({ workspace: this.context.workspace }); | ||
const transport = new StdioServerTransport(); | ||
await server.connect(transport); | ||
} | ||
} |
44 changes: 44 additions & 0 deletions
44
packages/angular/cli/src/commands/mcp/instructions/best-practices.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
You are an expert in TypeScript, Angular, and scalable web application development. You write maintainable, performant, and accessible code following Angular and TypeScript best practices. | ||
|
||
## TypeScript Best Practices | ||
|
||
- Use strict type checking | ||
- Prefer type inference when the type is obvious | ||
- Avoid the `any` type; use `unknown` when type is uncertain | ||
|
||
## Angular Best Practices | ||
|
||
- Always use standalone components over NgModules | ||
- Don't use explicit `standalone: true` (it is implied by default) | ||
- Use signals for state management | ||
- Implement lazy loading for feature routes | ||
- Use `NgOptimizedImage` for all static images. | ||
|
||
## Components | ||
|
||
- Keep components small and focused on a single responsibility | ||
- Use `input()` and `output()` functions instead of decorators | ||
- Use `computed()` for derived state | ||
- Set `changeDetection: ChangeDetectionStrategy.OnPush` in `@Component` decorator | ||
- Prefer inline templates for small components | ||
- Prefer Reactive forms instead of Template-driven ones | ||
- Do NOT use `ngClass`, use `class` bindings instead | ||
- DO NOT use `ngStyle`, use `style` bindings instead | ||
|
||
## State Management | ||
|
||
- Use signals for local component state | ||
- Use `computed()` for derived state | ||
- Keep state transformations pure and predictable | ||
|
||
## Templates | ||
|
||
- Keep templates simple and avoid complex logic | ||
- Use native control flow (`@if`, `@for`, `@switch`) instead of `*ngIf`, `*ngFor`, `*ngSwitch` | ||
- Use the async pipe to handle observables | ||
|
||
## Services | ||
|
||
- Design services around a single responsibility | ||
- Use the `providedIn: 'root'` option for singleton services | ||
- Use the `inject()` function instead of constructor injection |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
/** | ||
* @license | ||
* Copyright Google LLC All Rights Reserved. | ||
* | ||
* Use of this source code is governed by an MIT-style license that can be | ||
* found in the LICENSE file at https://angular.dev/license | ||
*/ | ||
|
||
import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'; | ||
import { readFile } from 'node:fs/promises'; | ||
import path from 'node:path'; | ||
import type { AngularWorkspace } from '../../utilities/config'; | ||
import { VERSION } from '../../utilities/version'; | ||
|
||
export async function createMcpServer(context: { | ||
workspace?: AngularWorkspace; | ||
}): Promise<McpServer> { | ||
const server = new McpServer({ | ||
name: 'angular-cli-server', | ||
version: VERSION.full, | ||
capabilities: { | ||
resources: {}, | ||
tools: {}, | ||
}, | ||
}); | ||
|
||
server.registerResource( | ||
'instructions', | ||
'instructions://best-practices', | ||
{ | ||
title: 'Angular System Instructions', | ||
description: | ||
'A set of instructions to help LLMs generate correct code that follows Angular best practices.', | ||
mimeType: 'text/markdown', | ||
}, | ||
async () => { | ||
const text = await readFile( | ||
path.join(__dirname, 'instructions', 'best-practices.md'), | ||
'utf-8', | ||
); | ||
|
||
return { contents: [{ uri: 'instructions://best-practices', text }] }; | ||
}, | ||
); | ||
|
||
server.registerTool( | ||
'list_projects', | ||
{ | ||
title: 'List projects', | ||
description: | ||
'List projects within an Angular workspace.' + | ||
' This information is read from the `angular.json` file at the root path of the Angular workspace', | ||
}, | ||
() => { | ||
if (!context.workspace) { | ||
return { | ||
content: [ | ||
{ | ||
type: 'text', | ||
text: 'Not within an Angular project.', | ||
}, | ||
], | ||
}; | ||
} | ||
|
||
return { | ||
content: [ | ||
{ | ||
type: 'text', | ||
text: | ||
'Projects in the Angular workspace: ' + | ||
[...context.workspace.projects.keys()].join(','), | ||
}, | ||
], | ||
}; | ||
}, | ||
); | ||
|
||
return server; | ||
} |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why not
ng mcp
?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it's a host specific identifier that in some cases can be used in dot-notation.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I meant the command instead of
npx @angular/cli mcp
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems to be a common pattern in the configuration. Plus it bypasses global installation issues. The command needs to be available globally. We can adjust and iterate on the best approach based on feedback though.