@cyberweb/kinghost-design-system-mcp
v1.0.5
Published
🎨 Servidor MCP para Design System KingHost - Acesso dinâmico a componentes e tokens via Dart Doc - Desenvolvido pela Squad DevCanais
Downloads
9
Readme
🎨 Kinghost Widgetbook MCP Server
Servidor MCP (Model Context Protocol) para integração com o sistema de design Kinghost via Widgetbook.
Desenvolvido pela Squad DevCanais - Kinghost
🚀 Instalação e Uso
Para qualquer desenvolvedor (recomendado):
npx kinghost-widgetbook-mcpInstalação global (opcional):
npm install -g kinghost-widgetbook-mcp
kinghost-widgetbook-mcp⚙️ Configuração no Cursor
Adicione no seu arquivo mcp.json (Cursor):
macOS/Linux:
code ~/.cursor/mcp.jsonWindows:
code %APPDATA%/Cursor/mcp.jsonConfiguração do arquivo:
{
"mcpServers": {
"kinghost-widgetbook": {
"command": "npx",
"args": ["@cyberweb/kinghost-widgetbook-mcp@latest"],
"env": {
"WIDGETBOOK_URL": "https://widgetbook.kinghost.com"
}
}
}
}🛠️ Ferramentas Disponíveis
| Ferramenta | Descrição | Parâmetros |
|------------|-----------|------------|
| listar_componentes | Lista todos os componentes disponíveis | categoria (opcional), status (opcional) |
| buscar_componente | Busca detalhes de um componente específico | nome (obrigatório) |
| buscar_tokens | Consulta tokens de design (cores, espaçamento, etc.) | categoria (opcional) |
🔧 Variáveis de Ambiente
| Variável | Descrição | Padrão |
|----------|-----------|---------|
| WIDGETBOOK_URL | URL base do Widgetbook | https://widgetbook.kinghost.com |
| WIDGETBOOK_API | Endpoint da API (se disponível) | - |
🏗️ Arquitetura
┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
│ Cursor AI │◄──►│ MCP Server │◄──►│ Widgetbook │
│ │ │ (Este projeto) │ │ (Design Sys) │
└─────────────────┘ └──────────────────┘ └─────────────────┘🚦 Fluxo de Funcionamento
- Cursor AI faz solicitação via MCP
- MCP Server processa a solicitação
- Consulta dados do Widgetbook (mock data por enquanto)
- Retorna informações formatadas para o Cursor
🧪 Teste Rápido
Após configurar no Cursor, teste com:
"Liste os componentes disponíveis no design system"📦 Dependências
- Node.js >= 18.0.0
- @modelcontextprotocol/sdk: Framework MCP
- zod: Validação de schemas
🔍 Troubleshooting
Cursor não encontra o servidor:
- Verifique se o
mcp.jsonestá no local correto - Reinicie o Cursor
- Verifique se Node.js está instalado (
node --version)
npx não funciona:
# Limpe o cache do npm
npm cache clean --force
# Tente novamente
npx kinghost-widgetbook-mcpProblemas de permissão:
# No macOS/Linux, pode ser necessário:
chmod +x $(which npx)📈 Versioning
- Atual: v1.0.2
- Registro: npm público
- Instalação:
npx kinghost-widgetbook-mcp
🤝 Contribuindo
- Fork o projeto
- Crie sua feature branch (
git checkout -b feature/nova-funcionalidade) - Commit suas mudanças (
git commit -am 'Adiciona nova funcionalidade') - Push para a branch (
git push origin feature/nova-funcionalidade) - Abra um Pull Request
📞 Suporte
- Squad DevCanais: [email protected]
- Repositório: GitLab Kinghost
- Issues: Reportar problema
📜 Licença
MIT © Squad DevCanais - Kinghost
🎯 Objetivo: Facilitar o acesso aos componentes e tokens do Design System Kinghost através do Cursor AI, permitindo que desenvolvedores consultem informações de forma natural e eficiente.
