Nx Mcp

Nx MCP 服务

面向 Nx 的 Model Context Protocol 服务实现。

概述

Nx MCP 服务让大模型能够深入了解单一代码库的结构：项目关系、文件映射、可运行的任务、所有权信息、技术栈、Nx 生成器，甚至 Nx 文档。有了这些上下文，大模型就能生成符合技术栈的代码、了解更改的影响，并精准地修改相互关联的文件。这之所以可行，是因为 Nx 已经了解工作区的更高层架构，而单一代码库将所有相关项目集中在一处。

在我们的博客文章和文档中了解更多。

安装和使用

有两种方式可以使用此 MCP 服务：

a) 通过 nx-mcp 软件包运行

只需通过 npx 或等效的软件包管理器调用 MCP 服务。

以下是一个 mcp.json 配置示例：

{
  "servers": {
    "nx-mcp": {
      "type": "stdio",
      "command": "npx",
      "args": ["nx-mcp@latest"]
    }
  }
}

claude mcp add nx-mcp npx nx-mcp@latest

code --add-mcp '{"name":"nx-mcp","command":"npx","args":["nx-mcp"]}'

{
  "nx-mcp": {
    "command": "npx",
    "args": ["nx-mcp@latest"]
  }
}

请参阅 AI 工具的文档，了解如何注册 MCP 服务。例如，Cursor 或 Claude Desktop 支持 MCP。

如果你想托管服务，而不是通过 stdio 通信，请使用 --transport http，并可选使用 --port（默认值为 9921）。客户端使用 Streamable HTTP 传输，通过 http://localhost:<port>/mcp 连接。它支持多个并发连接，因此不同客户端可以同时连接，并拥有独立会话。已弃用的 SSE 传输（--sse、--transport sse）已被移除。

运行 nx-mcp --help 查看可用选项。

b) 使用 Nx Console 扩展

如果你使用 Cursor，可以直接安装 Nx Console 扩展，它会自动为你管理 MCP 服务。

更多信息：

• 安装 Nx Console
• 配置 Cursor 使用 nx-mcp

精简模式（默认）

默认情况下，Nx MCP 服务以精简模式运行，会隐藏与 AI 工具技能／指令重复的工作区分析工具。对于已通过技能获得等效功能的 AI Agent，这样可以减少工具冗余和上下文窗口占用。

精简模式下会隐藏以下工具：

• nx_available_plugins
• nx_workspace_path
• nx_workspace
• nx_project_details
• nx_generators
• nx_generator_schema

若要禁用精简模式并显示所有工具，请使用 --no-minimal 标志：

npx nx-mcp@latest --no-minimal

可用工具

Nx MCP 服务提供了一套全面的工具，用于与 Nx 工作区交互。

始终可用

• nx_docs：返回与用户关于 Nx 的查询相关的文档章节
• nx_current_running_tasks_details：列出当前运行的 Nx TUI 进程及任务状态
• nx_current_running_task_output：返回特定运行中任务的终端输出
• nx_visualize_graph：可视化 Nx 图（需要正在运行的 IDE 实例）

最小模式下隐藏（使用 --no-minimal 启用）

• nx_available_plugins：列出核心团队提供的 Nx 插件和本地工作区插件
• nx_workspace_path：返回 Nx 工作区根目录的路径
• nx_workspace：返回项目图和 nx.json 配置的可读表示
• nx_project_details：以 JSON 格式返回指定项目的完整配置
• nx_generators：返回与用户查询相关的生成器列表
• nx_generator_schema：返回特定 Nx 生成器的详细 JSON 架构

Nx Cloud 工具（仅在启用 Nx Cloud 时可用）

这些工具可帮助你了解并与 Nx Cloud CI/CD 数据交互：

• ci_information：检索当前分支或指定 Nx Cloud URL 的 CI 流水线执行信息。返回包含 runId 元数据的失败任务，并支持使用 select 参数选择字段及进行分页。
• ci_task_output：使用 ci_information 中的 runId，或根据分支 / URL 上下文解析 runId，检索特定失败 CI 任务的终端输出。
• update_self_healing_fix：应用、拒绝或请求重新运行来自 Nx Cloud 的自愈 CI 修复

未指定工作区路径时，仅提供 nx_docs 和 nx_available_plugins 工具。

可用资源

连接到启用了 Nx Cloud 的工作区后，Nx MCP 服务会自动将近期 CI 流水线执行（CIPE）公开为 MCP 资源。 这些资源会显示在 AI 工具的资源选择器中，让大模型能够访问 CI 运行的详细信息，包括失败任务、终端输出和受影响的文件。

贡献与开发

欢迎贡献！更多详情，请参阅 Nx Console 贡献指南。

基本步骤如下：

1. 克隆 Nx Console 仓库，并按照安装步骤操作
2. 使用 nx run nx-mcp:build 构建 nx-mcp（调试时可使用 nx run nx-mcp:build:debug 生成源映射）
3. 使用 MCP Inspector 测试你的更改

配置文件

你也可以通过工作区根目录中的 .nx/nx-mcp-config.json JSON 文件配置 MCP 服务。当 MCP 服务二进制文件由插件或扩展管理，无法直接传入 CLI 参数时，这种方式会很有用。

{
  "tools": ["nx_docs", "!cloud_*"],
  "minimal": true,
  "debugLogs": false,
  "disableTelemetry": true,
  "transport": "http",
  "port": 9922
}

所有键均为可选项，且与 CLI 选项名称一致。CLI 参数优先于配置文件中的值。

许可证

MIT