Arma Reforger Tools MCP

MCP文档知识

提供方 ViVi141

文档知识 stdio · 本地进程 无需鉴权 社区 / 第三方 ClaudeCursor
查看接入方式

一个为Arma Reforger和Enfusion脚本提供API文档支持的MCP服务器,具有智能搜索、完整文档、Wiki支持和关系图谱等功能。

一句话选型结论

按资料字段整理

Arma Reforger Tools MCP 属于文档知识类 MCP 服务器,stdio · 本地进程,无需鉴权,可直接接入 Claude、Cursor,有可直接执行的安装命令。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类文档知识 传输方式stdio · 本地进程 鉴权无需鉴权 部署方式本地部署
GitHub 星标 2 仓库热度,无公开仓库时显示未标注
工具数 5 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

文档知识
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量5暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

支持客户端

适用场景

API文档Python本地部署代码编辑器集成智能搜索关系图谱Wiki支持

安装与配置

stdio · 本地进程 无需鉴权
客户端在本机拉起子进程,数据不出本机
pip install -e .

这条命令只是入口,具体启动参数请按官方文档补齐,不要直接照搬到别的服务器。

  1. 1
    准备运行环境

    stdio 服务在本地起进程,需要先装好 Node.js 等运行时,再按安装命令拉取依赖。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后客户端会列出约 5 个工具,随便调一个只读工具确认能返回结果。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
文档检索问答

在你的文档库里按问题找答案。

知识库读写

把新资料写进知识库,随用随取。

内容整理

把零散资料归纳成结构化笔记。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 资料标注 5 个工具,职责相对集中,接入后不容易误操作。
  • 有现成的安装命令,不用自己找入口,照着跑就能起服务。
  • 已适配 Claude、Cursor,换客户端不用重新研究配置。
  • 资料标注无需鉴权,装好就能连。

先想清楚的地方

  • stdio 方式要求本地装好运行时(如 Node.js),换机器要重新装一遍。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在文档知识场景里让模型直接调用外部能力的人。
  • 已经在用 Claude、Cursor 的用户,接入路径最短。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 完全不想在本地装环境的人。
  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
Arma Reforger Tools MCP当前 5 stdio · 本地进程 本地部署 有 2026-05-17
dify 未标注 stdio · 本地进程 本地部署 有 2026-04-11
open-webui 未标注 stdio · 本地进程 本地部署 有 2026-04-11
JeecgBoot 未标注 stdio · 本地进程 本地部署 有 2026-04-11
Cherry Studio 未标注 未标注 未标注 无 2026-05-17
mempalace 未标注 stdio · 本地进程 本地部署 有 2026-04-11

服务器档案

文档知识
字段来自项目仓库与公开索引,中文说明由本站标注
提供方ViVi141上游标注的维护方 ViVi141
分类文档知识本站按上游分类展示
连接方式stdio · 本地进程客户端在本机拉起子进程,数据不出本机
鉴权方式无需鉴权远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时未标注 · 未标注本地安装时用到的包标识与运行时
部署类型本地部署上游给出的部署形态
最近核验2026-05-17上游最后核验时间

详细介绍

7.5 KB
来自项目仓库与上游目录的原文,未做删改

Arma Reforger API MCP 服务器

> 一个强大的 MCP 服务器,为 Cursor 等 AI 代码编辑器提供 Arma Reforger 和 Enfusion 脚本 API 文档支持。

✨ 功能特性

  • 🔍 智能搜索 - 快速搜索 API 类、方法、属性,支持自然语言查询
  • 📚 完整文档 - 获取详细的 API 文档和代码示例
  • 📖 Wiki 支持 - 搜索和查询 Arma Reforger Wiki 页面内容
  • 🔗 关系图谱 - 查看 API 之间的继承和使用关系
  • ⚡ 快速响应 - 基于全文索引的高性能搜索
  • 🛡️ 稳定可靠 - 完善的错误处理和验证机制

📦 获取方式

本 MCP 服务已发布至 ModelScope 平台,你可以:

  • 🌐 在 ModelScope 上查看和安装
  • 📥 从 GitHub 克隆源码自行构建(见下方安装步骤)

🚀 快速开始

