FFXIVClientStructs搜索工具

一个MCP服务器,索引FFXIVClientStructs C#库并作为可搜索工具暴露给任何MCP兼容的AI助手,适用于编写Dalamud插件。

  • by MelkyWay
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 MelkyWay/mcp-xiv-clientstructs

使用说明

mcp-xiv客户端结构

索引的MCP服务器 FFXIV客户端结构 C#库,并将其作为任何兼容MCP的AI助手的可搜索工具公开。写作时有用 达拉古德 插件。

工具

工具 说明
search_types 按名称或命名空间搜索类型--返回简短结果(无字段/方法)
get_type 完整类型定义:具有偏移量、方法、大小、继承的字段
list_namespaces 所有可用命名空间
get_namespace 命名空间中的所有类型(简短)
refresh 快跑 git pull 如果SHA发生变化,请在回购上重建索引

环境变量

变量 描述
FFXIV_STRUCTS_REPO 本地克隆的路径 FFXIV客户端结构
FFXIV_STRUCTS_INDEX 服务器写入其数据的路径 index.json 缓存(不需要事先存在)

两者都是必需的。如果缺少任何一个,服务器将在启动时退出。

设置

1.在某处克隆FFXIVClientStructs:

git clone https://github.com/aers/FFXIVClientStructs.git /path/to/ffxiv_clientstructs_repo

2.安装和构建:

npm install
npm run build

3.添加到MCP主机的配置中:

{
  "mcpServers": {
    "ffxiv-structs": {
      "command": "node",
      "args": ["/path/to/mcp-xiv-clientstructs/dist/index.js"],
      "env": {
        "FFXIV_STRUCTS_REPO": "/path/to/ffxiv_clientstructs_repo",
        "FFXIV_STRUCTS_INDEX": "/path/to/mcp-xiv-clientstructs/index.json"
      }
    }
  }
}

首次启动时,索引会自动构建(约2-5秒)。后续启动会立即加载缓存的索引,除非仓库SHA发生了变化。

保持最新

每次启动时,服务器都会将仓库的当前git SHA与缓存的索引进行比较。如果它们不同(例如,因为你从外部拉),它会自动重建。

这 refresh 该工具无需重新启动即可一步完成此操作:它运行 git pull 如果SHA发生变化,则重新构建索引。游戏补丁后打电话很有用。