使用说明
FiveM文档📚
欢迎来到FiveM文档!这是官方消息来源。您可以在此处查看详细的指南、参考资料和开发资源。
🔗 来源: docs.fivem.net
FiveM MCP服务器🤖
该项目包括 模型上下文协议(MCP) 允许AI助手的服务器 搜索、浏览和阅读 本地FiveM文档。
工具和资源
search--排名全文搜索;返回具有干净的行号代码段的匹配文档。list_sections--带有计数和描述的顶级文档部分。list_docs--列出文档(路径+标题),可按部分和/或查询过滤。read--按文档的相对路径读取文档(如果路径错误,则建议进行紧密匹配)。get_section--返回文档的标题大纲,或按标题提取单个部分。- 资源 --每个医生都暴露为
fivem://docs/<relative-path>因此MCP客户端可以直接浏览和附加文档。
先决条件
- Node.js≥18.18
安装
cd mcp-server
npm install # also builds automatically via the "prepare" script
npm run build # (only needed if you skipped the install build)
npm test # optional: end-to-end tool tests
服务器从以下位置读取文档 ../../content/docs 相对于 build/index.js,所以保留它 在此存储库中签出.要从其他地方运行它,请设置 FIVEM_DOCS_ROOT 环境变量到绝对路径 content/docs 文件夹。
克劳德代码(CLI)
claude mcp add fivem-docs -- node /absolute/path/to/FiveM-MCP-Server/mcp-server/build/index.js
克劳德桌面版
将此添加到您的Claude Desktop配置中(%APPDATA%/Claude/claude_desktop_config.json 在Windows上, ~/Library/Application Support/Claude/claude_desktop_config.json 在macOS上)。使用A 绝对的 通往 你的 结账:
{
"mcpServers": {
"fivem-docs": {
"command": "node",
"args": ["/absolute/path/to/FiveM-MCP-Server/mcp-server/build/index.js"]
}
}
}
VS Code
创建 .vscode/mcp.json 在您的工作空间中:
{
"servers": {
"fivem-docs": {
"command": "node",
"args": ["${workspaceFolder}/mcp-server/build/index.js"]
}
}
}
贡献🚀
如果您在文档中发现任何错误或服务器问题,请直接在此存储库中报告。
想帮忙吗? 🤝
我们热爱贡献!如果您有兴趣帮忙,请查看我们的 贡献指南 开始吧。