使用说明
战锤MCP
MCP服务器+Foundry VTT模块,让支持MCP的AI客户端与Foundry世界进行交互。
此回购是 WFRP4e聚焦 (战锤幻想角色扮演4e)并运送一个名为Foundry的模块 战锤MCP (id: warhammer-mcp).
血统。 最初源自
adambdooley/foundry-vtt-mcp(麻省理工学院)。这两个历史共享一个合并基础(45b8af2)但自拆分以来,它们一直并行运行——这个代码库中没有合并的上游提交。将其视为兄弟项目,而不是主动分叉。与上游的区别:仅WFRP4e(D&D5e/PF2e/DSA5/Cosmere已删除),专用handlers/Foundry模块中的层,伞形/动作工具模式,统一notify.tsGM反馈通道,cross-doc-fk审计+修复、持久性运行手册、多客户端配置、技能管理。ComfyUI映射生成和WebRTC传输不存在。
- 版本:请参见
package.json/docs/CHANGELOG.md - Foundry兼容性:仅v13(固定)
运作原理
MCP Client (Claude Desktop / Claude Code / VS Code / etc.)
└─ stdio → packages/mcp-server/dist/index.js (MCP wrapper)
└─ TCP 31414 → packages/mcp-server/dist/backend.js (backend)
└─ WebSocket 31415 → Foundry module (in browser)
港口
31414--MCP工具调用(客户端→ 后端)31415--Foundry浏览器模块桥(Foundry→ 后端)
快速启动(从源代码)
1) 安装和构建
npm install
npm run build
2) 安装Foundry模块
您需要Foundry数据文件夹下可用的模块,例如:
<Foundry Data>/Data/modules/warhammer-mcp/
对于本地开发,此仓库包含一个简单的部署脚本:
npm run build:deploy
npm run build:deploy 用途 scripts/deploy-foundry.js,其当前具有硬编码的目标路径。如果您的Foundry数据文件夹不同,请编辑 scripts/deploy-foundry.js (或手动复制模块文件夹)。
部署后,重新加载Foundry页面(F5)并启用 战锤MCP 在你的世界里。
3) 启动后端
您有两个常见的选择:
选项A——生成客户端(大多数MCP客户端)
- 配置您的MCP客户端以运行
node <repo>/packages/mcp-server/dist/index.js. - 包装器将自动生成/附加到后端。
选项B——独立(建议用于始终在线/多客户端)
- 仓库根目录中的Windows便利脚本:
start-mcp.bat/start-mcp.ps1stop-mcp.bat/stop-mcp.ps1status-mcp.bat/status-mcp.ps1
看 README-PERSISTENCE.md 用于持久性runbook(日志、快捷方式、故障排除)。
MCP客户端配置
此存储库包括多个客户端的可复制配置片段:
claude_desktop_config.example.json(克劳德桌面)configs/clients/*(克劳德密码,VS密码复制品,Codex,双子座)
从这里开始:
configs/clients/README.md
验证
连接后,尝试调用世界探测工具:
mcp__foundry-mcp__get-world-info
工具表面(固结后)
API表面有意固结: 96工具 作为基于行动的“伞式”工具实施(例如。 manage-character, journal, rolltable, scene等等)-- 75芯 WFRP4e/铸造工具+ 21条件 module-* 仅在匹配的第三方模块处于活动状态时注册的集成。
权威列表和架构说明位于:
docs/INSTRUCTIONS.mddocs/CHANGELOG.mddocs/TOOL_CONSOLIDATION_PLAN_2.md
仓库布局
packages/
mcp-server/ MCP wrapper + backend (Node)
foundry-module/ Foundry VTT module (browser)
shared/ Shared TS types/schemas
configs/clients/ MCP client config snippets
docs/ Dev notes + system guide
tests/ Vitest tests (skills harness)
test/ Manual test suite docs
关键入口点:
packages/mcp-server/dist/index.js--MCP stdio包装器(客户端执行什么)packages/mcp-server/dist/backend.js--后端进程(独立/持久)
发展
常用命令
npm run build
npm run build:deploy
npm run test
npm run test:skills
npm run lint
npm run typecheck
更改后
- Foundry模块更改:
npm run build:deploy→ 重新装载铸造厂(F5) - MCP服务器更改:
npm run build→ 重新启动MCP客户端(或重新启动独立后端)
更多详情:
docs/INSTRUCTIONS.md
许可证和信用证
麻省理工学院——见 LICENSE.
最初源自 adambdooley/foundry-vtt-mcp (亚当·杜利,麻省理工学院)。保留的上游信贷 package.json contributors.