# 🧭 MCP DadosBR Navigation Guide
> **Quick navigation to find exactly what you need**
## 🚀 I want to get started quickly
### 🇧🇷 Sou desenvolvedor brasileiro
- **[📖 Documentação PT-BR](docs/pt-br/README.md)** - Comece aqui!
- **[⚡ Primeira Consulta CNPJ](docs/pt-br/exemplos/basicos/primeira-consulta-cnpj.md)** - Tutorial passo-a-passo
- **[⚙️ Configuração do Ambiente](docs/pt-br/desenvolvimento/configuracao-ambiente.md)** - Setup completo
### 🇺🇸 I'm an international developer
- **[📖 Main README](README.md)** - Start here!
- **[⚙️ Configuration Guide](docs/CONFIGURATION.md)** - Setup and configuration
- **[🔧 MCP Client Integration](docs/MCP_CLIENT_INTEGRATION.md)** - IDE setup guides
## 🎯 I want to understand the architecture
### 🏗️ Architecture Deep Dive
- **[🇧🇷 Visão Geral da Arquitetura](docs/pt-br/arquitetura/visao-geral.md)** - Complete architectural overview (PT-BR)
- **[🇧🇷 Arquivo Único](docs/pt-br/arquitetura/arquivo-unico.md)** - Single-file architecture details (PT-BR)
- **[📊 Project Structure](PROJECT_STRUCTURE.md)** - Complete project organization
### 🔄 Data Flow and Patterns
- **[🇧🇷 Fluxo de Dados](docs/pt-br/arquitetura/fluxo-dados.md)** - Data flow with diagrams (PT-BR)
- **[🇧🇷 Limitações e Benefícios](docs/pt-br/arquitetura/limitacoes-beneficios.md)** - Trade-offs analysis (PT-BR)
## 💻 I want to develop with this project
### 🛠️ Development Guides
- **[🇧🇷 Convenções de Nomenclatura](docs/pt-br/desenvolvimento/convencoes-nomenclatura.md)** - Naming conventions (PT-BR)
- **[🇧🇷 Padrões de Implementação](docs/pt-br/desenvolvimento/padroes-implementacao.md)** - Implementation patterns (PT-BR)
- **[🧪 Testing Guide](docs/development/TESTING.md)** - Test suite documentation
- **[🔍 Code Review](docs/development/CODE_REVIEW.md)** - Code quality analysis
### 📚 Examples and Use Cases
- **[🇧🇷 Exemplos Básicos](docs/pt-br/exemplos/basicos/)** - Basic examples in Portuguese
- **[💡 Usage Examples](docs/USAGE_EXAMPLES.md)** - Real-world integration patterns
- **[📋 Example Usage](EXAMPLE_USAGE.md)** - Quick usage examples
## 🔧 I want to configure and deploy
### ⚙️ Configuration
- **[📖 Configuration Guide](docs/CONFIGURATION.md)** - Environment variables and setup
- **[🔍 Search Providers](docs/PROVIDERS.md)** - DuckDuckGo, Tavily, SerpAPI setup
- **[🇧🇷 Configuração do Ambiente](docs/pt-br/desenvolvimento/configuracao-ambiente.md)** - Complete setup guide (PT-BR)
### 🚀 Deployment
- **[☁️ Cloudflare Deployment](CLOUDFLARE_DEPLOYMENT.md)** - Serverless deployment guide
- **[✅ Deployment Ready](DEPLOYMENT_READY.md)** - Pre-deployment checklist and instructions
- **[🔍 Workers Review](CLOUDFLARE_WORKERS_REVIEW.md)** - Code compatibility analysis
- **[🔧 MCP Client Integration](MCP_CLIENT_INTEGRATION.md)** - IDE setup (Claude, Cursor, Windsurf)
## 🧠 I want to use advanced features
### 🔍 Search and Intelligence
- **[🔍 Web Search](docs/WEB_SEARCH.md)** - Intelligent web search capabilities
- **[🧠 Sequential Thinking](docs/SEQUENTIAL_THINKING.md)** - Structured reasoning
- **[🔍 Search Providers](docs/PROVIDERS.md)** - Provider comparison and setup
### 📊 Monitoring and Quality
- **[📈 Performance](docs/development/FINAL_SUMMARY.md)** - Performance metrics and optimization
- **[🔒 Security](docs/development/CODE_REVIEW.md#security)** - Security features and LGPD compliance
## 📝 I want to contribute
### 🤝 Contributing
- **[🤝 Contributing Guide](CONTRIBUTING.md)** - How to contribute
- **[🇧🇷 Boas Práticas](docs/pt-br/desenvolvimento/boas-praticas.md)** - Best practices (PT-BR)
- **[📋 Feature Planning](docs/development/FEATURE_PLANNING.md)** - Roadmap and planning
### 📚 Documentation
- **[🇧🇷 Glossário Técnico](docs/pt-br/glossario/termos-tecnicos.md)** - Technical terminology (PT-BR)
- **[📖 Documentation Updates](docs/development/DOCUMENTATION_UPDATES.md)** - Documentation guidelines
## 🔍 I'm looking for specific information
### 📊 Technical Details
- **[📁 Project Structure](PROJECT_STRUCTURE.md)** - Complete project organization
- **[🏗️ Architecture Specs](.kiro/specs/)** - Detailed specifications
- **[🧪 Test Suite](test/)** - 88 unit tests with 100% pass rate
### 🌐 API and Integration
- **[🛠️ Tools Available](#-available-tools)** - cnpj_lookup, cep_lookup, cnpj_search, sequentialthinking
- **[🌐 Multi-Platform](#-multi-platform-support)** - NPM, Cloudflare Workers, Smithery
- **[📊 Quality Metrics](#-quality-metrics)** - Coverage, tests, compliance
## 🆘 I need help
### 📞 Support Channels
- **[🐛 GitHub Issues](https://github.com/cristianoaredes/mcp-dadosbr/issues)** - Bug reports and feature requests
- **[💬 GitHub Discussions](https://github.com/cristianoaredes/mcp-dadosbr/discussions)** - Community discussions
- **[📧 Email](mailto:cristiano@aredes.me)** - Direct contact
### 🔧 Troubleshooting
- **[🇧🇷 Troubleshooting PT-BR](docs/pt-br/desenvolvimento/configuracao-ambiente.md#troubleshooting)** - Common issues (PT-BR)
- **[⚙️ Configuration Issues](docs/CONFIGURATION.md#troubleshooting)** - Setup problems
- **[🧪 Test Failures](docs/development/TESTING.md)** - Test-related issues
---
## 🎯 Quick Links by Role
### 👨💻 Brazilian Developer
1. [Documentação PT-BR](docs/pt-br/README.md)
2. [Primeira Consulta](docs/pt-br/exemplos/basicos/primeira-consulta-cnpj.md)
3. [Configuração](docs/pt-br/desenvolvimento/configuracao-ambiente.md)
### 🌍 International Developer
1. [Main README](README.md)
2. [Configuration](docs/CONFIGURATION.md)
3. [MCP Integration](docs/MCP_CLIENT_INTEGRATION.md)
### 🏗️ Architect
1. [Architecture Overview](docs/pt-br/arquitetura/visao-geral.md)
2. [Project Structure](PROJECT_STRUCTURE.md)
3. [Trade-offs Analysis](docs/pt-br/arquitetura/limitacoes-beneficios.md)
### 🚀 DevOps Engineer
1. [Cloudflare Deployment](docs/CLOUDFLARE_DEPLOYMENT.md)
2. [Configuration Guide](docs/CONFIGURATION.md)
3. [Performance Metrics](docs/development/FINAL_SUMMARY.md)
### 🧪 QA Engineer
1. [Testing Guide](docs/development/TESTING.md)
2. [Code Review](docs/development/CODE_REVIEW.md)
3. [Quality Metrics](PROJECT_STRUCTURE.md#-key-metrics)
---
**Can't find what you're looking for? [Open an issue](https://github.com/cristianoaredes/mcp-dadosbr/issues) and we'll help you navigate!**
