SJ RedM MCP Server

Un servidor MCP versátil para el desarrollo en RedM, que proporciona acceso a descubrimientos de RDR3, documentación de frameworks, funciones nativas y operaciones de base de datos.

GitHub
7
Prueba este MCPPatrocinado

Documentación

SJ RedM MCP Server

Un servidor MCP (Model Context Protocol) unificado tipo "navaja suiza" para el desarrollo de RedM que combina descubrimientos de RDR3, documentación de frameworks (VORP/RSGCore), funciones nativas y operaciones de base de datos en una sola herramienta potente.

Características

🔍 Integración de descubrimientos RDR3

  • Busca en el completo repositorio de GitHub de descubrimientos RDR3
  • Accede a assets del juego, texturas, modelos de ped, controles, escenarios y animaciones
  • Obtén ejemplos de código Lua para temas específicos
  • Explora la estructura del repositorio y lee archivos directamente

📚 Documentación de frameworks

  • VORP Framework: Documentación completa que incluye core, personajes, inventario, menú, metabolismo y más
  • RSGCore Framework: Documentación de eventos y funciones de cliente/servidor
  • oxmysql: Documentación de operaciones y consultas de base de datos
  • Carga de contexto inteligente: menciona "vorp" o "rsg" para cargar automáticamente la documentación relevante

⚡ Base de datos de funciones nativas

  • Más de 86 namespaces que cubren todos los sistemas del juego RDR3
  • Más de 221 archivos de documentación con detalles nativos completos
  • Busca nativos por nombre o funcionalidad
  • Obtén información detallada de parámetros y ejemplos de uso
  • Prefiere llamadas directas sobre hashes con comentarios de hash para scripting en Lua

🧠 Carga de contexto inteligente

  • Detecta automáticamente menciones de frameworks y carga la documentación relevante
  • Sugerencias conscientes del contexto basadas en tus consultas
  • Activación inteligente de módulos para un rendimiento óptimo

Instalación

Requisitos previos

  • Node.js 16.0.0 o superior
  • Aplicación Claude Desktop O Claude Code CLI

Configuración rápida

  1. Navega al directorio:

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

  2. Instala las dependencias:

    npm install

  3. Elige tu método de configuración:

