Embora esta seja uma versão v1.0, antecipamos mudanças na API à medida que recebermos mais feedback.

Instalação

Este projeto utiliza UV para gerenciamento de pacotes:

Utilização

Utilização Básica

Inicie o servidor Slither MCP:

Todas as ferramentas aceitam um parâmetro path que especifica qual projeto Solidity analisar. Projetos são automaticamente armazenados em cache em <path>/artifacts/project_facts.json para consultas subsequentes mais rápidas.

Utilização no Claude Code

Utilização no Cursor

Certifique-se de que o uvx esteja no seu PATH do Cursor usando sudo ln -s ~/.local/bin/uvx /usr/local/bin/uvx

No seu ~/.cursor/mcp.json:

Métricas e Privacidade

O Slither MCP inclui métricas opcionais para ajudar a melhorar a confiabilidade, informando-nos com que frequência os LLMs usam cada ferramenta e sua taxa de chamadas bem-sucedidas. As métricas estão ativadas por padrão, mas podem ser permanentemente desativadas.

O Que Coletamos

• Eventos de chamada de ferramenta (quais ferramentas são usadas)
• Status de sucesso/falha

Não coletamos: parâmetros de chamada de ferramenta, detalhes de contratos, nomes de funções ou qualquer informação específica do projeto.

Desativando Métricas

Para desativar permanentemente:

Para detalhes completos, veja METRICS.md.

Ferramentas MCP

O servidor expõe ferramentas para consultar informações de contratos e funções. Todas as ferramentas aceitam um parâmetro path que especifica o diretório do projeto Solidity a ser analisado.

Ferramentas de Consulta

1. list_contracts - Listar contratos com filtros

Requer: path (diretório do projeto) Filtrar contratos por tipo (concreto, abstrato, interface, biblioteca) ou padrão de caminho.

2. get_contract - Obter informações detalhadas do contrato

Recuperar metadados completos do contrato, incluindo funções, herança e flags.

3. get_contract_source - Obter código-fonte do contrato

Retorna o código-fonte completo do arquivo Solidity que contém o contrato especificado.

4. get_function_source - Obter código-fonte da função

Retorna o código-fonte de uma função específica com números de linha. Útil para análise focada.

5. list_functions - Listar funções com filtros

Filtrar funções por contrato, visibilidade ou modificadores.

6. function_callees - Obter relacionamentos de chamadas de função

Retorna chamadas internas, externas e de biblioteca para uma função, incluindo detecção de chamadas de baixo nível.

7. function_callers - Obter funções que chamam uma função alvo

Retorna todas as funções que chamam a função alvo especificada, agrupadas por tipo de chamada (interna, externa, biblioteca). Esta é a inversa de function_callees.

8. get_inherited_contracts - Obter herança de contrato

Retorna uma árvore recursiva de todos os contratos dos quais um contrato herda (pais e ancestrais).

9. get_derived_contracts - Obter contratos que herdam deste

Retorna uma árvore recursiva de todos os contratos que herdam de um contrato (filhos e descendentes).

10. list_function_implementations - Encontrar implementações de função

Encontra todas as implementações de uma assinatura de função entre contratos.

11. list_detectors - Listar detectores Slither disponíveis

Retorna metadados sobre os detectores do Slither, incluindo nomes, descrições, níveis de impacto e classificações de confiança. Suporta filtragem por nome ou descrição.

12. run_detectors - Obter resultados dos detectores com filtragem

Retorna resultados em cache dos detectores. Filtre por nomes de detectores, nível de impacto (Alto, Médio, Baixo, Informativo) ou nível de confiança (Alto, Médio, Baixo).

Todas as ferramentas retornam respostas com um booleano success e, ou campos de dados, ou um error_message. Consulte as implementações individuais das ferramentas em slither_mcp/tools/ para esquemas detalhados e uso.

Uso do Cliente

O pacote slither-mcp inclui um cliente Python tipado (SlitherMCPClient) para interagir programaticamente com o servidor Slither MCP. Isso é útil para construir ferramentas, scripts ou agentes que precisam consultar projetos Solidity.

O cliente fornece:

• Métodos type-safe para todas as ferramentas MCP
• Serialização/desserialização automática de modelos Pydantic
• Métodos auxiliares para padrões comuns
• Wrappers de ferramentas para integração com agentes pydantic-ai

Para exemplos de uso detalhados e documentação, consulte CLIENT_USAGE.md.

Requisitos

• Python 3.11+
• Configuração do compilador Solidity (Foundry, Hardhat ou similar)
• Slither e suas dependências

Desenvolvimento

Hooks Pre-commit

Instale os hooks pre-commit para executar linting antes dos commits:

Executando Testes