WebSearch
Uma ferramenta avançada de busca na web e extração de conteúdo, alimentada pela API Firecrawl para raspagem e análise de sites.
Documentação
WebSearch - Ferramenta Avançada de Busca na Web e Extração de Conteúdo
Uma poderosa ferramenta de busca na web e extração de conteúdo construída com Python, utilizando a API Firecrawl para capacidades avançadas de raspagem web, busca e análise de conteúdo.
🚀 Recursos
- Busca Avançada na Web: Realize buscas inteligentes na web com parâmetros personalizáveis
- Extração de Conteúdo: Extraia informações específicas de páginas web usando prompts em linguagem natural
- Rastreamento Web: Rastreie sites com profundidade e limites configuráveis
- Raspagem Web: Raspe páginas web com suporte a vários formatos de saída
- Integração MCP: Construído como um servidor Model Context Protocol (MCP) para integração perfeita
📋 Pré-requisitos
- Python 3.8 ou superior
- Gerenciador de pacotes uv
- Chave da API Firecrawl
- Chave da API OpenAI (opcional, para recursos aprimorados)
- Chave da API Tavily (opcional, para capacidades adicionais de busca)
🛠️ Instalação
- Instale o uv:
# On Windows (using pip)
pip install uv
# On Unix/MacOS
curl -LsSf https://astral.sh/uv/install.sh | sh
# Add uv to PATH (Unix/MacOS)
export PATH="$HOME/.local/bin:$PATH"
# Add uv to PATH (Windows - add to Environment Variables)
# Add: %USERPROFILE%\.local\bin
- Clone o repositório:
git clone https://github.com/yourusername/websearch.git
cd websearch
- Crie e ative um ambiente virtual com uv:
# Create virtual environment
uv venv
# Activate on Windows
.\.venv\Scripts\activate.ps1
# Activate on Unix/MacOS
source .venv/bin/activate
- Instale as dependências com uv:
# Install from requirements.txt
uv sync
- Configure as variáveis de ambiente:
# Create .env file
touch .env
# Add your API keys
FIRECRAWL_API_KEY=your_firecrawl_api_key
OPENAI_API_KEY=your_openai_api_key
🎯 Uso
Configuração com Claude for Desktop
Em vez de executar o servidor diretamente, você pode configurar o Claude for Desktop para acessar as ferramentas WebSearch:
-
Localize ou crie seu arquivo de configuração do Claude for Desktop:
- Windows:
%env:AppData%\Claude\claude_desktop_config.json - macOS:
~/Library/Application Support/Claude/claude_desktop_config.json
- Windows:
-
Adicione a configuração do servidor WebSearch à seção
mcpServers:
{
"mcpServers": {
"websearch": {
"command": "uv",
"args": [
"--directory",
"D:\\ABSOLUTE\\PATH\\TO\\WebSearch",
"run",
"main.py"
]
}
}
}
-
Certifique-se de substituir o caminho do diretório pelo caminho absoluto da pasta do seu projeto WebSearch.
-
Salve o arquivo de configuração e reinicie o Claude for Desktop.
-
Uma vez configurado, as ferramentas WebSearch aparecerão no menu de ferramentas (ícone de martelo) no Claude for Desktop.
Ferramentas Disponíveis
-
Buscar
-
Extrair Informações
-
Rastrear Sites
-
Raspar Conteúdo
📚 Referência da API
Buscar
query(str): A consulta de busca- Retorna: Resultados da busca em formato JSON
Extrair
urls(List[str]): Lista de URLs para extrair informaçõesprompt(str): Instruções para extraçãoenableWebSearch(bool): Ativar busca web suplementarshowSources(bool): Incluir referências de fontes- Retorna: Informações extraídas no formato especificado
Rastrear
url(str): URL inicialmaxDepth(int): Profundidade máxima de rastreamentolimit(int): Número máximo de páginas para rastrear- Retorna: Conteúdo rastreado em formato markdown/HTML
Raspar
url(str): URL de destino- Retorna: Conteúdo raspado com capturas de tela opcionais
🔧 Configuração
Variáveis de Ambiente
A ferramenta requer certas chaves de API para funcionar. Fornecemos um arquivo .env.example que você pode usar como modelo:
- Copie o arquivo de exemplo:
# On Unix/MacOS
cp .env.example .env
# On Windows
copy .env.example .env
- Edite o arquivo
.envcom suas chaves de API:
# OpenAI API key - Required for AI-powered features
OPENAI_API_KEY=your_openai_api_key_here
# Firecrawl API key - Required for web scraping and searching
FIRECRAWL_API_KEY=your_firecrawl_api_key_here
Obtendo as Chaves de API
-
Chave da API OpenAI:
- Visite a plataforma da OpenAI
- Cadastre-se ou faça login
- Navegue até a seção de chaves de API
- Crie uma nova chave secreta
-
Chave da API Firecrawl:
- Visite o site da Firecrawl
- Crie uma conta
- Navegue até seu painel
- Gere uma nova chave de API
Se tudo estiver configurado corretamente, você deverá receber uma resposta JSON com os resultados da busca.
Solução de Problemas
Se você encontrar erros:
- Certifique-se de que todas as chaves de API necessárias estejam definidas no seu arquivo
.env - Verifique se as chaves de API são válidas e não expiraram
- Confirme que o arquivo
.envestá no diretório raiz do projeto - Certifique-se de que as variáveis de ambiente estão sendo carregadas corretamente
🤝 Contribuindo
- Faça um fork do repositório
- Crie sua branch de recurso (
git checkout -b feature/AmazingFeature) - Faça commit das suas alterações (
git commit -m 'Add some AmazingFeature') - Envie para a branch (
git push origin feature/AmazingFeature) - Abra um Pull Request
📝 Licença
Este projeto está licenciado sob a Licença MIT - consulte o arquivo LICENSE para detalhes.
🙏 Agradecimentos
- Firecrawl pela poderosa API de raspagem web
- OpenAI pelas capacidades de IA
- MCP A comunidade MCP pela especificação do protocolo
📬 Contato
José Martín Rodriguez Mortaloni - @m4s1t425 - jmrodriguezm13@gmail.com
Feito com ❤️ usando Python e Firecrawl