YaCy MCP Server

Implementação do servidor MCP (Model Context Protocol) que fornece ferramentas de IA para pesquisar usando a API de busca web do YaCy.

Documentação

Servidor MCP YaCy

Implementação de servidor MCP (Model Context Protocol) que fornece ferramentas de IA para pesquisar usando a API de busca web do YaCy.

Instalação

  1. Certifique-se de ter o uv instalado:
pip install uv
  1. Instale o pacote em modo de desenvolvimento:
cd yacy-mcp
uv sync  # Sync all dependencies from pyproject.toml and uv.lock

Ou alternativamente:

cd yacy-mcp
uv pip install -e .

Uso

  1. Certifique-se de ter um servidor YaCy em execução (normalmente em http://localhost:8090)
  2. Defina as variáveis de ambiente (opcional):
export YACY_URL=http://localhost:8090
  1. Execute o servidor MCP:
python -m yacy_mcp

Configuração

O servidor pode ser configurado usando variáveis de ambiente:

Ferramentas Disponíveis

  • yacy-search: Pesquisar usando o mecanismo de busca web do YaCy
    • Parâmetros:
      • query (string, obrigatório): String da consulta de pesquisa
      • max_results (inteiro, opcional): Número máximo de resultados a retornar (padrão: 10)
      • resource (string, opcional): Recurso de pesquisa (local ou global, padrão: global)

Configuração MCP para Aplicações de IA

Para usar este servidor com aplicações de IA que suportam o Model Context Protocol (MCP), configure seu cliente MCP para conectar ao servidor usando transporte stdio.

Exemplo de configuração para Claude Desktop (settings.json):

{
  "mcpServers": {
    "yacy-mcp": {
      "command": "uvx",
      "args": ["yacy_mcp"],
      "env": {
        "YACY_URL": "http://localhost:8090"
      }
    }
  }
}

Para outras aplicações compatíveis com MCP, use o comando uvx yacy_mcp como executável do servidor. O servidor será automaticamente buscado e executado a partir do PyPI.

Integração com Aplicações de IA

Este servidor MCP pode ser usado com aplicações de IA que suportam o Model Context Protocol para realizar pesquisas na web usando o mecanismo de busca YaCy.