# @siemens/ix-mcp 中文文档

规范地址：https://npmcn.com/package/%40siemens/ix-mcp/

版本：5\.3\.0-v\.2\.0\.3
npm 元数据更新时间：2026-11-02T10:25:37.114Z
中文译文更新时间：2026-11-02T12:18:03.473Z
软件包许可：MIT

本文由上游 README 机器翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40siemens/ix-mcp
原文对照：https://npmcn.com/package/%40siemens/ix-mcp/?lang=original
源码仓库：https://code.siemens.com/ux/sdl-mcp

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：12.3 MB，53 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：13 个
- 首次发布：2025-11-13T14:25:57.112Z
- 最新版本发布：2026-10-13T02:51:37.289Z
- 已发布版本数：139（近 12 个月 139 个）

## 中文简介

iX MCP服务器

## 安装

```sh
npm install @siemens/ix-mcp
```

也可以使用：`pnpm add @siemens/ix-mcp`、`yarn add @siemens/ix-mcp`、`bun add @siemens/ix-mcp`

## README

# 西门子MCP服务器用于iX Web组件

模型上下文协议（MCP）服务器，为AI助手（agent）提供访问权限 [西门子工业经验](https://ix.siemens.io/) 设计系统和组件API文档 通过检索增强生成（RAG）。这使援助更加准确和相关 与设计系统和组件库api。

## 用法和用例

-   本地MCP服务器安装包括所有设计系统文档，组件api，示例 还有图标信息
-   MCP服务器集成与您的AI代理设置的选择，集成到您的IDE(例如， 在VS Code或OpenCode中集成GitHub Copilot Agent，与项目相关的MCP 配置)
-   用例包括（但不限于）：
    -   获取设计系统最佳实践信息
    -   导出组件
    -   根据用户体验写作指南审查项目文本
    -   使用设计系统组件生成新页面
    -   添加和修改页面

## 安装

### 先决条件

-   Node.js（推荐22+）
-   访问API [https://api.siemens.com/llm](https://api.siemens.com/) 通过创建一个免费令牌 在 [https://my.siemens.com](https://my.siemens.com/) 与 `llm` 范围。我们使用 `embeddings` API。西门子接入系统 需要请求令牌。我们正在研究一种可配置的替代方案。
-   IDE/Agent/LLM设置（例如：VS Code， GitHub Copilot, Claude Sonnet 4.5）

> **警告:** 不再支持基于英特尔的Mac电脑。

### 版本选择

我们发布了一个MCP服务器包 `@siemens/ix-mcp` 对于每一个 `@siemens/ix` 的版本。的版本 `@siemens/ix-mcp` 必须匹配你的版本 `@siemens/ix`． MCP包的版本号 `@siemens/ix-mcp` 是组合的吗 `@siemens/ix` 版本和MCP代码的版本。

例如, `@siemens/ix-mcp@4.0.0-v.1.4.8` 的数据 `@siemens/ix@4.0.0` 和 `v.1.4.8` 为MCP脚本版本。

为了方便版本选择，我们使用 [NPM发布标签](https://docs.npmjs.com/cli/commands/npm-dist-tag) `@ix<version>` 相匹配的 的版本 `@siemens/ix`． 在安装时使用相应的发行版标签时，您将得到 最新版本的MCP包与您的 `@siemens/ix` 版本化和简化 处理方式 `package.json`.

```json
"dependencies": {
    "@siemens/ix": "4.0.0",
  },
  "devDependencies": {
    "@siemens/ix-mcp": "4.0.0-v.1.4.8",
  }
```

新的MCP包版本相同 `ix` 版本是递增的 `4.0.0-v.1.4.9`， `4.0.0-v.1.4.10`， `4.0.0-v.1.5.0`.

### 项目安装

```bash
npm install --save-dev --save-exact @siemens/ix-mcp@ix4.0.0

# Or with yarn
yarn add -D --exact @siemens/ix-mcp@ix4.0.0
```

### 全球安装

```bash
npm install -g @siemens/ix-mcp@ix4.0.0
```

### 升级

只需重新为你的版本和框架安装标签：

```bash
# in project
npm install --save-dev --save-exact @siemens/ix-mcp@ix4.1.0

# with yarn
yarn add -D --exact @siemens/ix-mcp@ix4.1.0

# global
npm install -g --save-exact @siemens/ix-mcp@ix4.1.0
```

## 快速入门

本地工程或全局包安装完成后，需要对MCP服务器进行初始化 提供访问令牌。

1.  **导航到您的项目目录**：
    
    ```bash
    cd your-project
    ```
    
2.  **运行初始设置**：
    
    ```bash
    npx @siemens/ix-mcp init
    ```
    
    或者如果token已经设置：
    
    ```bash
    npx @siemens/ix-mcp setup
    ```
    
    > 重要提示：在要使用MCP服务器的每个项目的根目录下运行此命令。
    
3.  **按照提示操作**：
    
    -   输入您的LLM令牌 [https://my.siemens.com/](https://my.siemens.com/) （需要‘llm’作用域）
    -   该标记用于生成文档语义搜索的嵌入。这个 嵌入可以帮助找到相关的文档块，但是实际的LLM（语言模型）无法找到 处理您的查询并生成响应是由您的人工智能工具(例如， GitHub Copilot， Claude等)
    -   选择要配置的工具（VS Code, Claude Code， Zed等）
    -   可选地为AI代理设置iX指令文件
    -   该工具将根据您的选择创建MCP配置文件，提交本地 配置来共享它(确保它没有被 `.gitignore`）
4.  **重启你的AI工具** （VS Code, Claude Code， Zed等）
    
    -   确保服务器正在运行并信任MCP服务器，例如，单击 vscode中的Github Copilot聊天面板。
    -   **为GitHub Copilot在VS Code**：请确保您处于座席模式（不是聊天模式）。使用模型 就像 **克劳德十四行诗4.5**.
5.  **开始促使**：
    
    -   “我如何使用@siemens/ix的搜索组件？”
    -   “请举例说明@siemens/charts-ng的用法”
    -   “实现带有不同小部件的仪表板”
    -   “查找与人工智能或机器学习相关的图标”
    -   “回顾这个项目的文本”

> 当你的AI工具需要MCP服务器时，它会自动启动。

## 设置选项

在 `init` 或者 `setup`，选择要创建的配置：

-   **本地VS Code / GitHub Copilot （Repository）** 创建一个VS Code MCP配置文件 `.vscode/mcp.json` 在当前存储库中
-   **OpenCode(库)** 创建 `opencode.json` 在OpenCode AI的当前存储库中
-   **OpenCode全局设置** 更新全局OpenCode配置 （`~/.config/opencode/opencode.json`）
-   **Claude Code全局设置** 更新全局Claude Code MCP配置
-   **VS Code / GitHub Copilot全局配置** 写入用户级MCP配置
-   **Zed全局设置** 配置Zed编辑器/代理MCP

## AI Agent说明（可选）

配置MCP后，您可以设置iX指令文件，以便AI代理更有效地使用 你的代码库。在每个需要指示的存储库中执行此操作。

你有两个选择：

-   **接收更新的符号链接**  
    保持文件与安装包同步。要求软件包保持安装状态，并且可以 不能在所有系统或包管理器上工作。该工具可以自动创建符号链接； 否则，自己创建指向已安装包的链接 `AGENTS.md` 第九, 指令。
    
-   **复制内容** 复制包的 `AGENTS.md` 变成下面的一种 你的回购:
    
    -   `.github/instructions/ix.instructions.md`
    -   `AGENTS.md`
    -   `.github/copilot-instructions.md`

如果您喜欢手动拷贝，请打开软件包 `AGENTS.md`，然后将其粘贴到所选文件中，并 提交它。每当您想要更新指令时，就重复每个存储库。

## 日志记录

默认情况下不执行日志记录，但您可以启用所有搜索查询的本地日志记录 设置期间的检索结果。

### 手动启用日志记录

在您的MCP配置中添加标志 `--log` 将所有搜索查询和检索结果记录到 本地日志文件 `~/.ix-mcp`.

```json
{
  "servers": {
    "@siemens/ix-mcp": {
      "type": "stdio",
      "command": "npx",
      "args": ["@siemens/ix-mcp", "--log"]
    }
  }
}
```

### 查看和共享日志

如果需要查看日志，可以使用 `npx @siemens/ix-mcp log` 命令，选择任何相关会话并查看 输出或复制到当前工作目录的文件。

关于MCP和Agent结果的反馈，请创建一个问题 [https://code.siemens.com/ux/sdl-mcp/issues](https://code.siemens.com/ux/sdl-mcp/issues)，分享你的 信息，并包括相关日志。

## 使用

### 命令

#### Init（第一次设置）

完成初始设置：配置令牌并创建所有MCP配置。

```bash
npx @siemens/ix-mcp init
```

#### 设置（更新配置）

为您的工具创建或更新MCP配置文件（使用现有令牌）。

```bash
npx @siemens/ix-mcp setup
```

#### 设置令牌

仅设置或更新系统密钥链中的LLM令牌。

```bash
npx @siemens/ix-mcp setup-token
```

#### 检查

验证您的安装和配置。

```bash
npx @siemens/ix-mcp check
```

#### 测试

使用示例查询测试MCP服务器。

```bash
npx @siemens/ix-mcp test
```

#### 日志

检查以前的MCP检索日志（如果启用/未禁用）。

```bash
npx @siemens/ix-mcp log
```

### 在WSL中使用（Linux的Windows子系统）

如果使用WSL，则需要使用环境变量而不是 系统的钥匙链。在执行任何命令之前，请在a . conf中添加以下内容 `.env` 文件在项目根目录下 （如果你使用的是项目安装）：

```
SDL_MCP_TOKEN_ENV=true
OPENAI_API_KEY=<your-key-here>
```

确保 `.env` 文件在你的 `.gitignore` 而且不能承诺。

或者，如果您正在使用全局安装，请将这些添加到shell配置文件中 （`~/.zprofile` 或者 `~/.bash_profile`):

```bash
export SDL_MCP_TOKEN_ENV=true
export OPENAI_API_KEY=<your-key-here>
```

### 连接问题

-   验证MCP服务器正在运行（它应该自动启动）
-   在配置更改后重新启动AI工具
-   验证您的LLM令牌在 [https://my.siemens.com/](https://my.siemens.com/)

## 手动配置

如果您喜欢手动设置配置，下面是必需的文件及其内容。

### VS Code (.vscode/mcp。json或User/mcp.json)

```json
{
  "servers": {
    "@siemens/ix-mcp": {
      "type": "stdio",
      "command": "npx",
      "args": ["@siemens/ix-mcp"]
    }
  }
}
```

### OpenCode（本地或全局）

对于存储库级配置，请创建 `opencode.json` 在你的项目根目录下：

```json
{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "ix-mcp": {
      "type": "local",
      "command": ["npx", "-y", "@siemens/ix-mcp"],
      "enabled": true
    }
  },
  "instructions": ["iX.instructions.md"]
}
```

对于全局配置，请编辑 `~/.config/opencode/opencode.json`：

```json
{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "ix-mcp": {
      "type": "local",
      "command": ["npx", "-y", "@siemens/ix-mcp"],
      "enabled": true
    }
  }
}
```

了解有关OpenCode配置的更多信息，请参见 [https://opencode.ai/docs/config](https://opencode.ai/docs/config).

### Claude Code（全局Claude Code MCP设置）

```json
{
  "mcpServers": {
    "@siemens/ix-mcp": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@siemens/ix-mcp"],
      "env": {}
    }
  }
}
```

在Windows上，建议使用完整路径 `npx`，例如：

```json
{
  "mcpServers": {
    "@siemens/ix-mcp": {
      "type": "stdio",
      "command": "<path-to-npx, run which/where npx to find>",
      "args": ["-y", "@siemens/ix-mcp"],
      "env": {}
    }
  }
}
```

将OpenCode视为开放的替代方案

OpenCode是Claude Code的开源替代品。它提供了相同的功能集， 更广泛的模型支持，并且通常被认为更稳定。作为一个专有的闭源工具， Claude Code可能不会提供与完全开放的代码相同的透明度和数据处理保证 的选择。请参阅OpenCode文档进行设置。

-   [https://code.siemens.com/ai/opencode/#getting-started](https://code.siemens.com/ai/opencode/#getting-started)
-   [https://open.code.siemens.io](https://open.code.siemens.io/)

### Zed（全局Zed设置）

```json
{
  "context_servers": {
    "@siemens/ix-mcp": {
      "source": "custom",
      "command": "npx",
      "args": ["@siemens/ix-mcp"],
      "env": {}
    }
  }
}
```

## 许可证

以下内容适用于git存储库的代码和文档，除非明确提到。

版权所有西门子2016 - 2025

麻省理工学院,看到 [LICENSE.md](https://npmcn.com/package/%40siemens/ix-mcp/LICENSE.md).

### 开源软件

该分布式MCP npm包的软件由数据库文件和JavaScript文件组成； 提供对数据库的访问，实现模型上下文协议。这个包裹没有 包括任何第三方软件。然而，要使用该软件，您需要开放源代码软件 中指定的包 `dependencies` 部分 [package.json](https://npmcn.com/package/%40siemens/ix-mcp/package.json) 文件，以及他们的 依赖关系。当使用npm包管理器安装这个包时，依赖项是 自动安装（例如，当使用npm时）。

## 支持

有关问题和疑问，请使用问题跟踪器： [https://code.siemens.com/ux/sdl-mcp/issues](https://code.siemens.com/ux/sdl-mcp/issues)

对于次优检索/代理行为，可以考虑附加相关日志来帮助我们弄清楚 如何改进服务，明白吗 [查看和共享日志](https://npmcn.com/package/%40siemens/ix-mcp/#readme-viewing-and-sharing-logs).

## 常见问题

### @siemens/ix-mcp 是什么？

iX MCP服务器

### 如何安装 @siemens/ix-mcp？

在项目目录运行 npm install @siemens/ix-mcp，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 ix-mcp，可以用 npx ix-mcp 直接运行。

### @siemens/ix-mcp 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @siemens/ix-mcp 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @siemens/ix-mcp 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @siemens/ix-mcp 可以商用吗？

@siemens/ix-mcp 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @siemens/ix-mcp 还在维护吗？

最新版本 5\.3\.0-v\.2\.0\.3 发布于 2026/10/13（21 天前）；至今共发布 139 个版本，其中过去 12 个月发布了 139 个；首次发布于 2025/11/13。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。