nx助手
Nx MCP服务器为大型语言模型(LLMs)提供了对您的单体代码库的全面洞察:项目依赖关系、文件关联、可执行任务、所有权元数据、技术栈、自定义生成器以及Nx文档。这种深入的上下文使LLMs能够生成与您的架构完美对齐的代码。
服务介绍
Nx MCP 服务器
概览
Nx MCP 服务器使大语言模型(LLMs)能够深入访问您的单体仓库结构:项目关系、文件映射、可运行任务、所有权信息、技术栈、Nx 生成器,甚至 Nx 文档。有了这些上下文,LLMs 可以根据您的技术栈生成代码,理解变更的影响,并精确地在关联文件中应用修改。这之所以可能是因为 Nx 已经理解了工作区的高层次架构,而单体仓库将所有相关项目集中到了一个地方。
安装与使用
有两种方式可以使用此 MCP 服务器:
a) 通过 nx-mcp 包运行
只需通过 npx 或者您包管理器的等效命令来调用 MCP 服务器即可。
这里是一个 mcp.json 配置示例:
{
"servers": {
"nx-mcp": {
"type": "stdio",
"command": "npx",
"args": ["nx-mcp@latest", "/path/to/your/workspace"]
}
}
}
对于 VSCode 用户,您还可以运行:
code --add-mcp '{"name":"nx-mcp","command":"npx","args":["nx-mcp", "/path/to/your/workspace"]}'
请参考您所使用的 AI 工具文档了解如何注册 MCP 服务器。例如,Cursor 或 Claude Desktop 支持 MCP。
如果您希望托管服务器而不是通过 stdio 进行通信,您可以使用 --sse 和 --port 标志。请注意,目前 Nx MCP 服务器只支持单个并发连接,因此同时连接多个客户端在某些情况下可能会出现问题。
运行 nx-mcp --help 查看可用选项。
b) 使用 Nx 控制台扩展
如果您正在使用 Cursor,可以直接安装 Nx 控制台扩展,它会自动为您管理 MCP 服务器。
更多信息:
可用工具
当前,Nx MCP 服务器提供了一组工具。资源、根目录和提示尚不支持。
- nx_workspace: 返回本地 nx 配置及项目图的注解表示。
- nx_project_details: 返回特定 nx 项目的完整项目配置。
- nx_docs: 根据用户查询检索相关的文档部分。
- nx_generators: 返回工作区中可用的生成器列表。
- nx_generator_schema: 提供特定生成器的详细模式信息。
- nx_available_plugins: 从 npm 注册表返回带有描述的可用 Nx 插件列表。
当未指定工作区路径时,只有 nx_docs 和 nx_available_plugins 工具是可用的。
贡献与发展
欢迎贡献!详情请见 Nx 控制台贡献指南。
基本步骤包括:
- 克隆 Nx Console 仓库 并按照安装步骤进行
- 使用
nx run nx-mcp:build构建nx-mcp(或者使用nx run nx-mcp:build:debug以带有源映射的方式调试) - 使用 MCP Inspector 测试你的更改