TypeScript Nx Plugin

Tạo một Nx Plugin TypeScript hoàn chỉnh với máy chủ Model Context Protocol (MCP) tích hợp. Generator này tạo nền tảng để xây dựng các generator tùy chỉnh có thể được sử dụng liền mạch bởi các trợ lý AI để tự động tạo mã và khởi tạo dự án.

Cách sử dụng

Tạo một Nx Plugin

Bạn có thể tạo một Nx Plugin TypeScript theo hai cách:

VSCode

1. Install the Nx Console VSCode Plugin if you haven't already
2. Open the Nx Console in VSCode
3. Click Generate (UI) in the "Common Nx Commands" section
4. Search for @aws/nx-plugin - ts#nx-plugin
5. Fill in the required parameters
6. Click Generate

CLI

pnpm

pnpm nx g @aws/nx-plugin:ts#nx-plugin

yarn

yarn nx g @aws/nx-plugin:ts#nx-plugin

npm

npx nx g @aws/nx-plugin:ts#nx-plugin

bun

bunx nx g @aws/nx-plugin:ts#nx-plugin

You can also perform a dry-run to see what files would be changed

pnpm

pnpm nx g @aws/nx-plugin:ts#nx-plugin --dry-run

yarn

yarn nx g @aws/nx-plugin:ts#nx-plugin --dry-run

npm

npx nx g @aws/nx-plugin:ts#nx-plugin --dry-run

bun

bunx nx g @aws/nx-plugin:ts#nx-plugin --dry-run

Tùy chọn

Parameter	Type	Default	Description
name Required	string	-	TypeScript project name
directory	string	packages	Parent directory where the library is placed.
subDirectory	string	-	The sub directory the lib is placed in. By default this is the library name.

Kết quả của Generator

Generator sẽ tạo cấu trúc dự án như sau:

• Thư mụcyour-plugin/

  • Thư mụcsrc/

    • index.ts Điểm vào rỗng cho plugin của bạn
    • Thư mụcmcp-server/

      • index.ts Xuất máy chủ của bạn
      • server.ts Cấu hình máy chủ MCP chính
      • stdio.ts Điểm vào cho máy chủ MCP của bạn với giao thức STDIO
      • http.ts Điểm vào cho máy chủ MCP của bạn với giao thức Streamable HTTP
      • Thư mụctools/

        • create-workspace-command.ts Công cụ hướng dẫn tạo workspace
        • general-guidance.ts Công cụ hướng dẫn chung về Nx và plugin
        • list-generators.ts Công cụ liệt kê các generator có sẵn
        • generator-guide.ts Công cụ cung cấp thông tin chi tiết về generator
      • utils.ts Các hàm tiện ích cho máy chủ MCP
  • generators.json Cấu hình generator Nx (ban đầu trống)
  • package.json Cấu hình package plugin với binary máy chủ MCP
  • tsconfig.json Cấu hình TypeScript (CommonJS để tương thích với Nx)
  • project.json Cấu hình dự án Nx với các target build và package

Làm việc với Nx Plugin của bạn

Thêm Generator

Sau khi có dự án plugin, bạn có thể thêm các generator bằng cách sử dụng generator ts#nx-generator:

VSCode

1. Install the Nx Console VSCode Plugin if you haven't already
2. Open the Nx Console in VSCode
3. Click Generate (UI) in the "Common Nx Commands" section
4. Search for @aws/nx-plugin - ts#nx-generator
5. Fill in the required parameters
   • pluginProject: your-plugin
6. Click Generate

CLI

pnpm

pnpm nx g @aws/nx-plugin:ts#nx-generator --pluginProject=your-plugin

yarn

yarn nx g @aws/nx-plugin:ts#nx-generator --pluginProject=your-plugin

npm

npx nx g @aws/nx-plugin:ts#nx-generator --pluginProject=your-plugin

bun

bunx nx g @aws/nx-plugin:ts#nx-generator --pluginProject=your-plugin

You can also perform a dry-run to see what files would be changed

pnpm

pnpm nx g @aws/nx-plugin:ts#nx-generator --pluginProject=your-plugin --dry-run

yarn

yarn nx g @aws/nx-plugin:ts#nx-generator --pluginProject=your-plugin --dry-run

npm

npx nx g @aws/nx-plugin:ts#nx-generator --pluginProject=your-plugin --dry-run

bun

bunx nx g @aws/nx-plugin:ts#nx-generator --pluginProject=your-plugin --dry-run

Điều này sẽ thêm một generator mới vào plugin của bạn.

Mẹo

Đọc hướng dẫn ts#nx-generator để biết chi tiết về cách triển khai các generator.

Hãy đảm bảo viết một file README.md chi tiết cho generator của bạn, vì nó được sử dụng bởi công cụ generator-guide của MCP Server.

Các Target của Dự án

Plugin được tạo bao gồm một số target quan trọng:

Target Build

Biên dịch mã TypeScript của bạn và chuẩn bị plugin để sử dụng:

pnpm

pnpm nx build your-plugin

yarn

yarn nx build your-plugin

npm

npx nx build your-plugin

bun

bunx nx build your-plugin

Target Package

Tạo một package có thể phân phối, sẵn sàng để xuất bản lên NPM:

pnpm

pnpm nx package your-plugin

yarn

yarn nx package your-plugin

npm

npx nx package your-plugin

bun

bunx nx package your-plugin

Target package bao gồm tất cả các tài nguyên cần thiết:

