X4CodeSense

io.github.chemodunv0.1.1更新于 Oct 3, 2026

X4: Foundations scripts: checks, schema elements, expression types, scripts, cues and texts.

已验证STDIO仅桌面Developer ToolsFiles & Storage

概览

AI 生成的概览

让助手依据游戏自身的架构与文件,检查、查询并校验 X4: Foundations 的 Mission Director 与 AI 脚本。

功能
它提供对 X4: Foundations 脚本数据的只读工具:check 找出脚本文件中的问题并给出快速修复,describe_element 返回元素的文档、属性、类型与允许的子元素,expression_type 解析表达式关键字与数据类型,find 搜索脚本、cue 与库,definition 和 references 定位或列出名称的使用位置,text 按 page 与 id 返回游戏文本,status 报告已读取的内容。回答为 JSON,每次调用都会记录到标准错误。
适用场景
当助手编写或修改 X4: Foundations 的 Mission Director 或 AI 脚本,需要查阅游戏架构与脚本属性而不是靠猜测时,适合添加;也适合在每次改动后运行检查。主要面向处理游戏脚本文件的模组与扩展作者。
运行要求
通过 npx 以 stdio 在本地运行,需要 Node.js 22 或更高版本。必须指向已安装的游戏目录(X4_GAME 或 --game)、解包后的游戏文件(X4_UNPACKED 或 --unpacked),可选扩展目录(--extensions);另有语言与结构相关选项。未声明身份验证。X4CodeSense VS Code 扩展可自动提供该服务器。
安装前请注意
这些工具只读取游戏与扩展文件,写文件由助手自己完成,因此脚本改动来自助手而非该服务器。它会读取游戏安装目录以及你指定的扩展目录,并把每次调用的工具、参数、时间和回答大小记录到标准错误,客户端会显示这些日志。与 VS Code 扩展同时安装可能启动第二个副本。

安装

在 SourceWeft 中

  1. 打开 控制台中的 X4CodeSense,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

x4-script-mcp

MCP server for X4: Foundations scripts (AI scripts and Mission Director scripts), built on x4-script-core. It gives AI agents that write scripts what the X4CodeSense VS Code extension knows from the game's own files: the checks with their quick fixes, the elements and attributes of the schemas, the types and properties of expressions, the scripts, cues and texts of the game, its DLCs and the extensions. Its tools only read; the agent writes the files.

The X4CodeSense extension brings it along and offers it to VS Code's agents (Copilot's agent mode) on the game files and extensions set in its settings, with nothing to set up. Other agents start it from npm:

powershell
# Claude Codeclaude mcp add x4 -- npx -y x4-script-mcp --game "C:\Games\X4 Foundations" --extensions C:\mods
json
{  "mcpServers": {    "x4": {      "command": "npx",      "args": ["-y", "x4-script-mcp", "--unpacked", "C:\\X4\\extracted", "--extensions", "C:\\mods"]    }  }}

The second is the configuration of Claude Desktop, Cursor and others that take one in that form. It needs Node.js 22 or later. It is also in the MCP Registry as io.github.chemodun/x4-script-mcp, which catalogs such as VS Code's MCP server gallery read; with the X4CodeSense extension installed there is no need to add it from there, which would run a second copy.

Agents use the tools they are told about: say in your agent's instructions (CLAUDE.md, .github/copilot-instructions.md, AGENTS.md) to ask describe_element and expression_type before writing an element or an expression, rather than searching the game's .xsd files and scriptproperties.xml, and to run check after every change to a script. Each call is logged on standard error, which clients show as the server's log: the tool, its arguments, the time and the size of the answer.

Options:

  • --game <folder> - the installed game, the folder of X4.exe. Its files and those of its DLCs are read from their catalogs where they lie: nothing is extracted. Used when --unpacked is not given.
  • --unpacked <folder> - the extracted vanilla game files, the folder holding libraries, md, aiscripts and t.
  • Without --game and --unpacked, the X4_UNPACKED environment variable gives the extracted files, else X4_GAME the installed game; either option given wins over both variables.
  • --extensions <folder> - an extension, or a folder of extensions: those the agent writes and those they refer to. Their scripts and texts are read besides the game's. May be given several times; without it, the current folder.
  • --language <number> - the language texts are shown in, 44 (English) by default; the game's libraries/languages.xml lists the numbers.
  • --no-structure - report unknown elements, attributes and values, missing required attributes and text inside elements only, not the order and completeness of child elements.
  • --no-type-guesses - type variables only by what the scripts and the schemas state, not by guesses from the names and documentation of actions (create_ship a ship).
  • -h, --help - usage.

The game files are read on the first call, a few seconds. The extensions' files are watched: a script or text file the agent writes, changes or deletes is read again before the next call, and a file a call names is always taken as it is on disk. An extension added, or a content.xml changed, reads them all again.

Tools

Lines and columns count from 1, columns in UTF-16 code units, as editors count them. A place is given as file, line, column, endLine, endColumn, with text, the line it is on, and game: true for a file of the game or a DLC, which may lie in the catalogs only. Answers are JSON; a tool that cannot answer says why, as an error.

  • check - paths: files and folders; text: what to check instead of the one file in paths as it is on disk; severity: the least severe finding to report. A folder is checked as x4-script-check checks it: the md, aiscripts and libraries folders in it and one level deeper. The findings with their quick fixes (edits that do not overlap, preferred for the one an editor applies on its own), in the shape of the checker's JSON, and their counts.
  • describe_element - name, script (md or aiscripts), parent for an element declared differently in different places (param, actions), attribute for one attribute in full. The element's documentation, its attributes with their types, whether they are required, their defaults, whether the value is an expression, and the first of their allowed values (all, with their documentation, for one attribute in full); the child elements it allows. For a name the schema does not know, similar ones.
  • expression_type - expression, a keyword and its properties such as player.ship.sector, or datatype, such as ship; script; filter. Each step with what it resolved to, its type and description; the datatype of the result with its supertypes, and its properties as name → type, with how many those of the types derived from it add. With filter, the properties whose names contain it, those of the derived types too, with their descriptions. A variable has no type here: the step after it is matched against every datatype's properties.
  • find - query, limit. Mission Director scripts, AI scripts, cues, libraries and interrupt library items by name: whole names first, then those that start with the query, then those that contain it; a query with a dot matches qualified names, md.Setup.Start.
  • definition, references - file, line, column. Where what is named there is defined, or every place that names it, in the game, its DLCs and the extensions: cues, scripts, libraries, labels, variables, orders, texts; a definition also in the schemas and scriptproperties.xml.
  • text - page and id, or page alone for its texts, or search for the texts that hold all its words; language, limit. The text as the game shows it, references resolved, and as it is written when that differs, with the file it comes from and the languages it exists in.
  • status - the game folder, the extension folders, how many scripts and texts were read, and the problems met reading them.

Part of X4CodeSense. Apache License 2.0.

来源:packages/mcp/README.md,提交 08a4e7b

工具

0
工具元数据尚未被收录。

版本历史

1
  1. v0.1.1最新Oct 3, 2026