SJ RedM MCP Server

Um servidor MCP versátil para desenvolvimento RedM, fornecendo acesso a descobertas do RDR3, documentação de frameworks, funções nativas e operações de banco de dados.

GitHub
7
Experimente este MCPPatrocinado

Documentação

SJ RedM MCP Server

Um servidor MCP (Model Context Protocol) unificado, do tipo "canivete suíço", para desenvolvimento RedM que combina descobertas do RDR3, documentação de frameworks (VORP/RSGCore), funções nativas e operações de banco de dados em uma única ferramenta poderosa.

Recursos

🔍 Integração com RDR3 Discoveries

  • Pesquise no repositório abrangente do GitHub de descobertas do RDR3
  • Acesse assets do jogo, texturas, modelos de peds, controles, cenários e animações
  • Obtenha exemplos de código Lua para tópicos específicos
  • Navegue pela estrutura do repositório e leia arquivos diretamente

📚 Documentação de Frameworks

  • VORP Framework: Documentação completa incluindo núcleo, personagens, inventário, menu, metabolismo e mais
  • RSGCore Framework: Documentação de eventos e funções de cliente/servidor
  • oxmysql: Documentação de operações de banco de dados e consultas
  • Carregamento inteligente de contexto — mencione "vorp" ou "rsg" para carregar automaticamente a documentação relevante

⚡ Banco de Dados de Funções Nativas

  • Mais de 86 namespaces cobrindo todos os sistemas do jogo RDR3
  • Mais de 221 arquivos de documentação com detalhes abrangentes de nativas
  • Pesquise nativas por nome ou funcionalidade
  • Obtenha informações detalhadas de parâmetros e exemplos de uso
  • Prefira chamadas diretas em vez de hashes, com comentários de hash para scripts Lua

🧠 Carregamento Inteligente de Contexto

  • Detecta automaticamente menções a frameworks e carrega a documentação relevante
  • Sugestões sensíveis ao contexto com base nas suas consultas
  • Ativação inteligente de módulos para desempenho ideal

Instalação

Pré-requisitos

  • Node.js 16.0.0 ou superior
  • Aplicativo Claude Desktop OU Claude Code CLI

Configuração Rápida

  1. Navegue até o diretório:

    cd "/path/to/sj-redm-mcp"

  2. Instale as dependências:

    npm install

  3. Escolha seu método de configuração:

Opção A: Configuração com Claude Code CLI (Recomendada)

  1. Adicione o servidor MCP:

    claude mcp add sj-redm-mcp node "/absolute/path/to/sj-redm-mcp/index.js"

  2. Defina o token do GitHub (opcional, mas recomendado):

    claude mcp add-json sj-redm-mcp '{
  "command": "node",
  "args": ["/absolute/path/to/sj-redm-mcp/index.js"],
  "env": {
    "GITHUB_TOKEN": "your-github-token-here"
  }
}'

  3. Verifique se o servidor está configurado:

    claude mcp list

Alternativa: Configuração em nível de projeto

O repositório inclui um arquivo .mcp.json para configuração em nível de projeto. Ao trabalhar neste diretório, o Claude Code CLI detectará e usará automaticamente o servidor MCP.

Opção B: Configuração com Claude Desktop

  1. Configure o Claude Desktop:

    Adicione o seguinte ao seu arquivo de configuração do Claude Desktop:

    Windows: %APPDATA%\Claude\claude_desktop_config.json macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

    {
  "mcpServers": {
    "sj-redm-mcp": {
      "command": "node",
      "args": ["/absolute/path/to/sj-redm-mcp/index.js"],
      "env": {
        "GITHUB_TOKEN": "your-github-token-here"
      }
    }
  }
}

    Nota: O token do GitHub é opcional, mas recomendado para limites de taxa de API mais altos.

  2. Reinicie o Claude Desktop

Ferramentas Disponíveis

Ferramentas de RDR3 Discoveries

  • redm-search-discoveries: Pesquise no repositório de descobertas do RDR3
  • redm-read-discovery-file: Leia arquivos específicos do repositório
  • redm-list-discovery-dirs: Liste o conteúdo do diretório
  • redm-get-lua-examples: Encontre exemplos de código Lua por tópico

Ferramentas de Documentação de Frameworks

  • redm-search-framework-docs: Pesquise na documentação do VORP e do RSGCore
  • redm-get-vorp-docs: Obtenha toda a documentação do framework VORP
  • redm-get-rsgcore-docs: Obtenha toda a documentação do framework RSGCore
  • redm-get-oxmysql-docs: Obtenha a documentação de operações de banco de dados

Ferramentas de Funções Nativas

  • redm-search-natives: Pesquise funções nativas por nome
  • redm-get-native-details: Obtenha informações detalhadas de funções nativas
  • redm-list-native-namespaces: Liste todos os namespaces disponíveis
  • redm-browse-namespace: Navegue pelas nativas dentro de um namespace específico

Ferramentas Inteligentes

  • redm-get-smart-context: Obtenha contexto inteligente com base na sua consulta

Exemplos de Uso

Desenvolvimento de Frameworks

"How do I create a character in VORP?"
→ Automatically loads VORP docs + oxmysql docs