前置准备

> 注意:原始 HTML 文档需要从 Steam 安装目录获取(由于版权原因,本仓库不包含原始文档)

API 文档位置:\Steam\steamapps\common\Arma Reforger Tools\Workbench\docs

将 ArmaReforgerScriptAPIPublic 和 EnfusionScriptAPIPublic 目录复制到项目根目录。

Wiki 页面(可选):
- Wiki 页面来自 Bohemia Interactive Community Wiki
- 由于可能的版权原因,本仓库不包含原始 Wiki HTML 和 JSON 文件
- 如果需要使用 Wiki 功能,请将 Wiki 页面文件放置在 wiki_pages/ 目录中
- 可以使用爬虫工具从 Wiki 网站下载页面

安装步骤

  1. 克隆仓库```bash
    git clone https://github.com/ViVi141/Arma_Reforger_Tools_MCP.git
    cd Arma_Reforger_Tools_MCP

2. **安装依赖**```bash
pip install -e .

或使用 requirements.txt:pip install -r requirements.txt

  1. 构建索引```bash

构建 API 索引

python -m src.parser.build_index

推荐:最快模式(自动检测 CPU/线程,Windows 下自动顺序构建以避免卡死)

python -m src.parser.build_index --api-source both --fast

构建两个 API 来源(自动检测)

python -m src.parser.build_index --api-source both

手动指定:--workers 解析线程/进程数,--index-procs Whoosh 索引进程数

python -m src.parser.build_index --api-source both --workers 8 --index-procs 4

构建 Wiki 索引(如果 wiki_pages 目录存在)

python -m src.parser.build_index --wiki-only

或者同时构建 API 和 Wiki 索引

python -m src.parser.build_index --api-source arma_reforger --include-wiki

> 这个过程可能需要几分钟时间。使用 `--fast` 可自动应用最优设置;Windows 下 `api-source=both` 时自动使用顺序构建以避免卡死。

4. **配置 Cursor**

在 Cursor 的 MCP 配置文件中添加(配置文件位置:`%APPDATA%\Cursor\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.json`):

**自动生成配置**(推荐):```bash
# 方法1: 使用专用脚本(推荐)
python scripts/generate_config.py

# 方法2: 安装后使用命令
arma-reforger-mcp-config

# 方法3: Windows PowerShell 自动写入配置
.\scripts\setup_cursor.ps1

> 虚拟环境说明:脚本会自动检测并使用虚拟环境中的 Python 解释器。

手动配置:```json
{
"mcpServers": {
"arma-reforger-api": {
"command": "python",
"args": ["-m", "src.mcp_server.server"],
"cwd": "你的项目路径",
"env": {
"API_DATA_PATH": "你的项目路径/data",
"LOG_LEVEL": "INFO",
"PYTHONPATH": "你的项目路径"
}
}
}
}


5. **重启 Cursor**

完全关闭并重新打开 Cursor,使配置生效。

## 💡 使用示例

配置完成后,在 Cursor 中可以直接问 AI:

### 基础查询
- **"如何获取玩家的当前武器?"**
- **"BaseWeaponComponent 有哪些方法?"**
- **"查找与武器相关的 API"**
- **"获取 CharacterControllerComponent 的详细信息"**

### Wiki 查询
- **"搜索 Wiki 中关于脚本的内容"**
- **"查找 Wiki 中关于动画编辑器的页面"**
- **"Wiki 中有哪些关于游戏主控的文档?"**

### 代码示例查询
- **"ShowCodeExample 的使用示例"**
- **"获取 BaseWeaponComponent 的代码示例"**
- **"如何创建武器组件?给我代码示例"**
- **"GetWeapon 方法的示例代码"**
- **"查找所有关于玩家控制的代码示例"**

AI 会自动调用相应的工具为你提供准确的 API 信息和代码示例。

### 代码示例功能说明

`get_code_examples` 工具支持:

1. **多来源查找**:从类级别和方法级别查找代码示例
2. **智能匹配**:支持精确匹配和部分匹配类名、方法名
3. **语言过滤**:支持按语言过滤(enforce、c++、all)
4. **上下文信息**:每个示例包含完整的上下文信息(所属类、方法等)
5. **丰富元数据**:示例包含标题、描述、语言类型等信息

**返回格式示例**:```json
{
"api_name": "BaseWeaponComponent",
"examples": [
{
"code": "BaseWeaponComponent weapon = GetWeapon();\nif (weapon) {\n    // 使用武器组件\n}",
"language": "enforce",
"description": "获取武器组件的示例",
"title": "使用示例",
"context": {
"type": "class",
"class_name": "BaseWeaponComponent",
"api_source": "arma_reforger"
}
}
],
"total": 1,
"matched_classes": [...],
"matched_methods": [...]
}