Opción A: Configuración con Claude Code CLI (Recomendada)

  1. Añade el servidor MCP:

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

  2. Configura el token de GitHub (opcional pero 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. Verifica que el servidor esté configurado:

    claude mcp list

Alternativa: Configuración a nivel de proyecto

El repositorio incluye un archivo .mcp.json para la configuración a nivel de proyecto. Cuando trabajes en este directorio, Claude Code CLI detectará y usará automáticamente el servidor MCP.

Opción B: Configuración de Claude Desktop

  1. Configura Claude Desktop:

    Añade lo siguiente a tu archivo de configuración de 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: El token de GitHub es opcional pero recomendado para límites de tasa de API más altos.

  2. Reinicia Claude Desktop

Herramientas disponibles

Herramientas de descubrimientos RDR3

  • redm-search-discoveries: Busca en el repositorio de descubrimientos RDR3
  • redm-read-discovery-file: Lee archivos específicos del repositorio
  • redm-list-discovery-dirs: Lista el contenido del directorio
  • redm-get-lua-examples: Encuentra ejemplos de código Lua por tema

Herramientas de documentación de frameworks

  • redm-search-framework-docs: Busca documentación de VORP y RSGCore
  • redm-get-vorp-docs: Obtén toda la documentación del framework VORP
  • redm-get-rsgcore-docs: Obtén toda la documentación del framework RSGCore
  • redm-get-oxmysql-docs: Obtén documentación de operaciones de base de datos

Herramientas de funciones nativas

  • redm-search-natives: Busca funciones nativas por nombre
  • redm-get-native-details: Obtén información detallada de funciones nativas
  • redm-list-native-namespaces: Lista todos los namespaces disponibles
  • redm-browse-namespace: Explora nativos dentro de un namespace específico

Herramientas inteligentes

  • redm-get-smart-context: Obtén contexto inteligente basado en tu consulta

Ejemplos de uso

Desarrollo 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

Investigación de assets del juego

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

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

Desarrollo de funciones 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

Operaciones de base de datos

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

Funciones de contexto inteligente

El servidor MCP carga inteligentemente la documentación relevante según tus consultas:

  • Menciones de VORP: Carga automáticamente la documentación completa de VORP + documentación de oxmysql
  • Menciones de RSG/RSGCore: Carga automáticamente la documentación completa de RSGCore + documentación de oxmysql
  • Términos de investigación de assets (texture, ped, animation, etc.): Prioriza los descubrimientos de RDR3
  • Términos de nativos/scripting: Activa la base de datos de funciones nativas
  • Términos de base de datos: Incluye documentación de oxmysql

Estructura de documentación

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

Características de funciones nativas

  • Preferencia de llamadas directas: Usa nombres de funciones en lugar de hashes
  • Comentarios de hash: Incluye valores de hash como comentarios para referencia
  • Detalles de parámetros: Información completa de parámetros y tipos
  • Ejemplos en Lua: Ejemplos de código funcionales para cada nativo
  • Más de 86 namespaces: Cobertura completa de todos los sistemas RDR3

Ejemplo de salida nativa:

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

Solución de problemas

Problemas comunes

  1. Errores de "Module not found"

    • Asegúrate de haber ejecutado npm install en el directorio correcto
    • Verifica que la versión de Node.js sea 16.0.0 o superior

  2. Límite de tasa de la API de GitHub

    • Añade un token de GitHub a tu configuración para límites más altos
    • Los repositorios públicos tienen límites de tasa más bajos sin autenticación

  3. Claude Desktop no reconoce el servidor

    • Verifica la ruta absoluta en tu configuración
    • Asegúrate de que la sintaxis JSON sea válida en claude_desktop_config.json
    • Reinicia Claude Desktop después de los cambios de configuración

  4. Claude Code CLI no reconoce el servidor

    • Ejecuta claude mcp list para verificar que el servidor esté configurado
    • Verifica que la ruta absoluta en tu configuración sea correcta
    • Si usas configuración a nivel de proyecto, asegúrate de estar en el directorio correcto
    • Ejecuta claude mcp remove sj-redm-mcp y vuelve a añadirlo si es necesario

  5. La documentación no se carga

    • Verifica que todos los archivos de documentación estén en el directorio docs/
    • Verifica que los permisos de archivo permitan la lectura

Consejos de rendimiento

  • El servidor usa caché inteligente para un mejor rendimiento
  • El índice de funciones nativas se construye en el primer uso y se almacena en caché
  • La documentación de frameworks se almacena en caché después de la primera carga
  • Usa búsquedas de namespace específicas para búsquedas más rápidas de funciones nativas

Contribuciones

Este servidor MCP combina funcionalidad de múltiples fuentes:

  • RDR3 Discoveries - Investigación y documentación del juego
  • VORP Framework - Documentación del framework RedM
  • RSGCore Framework - Framework alternativo de RedM
  • RDR3 Natives Database - Documentación completa de funciones nativas

Licencia

Licencia MIT - Siéntete libre de usar y modificar para tus necesidades de desarrollo de RedM.

Soporte

Para problemas o preguntas:

  1. Consulta la sección de solución de problemas anterior
  2. Verifica tu configuración de Claude Desktop
  3. Asegúrate de que todas las dependencias estén instaladas correctamente
  4. Prueba herramientas individuales usando los comandos disponibles

Registro de cambios

v1.0.0

  • Versión unificada inicial
  • Combinó 3 MCPs separados en uno
  • Añadió carga de contexto inteligente
  • Implementó nombres de herramientas consistentes con el prefijo "redm-"
  • Proceso de instalación único
  • Cobertura completa de documentación