"Show me RSGCore server events for player management"
→ Loads RSGCore documentation with server events

Pesquisa de Assets do Jogo

"Find texture information for horse models"
→ Uses RDR3 discoveries for asset research

"Get animation examples for ped interactions"
→ Searches discoveries repo for animation scripts

Desenvolvimento de Funções Nativas

"How do I use SET_PED_COMPONENT_VARIATION native?"
→ Returns detailed native info with parameters and Lua example

"Search for vehicle-related natives in VEHICLE namespace"
→ Lists relevant vehicle natives with usage details

Operações de Banco de Dados

"How do I insert player data into database?"
→ Includes oxmysql documentation automatically

Recursos de Contexto Inteligente

O servidor MCP carrega inteligentemente a documentação relevante com base nas suas consultas:

  • Menções a VORP: Carrega automaticamente a documentação completa do VORP + documentação do oxmysql
  • Menções a RSG/RSGCore: Carrega automaticamente a documentação completa do RSGCore + documentação do oxmysql
  • Termos de pesquisa de assets (textura, ped, animação, etc.): Prioriza as descobertas do RDR3
  • Termos de nativas/scripting: Ativa o banco de dados de funções nativas
  • Termos de banco de dados: Inclui a documentação do oxmysql

Estrutura da Documentação

sj-redm-mcp/
├── docs/
│   ├── vorp/                    # VORP framework documentation
│   │   ├── vorp_core_docs.md
│   │   ├── vorp_characters_docs.md
│   │   ├── vorp_inventory_docs.md
│   │   └── ...
│   ├── rsgcore/                 # RSGCore framework documentation
│   │   ├── rsgcore_client_events.md
│   │   ├── rsgcore_server_events.md
│   │   └── ...
│   ├── natives/                 # RDR3 native functions (86+ namespaces)
│   │   ├── ENTITY/
│   │   ├── PLAYER/
│   │   ├── VEHICLE/
│   │   └── ...
│   └── oxmysql_documentation.md # Database operations
├── cache/                       # Performance cache
├── package.json
├── index.js                     # Main MCP server
└── README.md

Recursos de Funções Nativas

  • Preferência por Chamadas Diretas: Usa nomes de funções em vez de hashes
  • Comentários de Hash: Inclui valores de hash como comentários para referência
  • Detalhes de Parâmetros: Informações completas de parâmetros e tipos
  • Exemplos em Lua: Exemplos de código funcionais para cada nativa
  • Mais de 86 Namespaces: Cobertura completa de todos os sistemas do RDR3

Exemplo de saída de nativa:

-- Set ped component variation
Ped.SetPedComponentVariation(ped, componentId, drawableId, textureId, paletteId) -- 0x262B14F48D29DE80

Solução de Problemas

Problemas Comuns

  1. Erros de "Module not found"

    • Certifique-se de que você executou npm install no diretório correto
    • Verifique se a versão do Node.js é 16.0.0 ou superior

  2. Limite de taxa da API do GitHub

    • Adicione um token do GitHub à sua configuração para limites mais altos
    • Repositórios públicos têm limites de taxa mais baixos sem autenticação

  3. Claude Desktop não reconhecendo o servidor

    • Verifique o caminho absoluto na sua configuração
    • Certifique-se de que a sintaxe JSON é válida em claude_desktop_config.json
    • Reinicie o Claude Desktop após alterações na configuração

  4. Claude Code CLI não reconhecendo o servidor

    • Execute claude mcp list para verificar se o servidor está configurado
    • Verifique se o caminho absoluto na sua configuração está correto
    • Se estiver usando configuração em nível de projeto, certifique-se de estar no diretório correto
    • Execute claude mcp remove sj-redm-mcp e adicione novamente se necessário

  5. Documentação não carregando

    • Verifique se todos os arquivos de documentação estão no diretório docs/
    • Verifique se as permissões de arquivo permitem leitura

Dicas de Desempenho

  • O servidor usa cache inteligente para melhor desempenho
  • O índice de funções nativas é construído no primeiro uso e armazenado em cache
  • A documentação de frameworks é armazenada em cache após o primeiro carregamento
  • Use buscas por namespace específico para consultas mais rápidas de funções nativas

Contribuindo

Este servidor MCP combina funcionalidades de múltiplas fontes:

  • RDR3 Discoveries — Pesquisa e documentação do jogo
  • VORP Framework — Documentação do framework RedM
  • RSGCore Framework — Framework alternativo para RedM
  • RDR3 Natives Database — Documentação abrangente de funções nativas

Licença

Licença MIT — Sinta-se à vontade para usar e modificar para suas necessidades de desenvolvimento RedM.

Suporte

Para problemas ou dúvidas:

  1. Verifique a seção de solução de problemas acima
  2. Verifique sua configuração do Claude Desktop
  3. Certifique-se de que todas as dependências estão instaladas corretamente
  4. Teste ferramentas individuais usando os comandos disponíveis

Registro de Alterações

v1.0.0

  • Lançamento unificado inicial
  • Combinou 3 MCPs separados em um
  • Adicionou carregamento inteligente de contexto
  • Implementou nomenclatura consistente de ferramentas com o prefixo "redm-"
  • Processo de instalação único
  • Cobertura abrangente de documentação