AI导哈

vRP框架MCP配置

vRP框架的MCP配置，为FiveM游戏开发提供客户端和服务器端功能文档支持。

  • by pedronavarrodev
  • 本地部署
  • 更新于
在 GitHub 查看 pedronavarrodev/etstore-mcp-vrpex-fivem

使用说明

vRP框架-MCP配置-光标IDE

此目录包含用于 Cursor IDE 的模型上下文协议 （MCP） 配置文件，为 FiveM 提供结构化的 vRP 框架文档。

📁 文件结构

mcp/
├── README.md                    # Este arquivo - documentação de configuração
├── vrp-client-functions.json    # Documentação completa das funções client-side
├── vrp-server-functions.json    # Documentação completa das funções server-side
└── .cursorrules                 # Regras do Cursor IDE (opcional)

🚀 如何在Cursor IDE中配置MCP

方法1：通过光标配置文件进行配置

  1. 查找光标配置文件 ：

    • 窗户： %APPDATA%\Cursor\User\settings.json
    • macOS： ~/Library/Application Support/Cursor/User/settings.json
    • Linux： ~/.config/Cursor/User/settings.json

  2. 添加 MCP 配置 ：

{
  "mcp.servers": {
    "vrp-framework": {
      "command": "node",
      "args": [
        "path/to/mcp-server.js"
      ],
      "env": {
        "VRP_CLIENT_DOCS": "path/to/mcp/vrp-client-functions.json",
        "VRP_SERVER_DOCS": "path/to/mcp/vrp-server-functions.json"
      }
    }
  }
}

方法2：直接使用上下文文件

最简单的方法是在光标中添加JSON文件作为上下文：

  1. 打开 IDE 光标
  2. 转到“设置”>“功能”>“MCP”
  3. 将 JSON 文件添加为资源：
    • vrp-client-functions.json
    • vrp-server-functions.json

方法 3: 使用 .cursorrules （推荐）

创建文件 .cursorrules 在项目的根部：

# vRP Framework Rules

Este projeto usa o framework vRP para FiveM.

## Funções Client-Side
- Todas as funções client-side usam o prefixo `vRP` via Proxy
- Use `vRP.getUserId()` para obter o ID do usuário no client
- Use `vRP.teleport(x, y, z)` para teleportar o jogador
- Consulte `mcp/vrp-client-functions.json` para lista completa

## Funções Server-Side
- Todas as funções server-side usam o prefixo `vRP`
- Use `vRP.getUserId(source)` no servidor (requer source)
- Use `vRP.getMoney(user_id)` para obter dinheiro do jogador
- Consulte `mcp/vrp-server-functions.json` para lista completa

## Exports Disponíveis
- `exports['vrp']:setCooldown(user_id, name, time)`
- `exports['vrp']:getCooldown(user_id, name)`
- `exports['vrp']:setBlockCommand(user_id, segundos)`
- `exports['vrp']:checkCommand(user_id)`
- `exports['vrp']:alertPolice(data)`

## Importante
- Client-side: Use `vRP.*` (via Proxy)
- Server-side: Use `vRP.*` diretamente
- Tunnel functions começam com `_` (underscore)
- Sempre verifique se user_id/source não é nil antes de usar

📚 如何使用JSON文件

文件结构

JSON 文件包含：

  • 函数名称
  • 完整描述
  • 使用范例
  • 参数 （带类型）
  • 回报价值 （如适用）
  • 重要意见

查询示例

当您需要特定函数时，光标可以自动查询：

-- O Cursor pode sugerir automaticamente:
local user_id = vRP.getUserId()  -- Client-side
local money = vRP.getMoney(user_id)  -- Server-side

🔧 高级设置

与TypeScript/IntelliSense集成

如果您使用 Lua 的 Cursor 扩展，您可以创建一个定义文件：

-- vrp.d.ts (para TypeScript/Lua Language Server)
---@class vRP
---@field getUserId fun(): number
---@field teleport fun(x: number, y: number, z: number): void
-- ... etc

更新档案

当文档更新时 ：

  1. 更新相应的 JSON 文件
  2. 重新启动 IDE 光标以重新装入上下文
  3. MCP 自动读取文件

📖 参考资料

  • 客户端文档 ： documentação.md
  • 服务器文档 ： documentação_server.md
  • MCP 文件 ： mcp/vrp-client-functions.json e mcp/vrp-server-functions.json

⚠️ 重要说明

  1. 客户端与服务器：

    • 客户端功能可通过 vRP.* 使用 Proxy
    • 服务器端功能可直接通过 vRP.*
    • 在使用前始终检查上下文（客户端或服务器）

  2. 出口：

    • 导出总是服务器端
    • 使用 exports['vrp']:nomeExport(...)

  3. 隧道功能：

    • Tunnel 函数以 _ （下划线）
    • 用于客户端通信↔ 服务器

🆘 支持

如果遇到问题：

  1. 检查文件路径是否正确
  2. 确保 IDE 光标是最新的
  3. 更改 MCP 设置后重新启动光标

版本 ： 1.0.0
上次更新 ： 基于文档 documentação.md e documentação_server.md

相关 MCP