PyGhidra-MCP - Servidor do Protocolo de Contexto de Modelo Ghidra

Visão Geral

pyghidra-mcp é um servidor de linha de comando do Model Context Protocol (MCP) que traz todo o poder analítico do Ghidra, uma suíte robusta de engenharia reversa de software (SRE), para o mundo de agentes inteligentes e ferramentas baseadas em LLM. Ele conecta o ProgramAPI e o FlatProgramAPI do Ghidra ao Python usando pyghidra e jpype, e então expõe essa funcionalidade através do Model Context Protocol.

MCP é uma interface unificada que permite que modelos de linguagem, ferramentas de desenvolvimento (como VS Code) e agentes autônomos acessem contexto estruturado, invoquem ferramentas e colaborem de forma inteligente. Pense no MCP como a ponte entre ferramentas de análise poderosas e o ecossistema de LLMs.

Com o pyghidra-mcp, o Ghidra se torna um backend inteligente—pronto para responder a consultas ricas em contexto, automatizar tarefas profundas de engenharia reversa e se integrar a fluxos de trabalho assistidos por IA.

pyghidra-mcp agora suporta dois modos de operação:

• modo headless para análise e automação orientadas por CLI
• modo --gui, que inicia o Ghidra através do pyghidra-mcp e compartilha o estado do programa em tempo real com a GUI em execução

[!NOTE] Este projeto beta está em desenvolvimento ativo. Adoraríamos seu feedback, relatórios de bugs, solicitações de recursos e código.

Mais um MCP Ghidra?

Sim, o ghidra-mcp original é fantástico. Mas o pyghidra-mcp adota uma abordagem diferente:

• 🐍 Primeiro sem cabeça, com capacidade GUI – Execute inteiramente via CLI para automação simplificada, ou inicie o Ghidra com --gui quando quiser navegação e edição ao vivo na GUI.
• 🔁 Projetado para automação – Ideal para integração com LLMs, pipelines de CI e ferramentas que precisam de comportamento repetível.
• ✅ Amigável para CI/CD – Construído com testes unitários e de integração robustos para sessões de cliente e servidor.
• 🚀 Inicialização rápida – A inicialização assíncrona permite que o servidor comece a lidar com solicitações enquanto os binários ainda estão sendo analisados em segundo plano. Suporta inicialização rápida pela linha de comando com configuração mínima.
• 📦 Análise em todo o projeto – Permite engenharia reversa concorrente de todos os binários em um projeto Ghidra
• 🤖 Pronto para agentes – Construído para fluxos de trabalho orientados por agentes inteligentes e automação de engenharia reversa em grande escala.
• 🔍 Pesquisa semântica de código – Utiliza embeddings vetoriais (via ChromaDB) para permitir buscas rápidas e difusas em funções descompiladas, comentários e símbolos—perfeito para exploração de pseudo-C e triagem orientada por agentes.

Este projeto oferece uma experiência focada em Python, otimizada para desenvolvimento local, ambientes sem cabeça e fluxos de trabalho testáveis.

Diagramas de Configuração

Como as Peças se Conectam```mermaid

flowchart LR subgraph Clients["Clients"] Agent["MCP host / agent"] Cli["pyghidra-mcp-cli"] User["Ghidra user"] end

subgraph Process["pyghidra-mcp process"]
    Transport["stdio or streamable-http"]
    Tools["MCP tools"]
    Context["PyGhidra context"]
end

Project["Ghidra project<br/>.gpr / .rep"]
Artifacts["MCP artifacts<br/>ChromaDB + GZF cache"]
Gui["Ghidra GUI / CodeBrowser<br/>only with --gui"]

Agent -->|"stdio or HTTP"| Transport
Cli -->|"HTTP only"| Transport
Transport --> Tools
Tools --> Context
Context --> Project
Context --> Artifacts
Context -.-> Gui
User -.-> Gui
Gui -.-> Project

### Escolhendo um Modo```mermaid
flowchart TD
    Start["What do you need?"]
    Start --> Headless["Agent or automation only"]
    Start --> GuiNeed["Live Ghidra GUI control"]
    Start --> Terminal["Interactive terminal client"]

    Headless --> Stdio["pyghidra-mcp -t stdio<br/>or -t streamable-http"]
    GuiNeed --> GuiMode["pyghidra-mcp --gui<br/>--transport streamable-http<br/>--project-path project.gpr"]
    Terminal --> HttpServer["Start pyghidra-mcp<br/>--transport streamable-http"]
    HttpServer --> CliMode["Run pyghidra-mcp-cli commands"]

• Headless MCP: use stdio para hosts MCP locais, ou streamable-http quando vários clientes precisam do mesmo projeto Ghidra de longa duração.
• Modo GUI: pyghidra-mcp inicia o Ghidra, abre o projeto e expõe ferramentas extras que controlam o CodeBrowser na mesma JVM.
• Cliente CLI: pyghidra-mcp-cli é um cliente HTTP. Inicie um servidor streamable-http primeiro e depois execute comandos de terminal contra esse servidor em execução.

subgraph Transports
    Stdio["stdio"]
    Http["streamable-http"]
    Sse["sse legacy"]
end

subgraph Server["pyghidra-mcp server"]
    FastMcp["FastMCP tool server"]
    Context["PyGhidra context"]
    Indexing["background analysis and Chroma indexing"]

    subgraph Tools["MCP tools"]
        Analysis["decompile, xrefs, bytes, callgraph"]
        Search["symbols, strings, code"]
        ProjectOps["import, delete, metadata, list binaries"]
        Edits["rename function, rename variable, set type, set prototype, set comment"]
        GuiOnly["GUI only: open program, goto, list open programs, set current program"]
    end
end

subgraph GhidraRuntime["Ghidra runtime"]
    PyGhidra["pyghidra"]
    Jpype["JPype shared JVM"]
    Project["Ghidra project"]
    Programs["program databases"]
    CodeBrowser["Ghidra GUI / CodeBrowser"]
end

Agent --> Stdio
Agent --> Http
Automation --> Stdio
Automation --> Http
Automation --> Sse
Cli --> Http

Stdio --> FastMcp
Http --> FastMcp
Sse --> FastMcp

FastMcp --> Context
Context --> PyGhidra
PyGhidra --> Jpype
Jpype --> Project
Project --> Programs
Context --> Indexing
Indexing --> Search

FastMcp --> Tools
Tools --> Context
GuiOnly -.-> CodeBrowser
Context -.-> CodeBrowser

</details>

## Conteúdo