Godot MCP

Servidor MCP para interagir com o motor de jogos Godot, fornecendo ferramentas para editar, executar, depurar e gerenciar cenas em projetos Godot.

Documentação

Godot MCP

Github-sponsors

Made with Godot

                           (((((((             (((((((
                        (((((((((((           (((((((((((
                        (((((((((((((       (((((((((((((
                        (((((((((((((((((((((((((((((((((
                        (((((((((((((((((((((((((((((((((
         (((((      (((((((((((((((((((((((((((((((((((((((((      (((((
       (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
     ((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
    ((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
      (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
        (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
         (((((((((((@@@@@@@(((((((((((((((((((((((((((@@@@@@@(((((((((((
         (((((((((@@@@,,,,,@@@(((((((((((((((((((((@@@,,,,,@@@@(((((((((
         ((((((((@@@,,,,,,,,,@@(((((((@@@@@(((((((@@,,,,,,,,,@@@((((((((
         ((((((((@@@,,,,,,,,,@@(((((((@@@@@(((((((@@,,,,,,,,,@@@((((((((
         (((((((((@@@,,,,,,,@@((((((((@@@@@((((((((@@,,,,,,,@@@(((((((((
         ((((((((((((@@@@@@(((((((((((@@@@@(((((((((((@@@@@@((((((((((((
         (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
         (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
         @@@@@@@@@@@@@((((((((((((@@@@@@@@@@@@@((((((((((((@@@@@@@@@@@@@
         ((((((((( @@@(((((((((((@@(((((((((((@@(((((((((((@@@ (((((((((
         (((((((((( @@((((((((((@@@(((((((((((@@@((((((((((@@ ((((((((((
          (((((((((((@@@@@@@@@@@@@@(((((((((((@@@@@@@@@@@@@@(((((((((((
           (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((
              (((((((((((((((((((((((((((((((((((((((((((((((((((((
                 (((((((((((((((((((((((((((((((((((((((((((((((
                        (((((((((((((((((((((((((((((((((


                          /$$      /$$  /$$$$$$  /$$$$$$$
                         | $$$    /$$$ /$$__  $$| $$__  $$
                         | $$$$  /$$$$| $$  \__/| $$  \ $$
                         | $$ $$/$$ $$| $$      | $$$$$$$/
                         | $$  $$$| $$| $$      | $$____/
                         | $$\  $ | $$| $$    $$| $$
                         | $$ \/  | $$|  $$$$$$/| $$
                         |__/     |__/ \______/ |__/

Um servidor Model Context Protocol (MCP) para interagir com o motor de jogos Godot.

Introdução

O Godot MCP permite que agentes de IA iniciem o editor Godot, executem projetos, capturem saída de depuração e controlem a execução de projetos. Esse ciclo de feedback direto ajuda os agentes a entender o que funciona e o que não funciona em projetos Godot reais, resultando em melhor geração de código e assistência de depuração.

Recursos

  • Iniciar o Editor Godot: Abrir o editor Godot para um projeto específico
  • Executar Projetos Godot: Executar projetos Godot em modo de depuração
  • Capturar Saída de Depuração: Recuperar saída do console e mensagens de erro
  • Controlar Execução: Iniciar e parar projetos Godot programaticamente
  • Obter Versão do Godot: Recuperar a versão instalada do Godot
  • Listar Projetos Godot: Encontrar projetos Godot em um diretório especificado
  • Análise de Projetos: Obter informações detalhadas sobre a estrutura do projeto
  • Gerenciamento de Cenas:
    • Criar novas cenas com tipos de nó raiz especificados
    • Adicionar nós a cenas existentes com propriedades personalizáveis
    • Carregar sprites e texturas em nós Sprite2D
    • Exportar cenas 3D como recursos MeshLibrary para GridMap
    • Salvar cenas com opções para criar variantes
  • Gerenciamento de UID (para Godot 4.4+):
    • Obter UID para arquivos específicos
    • Atualizar referências de UID ao salvar novamente os recursos

Requisitos

  • Godot Engine instalado no seu sistema
  • Node.js (>=18.0.0) e npm
  • Um agente de IA que suporte MCP

Início Rápido

Claude Code

claude mcp add godot -- npx @coding-solo/godot-mcp

É isso. Reinicie o Claude Code e suas ferramentas Godot MCP estarão disponíveis.

Com variáveis de ambiente:

claude mcp add godot -e GODOT_PATH=/path/to/godot -e DEBUG=true -- npx @coding-solo/godot-mcp
Cline

Adicione ao seu arquivo de configurações MCP do Cline (~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json):

{
  "mcpServers": {
    "godot": {
      "command": "npx",
      "args": ["@coding-solo/godot-mcp"],
      "env": {
        "DEBUG": "true"
      },
      "disabled": false,
      "autoApprove": [
        "launch_editor",
        "run_project",
        "get_debug_output",
        "stop_project",
        "get_godot_version",
        "list_projects",
        "get_project_info",
        "create_scene",
        "add_node",
        "load_sprite",
        "export_mesh_library",
        "save_scene",
        "get_uid",
        "update_project_uids"
      ]
    }
  }
}
Cursor

Usando a interface do Cursor:

  1. Vá para Configurações do Cursor > Recursos > MCP
  2. Clique no botão + Adicionar Novo Servidor MCP
  3. Preencha o formulário:
    • Nome: godot
    • Tipo: command
    • Comando: npx @coding-solo/godot-mcp
  4. Clique em "Adicionar"
  5. Talvez seja necessário pressionar o botão de atualização no canto superior direito do cartão do servidor MCP para popular a lista de ferramentas

Usando configuração específica do projeto:

Crie um arquivo em .cursor/mcp.json no diretório do seu projeto:

{
  "mcpServers": {
    "godot": {
      "command": "npx",
      "args": ["@coding-solo/godot-mcp"],
      "env": {
        "DEBUG": "true"
      }
    }
  }
}
Outros Clientes MCP

Para qualquer cliente compatível com MCP, use esta configuração:

{
  "mcpServers": {
    "godot": {
      "command": "npx",
      "args": ["@coding-solo/godot-mcp"],
      "env": {
        "GODOT_PATH": "/path/to/godot",
        "DEBUG": "true"
      }
    }
  }
}

Variáveis de Ambiente

VariávelDescrição
GODOT_PATHCaminho para o executável do Godot (substitui a detecção automática)
DEBUGDefina como "true" para habilitar o registro detalhado de depuração no servidor
Compilando a partir do Código Fonte
git clone https://github.com/Coding-Solo/godot-mcp.git
cd godot-mcp
npm install
npm run build

Em seguida, aponte seu cliente MCP para build/index.js em vez de usar npx.

Arquitetura

O servidor Godot MCP usa uma abordagem GDScript empacotada para operações complexas:

  1. Comandos diretos: Operações simples, como iniciar o editor ou obter informações do projeto, usam os comandos CLI integrados do Godot diretamente.
  2. Script de operações empacotado: Operações complexas, como criar cenas ou adicionar nós, usam um único arquivo GDScript abrangente (godot_operations.gd) que lida com todas as operações.

O script empacotado aceita o tipo de operação e parâmetros como JSON, permitindo execução flexível e dinâmica de operações sem gerar arquivos temporários para cada operação.

Solução de Problemas

  • Godot não encontrado: Defina a variável de ambiente GODOT_PATH para o caminho do seu executável Godot
  • Problemas de conexão: Certifique-se de que o servidor esteja em execução e reinicie seu assistente de IA
  • Caminho de projeto inválido: Certifique-se de que o caminho aponte para um diretório contendo um arquivo project.godot
  • Problemas de build: Certifique-se de que todas as dependências estejam instaladas executando npm install
Problemas Específicos do Cursor
  • Certifique-se de que o servidor MCP apareça e esteja habilitado nas configurações do Cursor (Configurações > MCP)
  • As ferramentas MCP só podem ser executadas usando o perfil de chat Agent (assinatura Cursor Pro ou Business)
  • Use o "Modo Yolo" para executar automaticamente solicitações de ferramentas MCP

Licença

Este projeto é licenciado sob a Licença MIT - consulte o arquivo LICENSE para obter detalhes.