• Các file JavaScript đã biên dịch
• Các file khai báo TypeScript
• Các file cấu hình generator và executor
• Các file tài liệu và giấy phép

Tích hợp MCP Server

Plugin cấu hình một máy chủ MCP bằng cách sử dụng generator ts#mcp-server.

Công cụ

Plugin bao gồm một máy chủ MCP hoàn chỉnh cung cấp cho các trợ lý AI các công cụ sau:

• general-guidance: Nhận các phương pháp tốt nhất để làm việc với Nx và plugin của bạn
• create-workspace-command: Tìm hiểu cách tạo workspace mới có thể sử dụng plugin của bạn
• list-generators: Liệt kê tất cả các generator có sẵn trong plugin của bạn
• generator-guide: Nhận thông tin chi tiết về các generator cụ thể bao gồm schema và cách sử dụng

Cấu hình với Trợ lý AI

Tệp Cấu Hình

Hầu hết các trợ lý AI hỗ trợ MCP đều sử dụng phương pháp cấu hình tương tự. Bạn sẽ cần tạo hoặc cập nhật tệp cấu hình với thông tin chi tiết về MCP server của bạn:

{
  "mcpServers": {
    "your-mcp-server": {
      "command": "npx",
      "args": ["tsx", "/path/to/your-mcp-server/stdio.ts"]
    }
  }
}

Chú ý

Nếu bạn nhận được lỗi như ENOENT npx khi kết nối với server của bạn, bạn có thể cần chỉ định đường dẫn đầy đủ đến npx, bạn có thể lấy đường dẫn này bằng cách chạy lệnh which npx trong terminal của bạn.

Hot Reload

Trong khi phát triển MCP server của bạn, bạn có thể muốn cấu hình cờ --watch để trợ lý AI luôn thấy các phiên bản mới nhất của tools/resources:

{
  "mcpServers": {
    "your-mcp-server": {
      "command": "npx",
      "args": ["tsx", "--watch", "/path/to/your-mcp-server/stdio.ts"]
    }
  }
}

Ghi chú

Nếu bạn thêm tools hoặc resources mới, bạn có thể cần làm mới MCP server của bạn trong trợ lý AI.

Cấu Hình Theo Trợ Lý Cụ Thể

Vui lòng tham khảo tài liệu sau để cấu hình MCP với các Trợ Lý AI cụ thể:

• Amazon Q Developer
• Cline
• Cursor
• Claude Code
• Roo Code

Mẹo

Một số Trợ Lý AI, chẳng hạn như Amazon Q Developer, cho phép bạn chỉ định cấu hình MCP server ở cấp độ workspace, điều này đặc biệt hữu ích để xác định các MCP server liên quan cho một dự án cụ thể.

Tùy chỉnh MCP Server

Bạn có thể mở rộng máy chủ MCP bằng cách sửa đổi server.ts để thêm các công cụ hoặc tài nguyên bổ sung cụ thể cho lĩnh vực của plugin bạn.

Để biết thêm chi tiết về việc viết MCP Server, tham khảo hướng dẫn ts#mcp-server.

Xuất bản Plugin của bạn

Chuẩn bị để Xuất bản

1. Cập nhật Thông tin Package: Chỉnh sửa package.json của plugin với tên, phiên bản, mô tả và thông tin repository phù hợp.

2. Build Package:

   pnpm

   pnpm nx package your-plugin

   yarn

   yarn nx package your-plugin

   npm

   npx nx package your-plugin

   bun

   bunx nx package your-plugin

3. Kiểm tra Cục bộ: Bạn có thể kiểm tra plugin của mình cục bộ bằng cách cài đặt nó trong một workspace khác:

   npm install /path/to/your/workspace/dist/your-plugin/package

Xuất bản lên NPM

Khi plugin của bạn đã sẵn sàng:

cd dist/your-plugin/package
npm publish

Sử dụng Plugin đã Xuất bản

Sau khi xuất bản, người khác có thể cài đặt và sử dụng plugin của bạn:

pnpm

pnpm add -w your-plugin-name

yarn

yarn add your-plugin-name

npm

npm install --legacy-peer-deps your-plugin-name

bun

bun install your-plugin-name

Sau đó sử dụng các generator của bạn:

VSCode

1. Install the Nx Console VSCode Plugin if you haven't already
2. Open the Nx Console in VSCode
3. Click Generate (UI) in the "Common Nx Commands" section
4. Search for your-plugin-name - your-generator-name
5. Fill in the required parameters
6. Click Generate

CLI

pnpm

pnpm nx g your-plugin-name:your-generator-name

yarn

yarn nx g your-plugin-name:your-generator-name

npm

npx nx g your-plugin-name:your-generator-name

bun

bunx nx g your-plugin-name:your-generator-name

You can also perform a dry-run to see what files would be changed

pnpm

pnpm nx g your-plugin-name:your-generator-name --dry-run

yarn

yarn nx g your-plugin-name:your-generator-name --dry-run

npm

npx nx g your-plugin-name:your-generator-name --dry-run

bun

bunx nx g your-plugin-name:your-generator-name --dry-run

Cấu hình Trợ lý AI với Plugin đã Xuất bản của bạn

Máy chủ MCP của plugin đã xuất bản có thể được cấu hình như sau:

{
  "mcpServers": {
    "aws-nx-mcp": {
      "command": "npx",
      "args": ["-y", "-p", "your-plugin-name", "your-plugin-name-mcp-server"]
    }
  }
}