toradex-documentation-mcp
v1.0.0
Published
MCP Server para consultar documentação da Toradex
Downloads
6
Maintainers
Readme
Toradex Documentation MCP Server
Um servidor MCP (Model Context Protocol) para consultar toda a documentação disponível em https://developer.toradex.com/
Instalação
Via NPM (Recomendado)
npm install -g toradex-documentation-mcpVia Git
git clone https://github.com/cristianoleite/toradex-documentation-mcp.git
## Funcionalidades
- 🔍 **Busca Inteligente**: Busca semântica na documentação com ranking de relevância
- 🏗️ **Informações de Hardware**: Consulta detalhada sobre famílias Verdin, Apalis e Colibri
- 🐧 **Documentação Torizon**: Acesso completo à documentação da plataforma Torizon
- 📚 **Categorização**: Organização por categorias (hardware, torizon, linux-bsp, software)
- ⚡ **Cache Inteligente**: Sistema de cache para melhor performance
- 🌐 **Web Scraping**: Extração automática de conteúdo das páginas
## Ferramentas Disponíveis
### `search_toradex_documentation`
Busca na documentação da Toradex por tópicos específicos.
**Parâmetros:**
- `query` (obrigatório): Termo de busca ou pergunta
- `category` (opcional): Categoria específica (`hardware`, `torizon`, `linux-bsp`, `software`, `all`)
- `limit` (opcional): Número máximo de resultados (padrão: 10)
### `get_toradex_page_content`
Obtém o conteúdo completo de uma página específica da documentação.
**Parâmetros:**
- `url` (obrigatório): URL da página da documentação Toradex
### `list_toradex_categories`
Lista todas as categorias e seções disponíveis na documentação.
### `get_hardware_info`
Obtém informações sobre hardware específico da Toradex.
**Parâmetros:**
- `family` (opcional): Família do hardware (`verdin`, `apalis`, `colibri`, `all`)
- `type` (opcional): Tipo de componente (`modules`, `carrier-boards`, `add-ons`, `all`)
### `get_torizon_info`
Obtém informações específicas sobre Torizon.
**Parâmetros:**
- `topic` (opcional): Tópico específico (`os`, `ide-extensions`, `application-development`, `cloud`, `builder`, `all`)
## Configuração
### Claude Desktop
Após a instalação via NPM, adicione ao arquivo de configuração do Claude Desktop:
**Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
**macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
**Linux:** `~/.config/claude/claude_desktop_config.json`
```json
{
"mcpServers": {
"toradex-documentation": {
"command": "toradex-mcp"
}
}
}VS Code (com extensão MCP)
No VS Code, adicione à configuração de workspace (.vscode/settings.json):
{
"mcp.servers": {
"toradex-documentation": {
"command": "toradex-mcp"
}
}
}Configuração Manual
Se instalou via Git, use o caminho completo:
{
"mcpServers": {
"toradex-documentation": {
"command": "node",
"args": ["/caminho/para/toradex-documentation-mcp/dist/index.js"]
}
}
}Estrutura do Projeto
src/
├── index.ts # Servidor MCP principal
├── scraper.ts # Web scraper para documentação
└── search.ts # Sistema de busca e indexaçãoExemplos de Uso
Buscar informações sobre Verdin
Ferramenta: search_toradex_documentation
Parâmetros: {
"query": "Verdin iMX8M Mini",
"category": "hardware"
}Obter informações sobre desenvolvimento Torizon
Ferramenta: get_torizon_info
Parâmetros: {
"topic": "application-development"
}Buscar documentação sobre containers
Ferramenta: search_toradex_documentation
Parâmetros: {
"query": "Docker containers development",
"category": "torizon"
}Características Técnicas
- TypeScript: Desenvolvimento tipado e seguro
- Cache: Sistema de cache com TTL de 1 hora
- Rate Limiting: Pausas entre requisições para não sobrecarregar o servidor
- Error Handling: Tratamento robusto de erros
- Relevance Scoring: Algoritmo de pontuação de relevância para resultados de busca
Limitações
- Dependente da estrutura atual do site developer.toradex.com
- Cache limitado a 1 hora para evitar informações desatualizadas
- Rate limiting pode causar demora em buscas extensas
Contribuições
Contribuições são bem-vindas! Por favor, abra uma issue ou pull request.
Licença
MIT License
