Skip to content

Commit 1d5073d

Browse files
Merge pull request #105 from akiojin/bugfix/non-register-tools
fix(docs): complete pnpm to npm migration in Japanese README
2 parents 3f6f72a + f139b54 commit 1d5073d

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

README.ja.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ sequenceDiagram
170170
```
171171

172172
## セットアップ
173-
- 対応バージョン: Unity 2020.3 LTS以降 / Node.js 18.x・20.x・22.x LTS(23 以上のメジャーバージョンでは起動を拒否) / pnpm(Corepack経由で提供)
173+
- 対応バージョン: Unity 2020.3 LTS以降 / Node.js 18.x・20.x・22.x LTS(23 以上のメジャーバージョンでは起動を拒否)
174174
- 推奨は Node.js 20.x または 22.x(`better-sqlite3` の prebuilt バイナリが利用可能)。Node 18.x も動作しますが、23 以上は起動時に拒否されます。
175175
- MCPクライアント: Claude Desktop など
176176

@@ -195,33 +195,32 @@ sequenceDiagram
195195

196196
ネイティブ拡張(`better-sqlite3` など)は **MCPサーバーを動かすOS上で依存関係をインストールしたとき** にのみ正しく構築されます。以下を必ず実施してください。
197197

198-
- **基本ルール**: `.mcp.json` で `"command": "node"`(例: `node bin/unity-mcp-server serve`)を使う場合は、MCPサーバーを動かすマシン/コンテナ内で本パッケージが展開されているディレクトリで `pnpm install`(または `pnpm install --frozen-lockfile`)を実行してから MCP クライアントを起動します。
199-
- **pnpmでのビルド許可**: pnpm v10以降は依存のインストールスクリプトを許可制にしています。`better-sqlite3` がビルドできるよう、初回セットアップ時に `pnpm approve-builds better-sqlite3` を実行し、対話メニューで承認してください。citeturn1view0
198+
- **基本ルール**: `.mcp.json` で `"command": "node"`(例: `node bin/unity-mcp-server serve`)を使う場合は、MCPサーバーを動かすマシン/コンテナ内で本パッケージが展開されているディレクトリで `npm ci` を実行してから MCP クライアントを起動します。
200199
- **`npx` 実行**: README の例(`npx @akiojin/unity-mcp-server@latest`)は起動時に依存をダウンロードします。サポート対象の Node.js(18.x / 20.x / 22.x)では追加作業なしで利用できます。Node.js 23 以上はサポート外であり、サーバー起動時に拒否されます。
201200
- **`node_modules` の共有禁止**: Windows と Linux/macOS など異なるOS間で `node_modules` を共有するとネイティブバイナリが一致せず動作しません。
202201

203202
環境別の注意点:
204203

205204
- **Windows (PowerShell / コマンドプロンプト)**
206205
- Node.js 20.x または 22.x LTS(18.x も利用可)を利用してください。23 以上のメジャーバージョンはサポート外です。
207-
- パッケージが配置されているディレクトリ(リポジトリを clone した場合: `C:\path\to\unity-mcp-server\mcp-server`)で `pnpm install --frozen-lockfile` を実行します。
206+
- パッケージが配置されているディレクトリ(リポジトリを clone した場合: `C:\path\to\unity-mcp-server\mcp-server`)で `npm ci` を実行します。
208207
- `.mcp.json` で `node` を指す場合でも、依存を入れた後であれば `npx` に切り替えても構いません。
209208

210209
- **Windows Subsystem for Linux (WSL)**
211210
- リポジトリは Linux ファイルシステム上(例: `/home/<user>/unity-mcp-server`)に配置してください。
212211
- Node.js 20.x または 22.x(18.x も利用可)を WSL 内に導入します。
213-
- パッケージが展開されているディレクトリ(リポジトリ clone 時: `/home/<user>/unity-mcp-server/mcp-server`)で `pnpm install --frozen-lockfile` を実行します。
212+
- パッケージが展開されているディレクトリ(リポジトリ clone 時: `/home/<user>/unity-mcp-server/mcp-server`)で `npm ci` を実行します。
214213

215214
- **Docker / Linux コンテナ**
216215
- Node.js 20.x または 22.x(18.x も利用可)ベースのイメージを使用してください。23 以上のメジャーバージョンは起動時に拒否されます。
217-
- イメージ構築時に `pnpm install --filter mcp-server --frozen-lockfile`(またはパッケージ展開ディレクトリで `pnpm install --frozen-lockfile`)を実行し、コンテナ内にプラットフォーム適合済みの依存を用意します。
216+
- イメージ構築時に `npm ci --workspace=mcp-server`(またはパッケージ展開ディレクトリで `npm ci`)を実行し、コンテナ内にプラットフォーム適合済みの依存を用意します。
218217
- ホスト側の `node_modules` を bind mount しないでください。
219218

220219
- **macOS**
221220
- `brew install node@22` または `node@20` などで Node.js 22.x / 20.x を導入し、`PATH` に追加します(18.x も利用可)。23 以上のメジャーバージョンはサポートしません。
222-
- パッケージが配置されているディレクトリ(リポジトリ clone 時: `~/unity-mcp-server/mcp-server`)で `pnpm install --frozen-lockfile` を実行します。
221+
- パッケージが配置されているディレクトリ(リポジトリ clone 時: `~/unity-mcp-server/mcp-server`)で `npm ci` を実行します。
223222

224-
セットアップ後、`node mcp-server/bin/unity-mcp-server --version` で起動確認ができます。`better-sqlite3` の読み込みエラーが出る場合は、対象環境内で依存を再インストールするか、ツールチェーンが揃った状態で `pnpm rebuild better-sqlite3 --filter mcp-server --build-from-source` を実行してください。
223+
セットアップ後、`node mcp-server/bin/unity-mcp-server --version` で起動確認ができます。`better-sqlite3` の読み込みエラーが出る場合は、対象環境内で依存を再インストールするか、ツールチェーンが揃った状態で `npm rebuild better-sqlite3 --workspace=mcp-server` を実行してください。
225224

226225
## 使い方ワークフロー
227226

0 commit comments

Comments
 (0)