unity-editor-mcp: Instructions file for Claude Code

AGENTS.md

このファイルは、このリポジトリでコードを扱う際のガイダンスを提供します。

開発指針

🛠️ 技術実装指針

• 設計・実装は複雑にせずに、シンプルさの極限を追求してください
• ただし、ユーザビリティと開発者体験の品質は決して妥協しない
• 実装はシンプルに、開発者体験は最高品質に
• CLI操作の直感性と効率性を技術的複雑さより優先

📝 設計ガイドライン

• 設計に関するドキュメントには、ソースコードを書かないこと

開発品質

完了条件

• エラーが発生している状態で完了としないこと。必ずエラーが解消された時点で完了とする。

開発ワークフロー

基本ルール

• 作業（タスク）を完了したら、変更点を日本語でコミットログに追加して、コミット＆プッシュを必ず行う
• 作業（タスク）は、最大限の並列化をして進める
• 作業（タスク）は、最大限の細分化をしてToDoに登録する
• 作業（タスク）の開始前には、必ずToDoを登録した後に作業を開始する
• 作業（タスク）は、忖度なしで進める

コミュニケーションガイドライン

• 回答は必ず日本語

ドキュメント管理

• ドキュメントはREADME.md/README.ja.mdに集約する

Assets配下の扱い（サンプル/Unityプロジェクト側）

• 目的: サンプル・検証・デモ・手動動作確認用のシーン/プレハブ/補助スクリプトを配置。
• 禁止: unity-editor-mcp 実装本体（ランタイム/エディタ拡張の主要コード）を置かない。UPM配布の対象にも含めない。
• 編集: 必要最小限に留める。C#編集は外部CLIで行い、Assets側は参照/設定のみで成立させる。

バージョン管理

npm versionコマンドの使用

バージョンアップは必ずnpm versionコマンドを使用する：

• パッチバージョン: npm version patch (例: 2.9.0 → 2.9.1)
• マイナーバージョン: npm version minor (例: 2.9.0 → 2.10.0)
• メジャーバージョン: npm version major (例: 2.9.0 → 3.0.0)

重要: package.jsonを直接編集してのバージョン変更は禁止

バージョンアップ手順

1. 変更内容に応じて適切なバージョンコマンドを選択
2. mcp-serverディレクトリで: npm version [patch|minor|major]
3. Unity packageのバージョンも同期して更新（unity-editor-mcp/package.json）
4. git commit & push
5. npm publish

コードクオリティガイドライン

• マークダウンファイルはmarkdownlintでエラー及び警告がない状態にする
• コミットログはcommitlintに対応する

開発ガイドライン

• 既存のファイルのメンテナンスを無視して、新規ファイルばかり作成するのは禁止。既存ファイルを改修することを優先する。

ドキュメント作成ガイドライン

• README.mdには設計などは書いてはいけない。プロジェクトの説明やディレクトリ構成などの説明のみに徹底する。設計などは、適切なファイルへのリンクを書く。

---

プロジェクト構成（リポジトリ全体）

本リポジトリは「ワークスペース（リポジトリ）ルート」を基点として、Unityプロジェクト・Node製MCPサーバ・C# LSP を同居させています。パスは常にワークスペースルート基準で解決します。

• ワークスペースルート

  • 定義: コーディングエージェント（Codex等）が「起動したディレクトリ」。
  • 設定: ./.unity/config.json の project.root に Unity プロジェクトの相対/絶対パスを記載。
  • Node側は起動時にこの設定を読み、以後「固定の WORKSPACE_ROOT」として保持し、Unityへの全コマンドに workspaceRoot を同梱します（process.cwd()の変動には依存しない）。

• .unity/

  • config.json: ワークスペースの設定。特に project.root は Unity プロジェクトルートを指す（相対なら .unity の1階層上を基準）。
  • capture/: スクリーンショット・動画の固定保存先。一時成果物としてGit管理外（.gitignore 済）。