primeng-mcp-server
v1.0.5
Published
MCP server for PrimeNG documentation
Downloads
41
Readme
PrimeNG MCP Server
Servidor MCP (Model Context Protocol) para consultar documentación de PrimeNG desde asistentes compatibles (como Windsurf).
Provee herramientas para:
- Obtener detalles de un componente específico (selector, descripción, etc.).
- Listar componentes disponibles (heurístico).
- Buscar en la documentación por término (heurístico).
Requisitos
- Node.js >= 18 (recomendado Node 20 o 22).
- Acceso a Internet (hace scraping de https://primeng.org).
Instalación y uso
Configura Windsurf en tu equipo con npx (descarga y ejecuta la última versión publicada)
Edita tu archivo c:/Users/<tu_usuario>/.codeium/windsurf/mcp_config.json y agrega:
{
"mcpServers": {
"primeng": {
"command": "npx",
"args": ["-y", "primeng-mcp-server"],
"transport": "stdio",
"env": {}
}
}
}- Si prefieres fijar versión para estabilidad:
{
"mcpServers": {
"primeng": {
"command": "npx",
"args": ["-y", "[email protected]"],
"transport": "stdio",
"env": {}
}
}
}- Refresca MCP Servers en Windsurf (o reinicia el asistente). Deberías ver el servidor
primengy sus tools.
Otras formas de uso
Instalación global
npm i -g primeng-mcp-serverConfigura Windsurf:
{
"mcpServers": {
"primeng": {
"command": "primeng-mcp-server",
"args": [],
"transport": "stdio",
"env": {}
}
}
}Scripts disponibles
npm run build: Compila TypeScript adist/.npm start: Ejecutanode dist/index.js(modo build).npm run dev: Ejecuta conts-node --esm src/index.ts(modo desarrollo). No recomendado para Windsurf; usadist.
Herramientas expuestas (tools)
get_primeng_component- Parámetros:
{ componentName: string }(ej.: "Button", "Table", "Dialog"). - Devuelve JSON con campos:
name,description,selector,properties,methods,events,cssVariables,examples(algunos extraídos heurísticamente o TODO).
- Parámetros:
list_primeng_components- Sin parámetros.
- Devuelve una lista heurística de componentes detectados en la página.
search_primeng_documentation- Parámetros:
{ query: string }. - Busca el término en páginas de componentes (hasta un límite razonable) y devuelve coincidencias con snippet.
- Parámetros:
Ejemplos de uso desde Windsurf
- Ejecuta
list_primeng_componentsy revisa la salida. - Ejecuta
get_primeng_componentcon{ "componentName": "Button" }. - Ejecuta
search_primeng_documentationcon{ "query": "filter" }.
Solución de problemas
- Proxy corporativo / Internet restringido:
- Configura variables
HTTP_PROXY/HTTPS_PROXYenenvdel servidor MCP, por ejemplo:
- Configura variables
{
"mcpServers": {
"primeng": {
"command": "npx",
"args": ["-y", "primeng-mcp-server"],
"transport": "stdio",
"env": {
"HTTPS_PROXY": "http://proxy.miempresa:8080",
"HTTP_PROXY": "http://proxy.miempresa:8080"
}
}
}
}- El scraping es heurístico y puede ser más lento con límites altos; reduce el alcance aumentando caché o disminuyendo límites en búsqueda.
