angular-mcp
v0.1.0
Published
MCP server for Angular and Angular Material documentation
Downloads
19
Maintainers
Readme
Angular Documentation MCP Server
Um servidor MCP (Model Context Protocol) que fornece acesso à documentação do Angular e Angular Material.
Funcionalidades
Este servidor permite que assistentes de IA busquem e recuperem informações de:
- Documentação do Angular (https://angular.dev/)
- Documentação do Angular Material (https://material.angular.dev/)
Ferramentas Disponíveis
1. search-angular-docs
Busca na documentação do Angular ou Angular Material por informações sobre conceitos, guias, tutoriais e referências de API.
Parâmetros:
query(string): Termo de busca na documentação do Angularsource(opcional):"angular"para documentação principal ou"material"para Angular Material (padrão: angular)limit(opcional): Número máximo de resultados a retornar (padrão: 10)
2. get-angular-doc-page
Obtém conteúdo detalhado de uma página específica da documentação do Angular ou Angular Material.
Parâmetros:
url(string): URL completa para a página da documentaçãoinclude_sections(opcional): Se deve incluir divisão por seções (padrão: true)
3. angular-quick-reference
Obtém informações de referência rápida para conceitos comuns do Angular e componentes do Angular Material.
Parâmetros:
topic(string): Tópico para obter referência rápida (ex: 'components', 'services', 'routing', 'material-button')source(opcional): Fonte da documentação (auto-detectado baseado no tópico)
Instalação e Uso
Pré-requisitos
- Node.js 16 ou superior
- npm
Instalação
npm install
npm run buildExecução
npm startDesenvolvimento
npm run devConfiguração no Claude Desktop
Para usar este servidor com o Claude Desktop, adicione a seguinte configuração ao seu arquivo claude_desktop_config.json:
Windows:
{
"mcpServers": {
"angular-docs": {
"command": "node",
"args": ["C:\\CAMINHO\\ABSOLUTO\\PARA\\Angular MCP\\build\\index.js"]
}
}
}macOS/Linux:
{
"mcpServers": {
"angular-docs": {
"command": "node",
"args": ["/CAMINHO/ABSOLUTO/PARA/Angular MCP/build/index.js"]
}
}
}Estrutura do Projeto
angular-mcp/
├── src/
│ └── index.ts # Código principal do servidor MCP
├── build/ # Arquivos compilados
├── .github/
│ └── copilot-instructions.md
├── package.json
├── tsconfig.json
└── README.mdExemplos de Uso
Buscar documentação sobre componentes
search-angular-docs query="components" source="angular"Obter referência rápida sobre roteamento
angular-quick-reference topic="routing"Buscar componente Button do Angular Material
search-angular-docs query="button" source="material"Obter conteúdo detalhado de uma página
get-angular-doc-page url="https://angular.dev/guide/components"Tecnologias Utilizadas
- TypeScript: Linguagem principal
- @modelcontextprotocol/sdk: SDK para implementação MCP
- axios: Cliente HTTP para fazer requisições
- cheerio: Biblioteca para parsing de HTML
- zod: Validação de esquemas
Desenvolvimento
Comandos Úteis
npm run build: Compila o projeto TypeScriptnpm start: Executa o servidor compiladonpm run dev: Compila e executa em modo de desenvolvimento
Diretrizes de Desenvolvimento
- Use TypeScript com modo estrito habilitado
- Siga padrões e convenções do SDK MCP
- Trate erros graciosamente e forneça mensagens de erro significativas
- Use práticas adequadas de web scraping com delays respeitosos
- Cache respostas quando apropriado para evitar requisições excessivas
Contribuição
Contribuições são bem-vindas! Por favor, siga as diretrizes de desenvolvimento e envie pull requests.
Licença
ISC License
