TypeScript Nx Plugin

統合されたModel Context Protocol (MCP)サーバーを備えた完全なTypeScript Nx Pluginを生成します。このジェネレーターは、AIアシスタントによる自動コード生成とプロジェクトスキャフォールディングにシームレスに使用できるカスタムジェネレーターを構築するための基盤を作成します。

使用方法

Nxプラグインを生成する

TypeScript Nxプラグインは2つの方法で生成できます：

このジェネレーターを実行@aws/nx-plugin:ts#nx-plugin

CLI
VSCode

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

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

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

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

インストール Nx Console VSCode Plugin まだインストールしていない場合
VSCodeでNxコンソールを開く
クリック Generate (UI) "Common Nx Commands"セクションで
検索 @aws/nx-plugin - ts#nx-plugin
必須パラメータを入力
クリック Generate

コマンドを組み立てる4

name必須

オプション

ジェネレーターオプション4 オプション

name必須string: TypeScriptプロジェクト名
directorystringデフォルト: packages: ライブラリが配置される親ディレクトリ
subDirectorystring: ライブラリが配置されるサブディレクトリ。デフォルトではライブラリ名になります。
preferInstallDependenciesbooleanデフォルト: true: ジェネレーター実行後に依存関係のインストールを優先するかどうか。複数のジェネレーターをバッチ処理する際にインストールを延期する場合は false に設定します（後続のジェネレーターが Nx プロジェクトグラフを計算できるよう、必要に応じてインストールは実行されます）。最後に一度だけインストールします。

ジェネレーターの出力

ジェネレーターは以下のプロジェクト構造を作成します：

Directoryyour-plugin/
- Directorysrc/
  - index.ts Entry point for your plugin
  - Directorymcp-server/
    index.ts Exports your server
    server.ts Main MCP server configuration
    stdio.ts Entry point for your MCP server with STDIO transport
    http.ts Entry point for your MCP server with Streamable HTTP transport
    schema.ts Shared schemas for the MCP server’s tools
    utils.ts Utility functions for the MCP server
    Directoryresources/
    GENERAL_GUIDANCE.md Guidance served by the general-guidance tool
    Directorytools/
    create-workspace-command.ts Tool for workspace creation guidance
    general-guidance.ts Tool for general Nx and plugin guidance
    list-generators.ts Tool to list available generators
    generator-guide.ts Tool for detailed generator information
- generators.json Nx generator configuration (initially empty)
- package.json Plugin package configuration
- project.json Nx project configuration with build and package targets
- tsconfig.json TypeScript configuration, referencing the two below
- tsconfig.lib.json TypeScript configuration for your plugin’s source
- tsconfig.spec.json TypeScript configuration for your plugin’s tests
- vitest.config.mts Vitest configuration for your plugin’s tests
- README.md Documentation for your plugin, served by the generator-guide tool
- LICENSE Written by the license generator’s sync, when configured

Nxプラグインの操作

ジェネレーターの追加

プラグインプロジェクトを作成したら、ts#nx-generatorジェネレーターを使用してジェネレーターを追加できます：

このジェネレーターを実行@aws/nx-plugin:ts#nx-generator

CLI
VSCode

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

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

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

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

インストール Nx Console VSCode Plugin まだインストールしていない場合
VSCodeでNxコンソールを開く
クリック Generate (UI) "Common Nx Commands"セクションで
検索 @aws/nx-plugin - ts#nx-generator
必須パラメータを入力
クリック Generate

コマンドを組み立てる5

project必須

name必須

description

プロジェクトターゲット

生成されたプラグインには、いくつかの重要なターゲットが含まれています：

ビルドターゲット

TypeScriptコードをコンパイルし、プラグインを使用できるように準備します：

pnpm nx build your-plugin

yarn nx build your-plugin

npx nx build your-plugin

bunx nx build your-plugin

パッケージターゲット

NPM公開用の配布可能なパッケージを作成します：

pnpm nx package your-plugin

yarn nx package your-plugin

npx nx package your-plugin

bunx nx package your-plugin

パッケージターゲットには、必要なすべてのアセットが含まれます：

コンパイルされたJavaScriptファイル
TypeScript宣言ファイル
公開されたプラグインからNxが読み取るgenerators.json、executors.json、migrations.jsonマニフェスト
ドキュメントとライセンスファイル

MCPサーバーの統合

プラグインはts#mcp-serverジェネレーターを使用してMCPサーバーを設定します。

ツール

プラグインには、AIアシスタントに以下のツールを提供する完全なMCPサーバーが含まれています：

general-guidance: Nxとプラグインでのベストプラクティスを取得
create-workspace-command: プラグインを使用できる新しいワークスペースの作成方法を学習
list-generators: プラグイン内の利用可能なすべてのジェネレーターをリスト
generator-guide: スキーマと使用方法を含む特定のジェネレーターに関する詳細情報を取得

AIアシスタントでの設定

設定ファイル

MCP をサポートするほとんどの AI アシスタントは、同様の設定アプローチを使用します。MCP サーバーの詳細を含む設定ファイルを作成または更新する必要があります：

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

ホットリロード

MCP サーバーを開発している間、AI アシスタントが常に最新バージョンのツール/リソースを認識できるように --watch フラグを設定することをお勧めします：

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

アシスタント固有の設定

特定の AI アシスタントで MCP を設定するには、以下のドキュメントを参照してください：

MCPサーバーのカスタマイズ

server.tsを変更して、プラグインのドメインに固有の追加のツールやリソースを追加することで、MCPサーバーを拡張できます。

MCPサーバーの記述の詳細については、ts#mcp-serverガイドを参照してください。

プラグインの公開

公開の準備

パッケージ情報の更新: プラグインのpackage.jsonを適切な名前、バージョン、説明、リポジトリ情報で編集します。また、"private": trueを削除してください。
パッケージのビルド:
- pnpm
- yarn
- npm
- bun
Terminal window
pnpm nx package your-plugin
Terminal window
yarn nx package your-plugin
Terminal window
npx nx package your-plugin
Terminal window
bunx nx package your-plugin
パッケージはdist/<your-plugin's project root>/packageに配置されます。--name=nx-plugin --directory=toolsで生成されたプラグインの場合、それはdist/tools/nx-plugin/packageです。
ローカルでのテスト: 別のワークスペースにインストールすることで、プラグインをローカルでテストできます：
Terminal window
```
npm install /path/to/your/workspace/dist/tools/nx-plugin/package
```

NPMへの公開

プラグインの準備ができたら：

cd dist/tools/nx-plugin/package
npm publish

公開されたプラグインの使用

公開後、他のユーザーがプラグインをインストールして使用できます：

pnpm add -w your-plugin-name

yarn add your-plugin-name

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

bun add your-plugin-name

次に、ジェネレーターを使用します：

このジェネレーターを実行your-plugin-name:your-generator-name

CLI
VSCode

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

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

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

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

インストール Nx Console VSCode Plugin まだインストールしていない場合
VSCodeでNxコンソールを開く
クリック Generate (UI) "Common Nx Commands"セクションで
検索 your-plugin-name - your-generator-name
必須パラメータを入力
クリック Generate

公開されたプラグインでAIアシスタントを設定する

公開されたプラグインのMCPサーバーは、次のように設定できます：

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