📖 可用工具

工具名称 功能描述 主要参数
search_api 搜索 API(类、方法、属性)和 Wiki 页面,支持自然语言查询 query(必需)、type(支持 wiki)、api_source(支持 arma_reforger_wiki、all)、limit
get_class_info 获取类的详细信息,包括方法、属性、继承关系、代码示例 class_name(必需)、api_source、include_examples
get_function_info 获取方法的详细信息,包括签名、参数、返回值、描述 function_name(必需)、class_name、api_source
find_related_apis 查找相关的 API,包括继承关系、使用关系等 api_name(必需)、api_source、relation_type
get_code_examples 获取代码示例,支持从类和方法中查找,包含完整的上下文信息 api_name(必需)、api_source、language

工具详细说明

get_code_examples - 代码示例工具

功能:
- 从类级别和方法级别查找代码示例
- 支持精确匹配和部分匹配
- 自动检测代码语言(enforce、c++)
- 提取示例的标题、描述和上下文信息

参数:
- api_name(必需):要查找的 API 名称(类名或方法名)
- api_source(可选):API 来源,可选值:"arma_reforger"、"enfusion"、"both"(默认)
- language(可选):代码语言过滤,可选值:"enforce"(默认)、"c++"、"all"

使用场景:
- 查找特定类的使用示例
- 查找特定方法的调用示例
- 学习 API 的最佳实践
- 获取代码模板和参考实现

📚 文档

  • 📘 安装和使用指南 - 详细的安装和配置说明
  • 🔧 Cursor 集成指南 - Cursor 集成步骤详解
  • 📖 Wiki 集成说明 - Wiki 页面集成和使用指南
  • 🧪 测试文档 - 测试说明和开发指南
  • 📝 更新日志 - 版本更新记录
  • 🌐 ModelScope 页面 - 在 ModelScope 平台上查看和使用

🤝 贡献

欢迎提交 Issue 和 Pull Request!

📄 许可证

AGPL-3.0 license

👤 作者

  • ViVi141 - GitHub
  • 邮箱: 747384120@qq.com
  • 仓库: https://github.com/ViVi141/Arma_Reforger_Tools_MCP
  • ModelScope: https://modelscope.cn/mcp/servers/ViVi141/Arma_Reforger_Tools_MCP

提示:如果遇到问题,请查看 安装指南 或提交 Issue。

常见问题

8 问
答案由本站依据条目字段整理,不引用上游原文
Arma Reforger Tools MCP 怎么安装?

在客户端按下面的安装命令接入:pip install -e .。装完在客户端配置里引用同一个包或端点。

Arma Reforger Tools MCP 怎么在 Claude、Cursor 里配置?

它的传输方式是stdio · 本地进程,在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,配置才会生效。

Arma Reforger Tools MCP 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

Arma Reforger Tools MCP 需要 API Key 吗?

资料标注为无需认证,装好就能连;如果实际调用时报鉴权错误,按官方文档补上凭据。

Arma Reforger Tools MCP 支持哪些客户端?

资料标注支持 Claude、Cursor;其他客户端只要能配置 MCP Server,也能用同样的命令或地址接入。

Arma Reforger Tools MCP 能提供哪些能力?

资料显示约 5 个工具;能力标签包括 API文档、Python、Claude。具体工具清单以官方文档为准。

Arma Reforger Tools MCP 需要什么运行环境?

属于本地进程,需要在本机装好运行环境。

Arma Reforger Tools MCP 是本地还是远程?

它是本地进程(stdio),由客户端在本机拉起。传输方式为stdio · 本地进程。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 2026-05-17。