LikeC4

@likec4/mcp

文档

用法

{
  "mcpServers": {
    "likec4": {
      "command": "npx",
      "args": [
        "-y",
        "@likec4/mcp"
      ],
      "env": {
        "LIKEC4_WORKSPACE": "${workspaceFolder}"
      }
    }
  }
}

此软件包使用 stdio 传输方式启动 MCP 服务。

如果未设置 LIKEC4_WORKSPACE 环境变量，则使用当前目录作为工作区。

作为 CLI 使用

全局安装（或使用 npx）：

npm install -g @likec4/mcp
likec4-mcp -h

USAGE `likec4-mcp [OPTIONS] [WORKSPACE]`

ARGUMENTS

  `WORKSPACE="."`    change workspace, defaults to current directory, can be set by LIKEC4_WORKSPACE env    <directory>

OPTIONS

          `--stdio`    use stdio transport (this is default)
           `--http`    use streamable http transport
  `--port=<number>`    change http port (default: 33335)
       `--no-watch`    disable watch for changes (consume less resources if you have static workspace)

可用工具

• list-projects：列出工作区中的所有 LikeC4 项目。
• read-project-summary：项目规范、配置、所有元素、部署节点和视图。
• search-element：按 ID／标题／描述／链接，在所有项目中模糊搜索元素和部署节点，并按相关性排序；可组合使用按类型／形状／标签／元数据进行的精确筛选。
• read-element：读取完整的元素详情，包括关系、includedInViews、deployedInstances、metadata 和 sourceLocation。
• read-deployment：读取部署节点或已部署实例的详情。
• read-view：读取完整的视图详情（节点／边）和 sourceLocation。
• render-view：将视图渲染为交互式图表（平移／缩放／适配），并内嵌显示在聊天中，适用于支持 MCP Apps 的宿主。
• preview-view：使用 DSL 文本定义 LikeC4 视图，并基于现有项目中的实际元素渲染预览，无需写入磁盘；可用于迭代视图，然后再正式创建或编辑。
• find-relationships：查找项目中两个元素之间的直接和间接关系。
• query-graph：查询元素层级（祖先、后代、同级元素、子元素、父元素）和关系（入向、出向）。
• query-incomers-graph：获取所有上游依赖项／生产者的完整图（递归查询入向关系）。
• query-outgoers-graph：获取所有下游使用者／依赖方的完整图（递归查询出向关系）。
• query-by-metadata：按元数据键值对搜索元素和部署节点，支持精确匹配／包含匹配／存在性匹配。
• query-by-tags：使用布尔逻辑（allOf、anyOf、noneOf）按标签搜索元素和部署节点。
• query-by-tag-pattern：使用前缀、包含或后缀匹配模式按标签搜索元素。
• find-relationship-paths：通过有界 BFS 遍历，查找两个元素之间的所有关系链。支持使用 includeIndirect 控制是否包含隐含关系。
• batch-read-elements：在单个请求中读取多个元素的摘要，包括链接和 sourceLocation。
• subgraph-summary：汇总某个元素的后代，包含深度、元数据和关系计数。
• element-diff：比较两个元素，并显示属性、标签、元数据和关系方面的差异。
• removal-impact：报告移除某个元素会连带移除的内容（关系、已部署实例、视图、孤立项、源引用）。
• list-diffs：列出模型差异（diff 块）以及各差异影响的视图。
• open-view：打开 LikeC4 视图（MCP 在编辑器中运行时可用）

MCP 与 LeanIX 桥接／Draw.io

MCP 工具会在工作区中提供解析后的 LikeC4 模型（搜索、图查询、视图）。它们不会生成 @likec4/leanix-bridge 构件、运行 LeanIX 同步或使用 leanix 配置文件导出 Draw.io。如需使用这些术语，请使用 CLI（likec4 gen leanix …、likec4 sync leanix …、likec4 export drawio --profile leanix）以及本仓库中的 Agent Skill 参考文档 bridge-leanix-drawio.md。

获取帮助

我们很乐意帮助你快速上手：

• 加入 Discord 社区 – 这是获取帮助最简单的方式
• GitHub 讨论区 – 提出关于项目的任何问题，或提供反馈

贡献者

成为贡献者

支持开发

LikeC4 是一个采用 MIT 许可的开源项目，其持续开发完全依赖于您的支持。
如果您喜欢这个项目，请考虑提供资金支持，帮助项目不断发展和完善。
您可以通过 OpenCollective 或 GitHub Sponsors 支持我们。

许可证

本项目根据 MIT License 发布