@akiojin/unity-mcp-server 2.16.1 → 2.26.0

package/README.md

@@ -87,6 +87,16 @@ Add to your `claude_desktop_config.json`:
 
 > **Tip:** `code_index_update` は JSON パラメータ `paths` に絶対パス／相対パスの配列を渡すだけで完了します。内部で存在チェックと LSP リトライを行うため、Unity を起動したままでも短時間で終わります。
 
+### インデックス状態を検証したいとき
+
+ビルド中・未構築・完了後といったステータスを再現したい場合は、`code_index_build` に `delayStartMs` や `throttleMs` を付けて進捗を意図的に保ちます。さらに、`npm run simulate:code-index` を実行すると以下が自動化されます。
+
+- 既存インデックスのリセット（`--reset`）
+- `code_index_build` のバックグラウンド実行（任意の `--delayStart=MS` / `--throttle=MS`）
+- 指定間隔での `code_index_status` ポーリング（`--poll=MS`）
+
+出力される JSON を追うことで、`ready: false` → `true` へ遷移する様子や `buildJob.status` の変化を簡単に確認できます。
+
 ## Available Tools (Standardized Names)
 
 ### System & Core Tools
@@ -105,6 +115,7 @@ Add to your `claude_desktop_config.json`:
 - `component_add` — Add Unity components to GameObjects with initial properties
 - `component_remove` — Remove components from GameObjects with safety checks
 - `component_modify` — Modify component properties with nested support
+- `component_field_set` — Update serialized fields (including private `[SerializeField]` values, arrays, and nested structs)
 - `component_list` — List all components on a GameObject with type information
 - `component_get_types` — Discover available component types with filtering
 
@@ -149,10 +160,10 @@ Add to your `claude_desktop_config.json`:
 - `script_remove_symbol` — Delete symbols (types/members) with reference checks
 - `script_refactor_rename` — Rename symbols project-wide via LSP
 - `script_packages_list` — List installed packages relevant to scripting
-- `script_index_status` — Report status of the persistent code index
+- `code_index_status` — Report status of the persistent code index
 
 ### Code Index Utilities
-- `code_index_build` — フルスキャンでシンボルインデックスを再構築
+- `code_index_build` — フルスキャンでシンボルインデックスを再構築（開発時は `delayStartMs` や `throttleMs` で進捗観測用に速度調整可能）
 - `code_index_update` — 変更した C# ファイルのみ差分再インデックス
 
 ### Play Mode Controls
@@ -216,7 +227,6 @@ Add to your `claude_desktop_config.json`:
 - `test_run` — Run Unity tests (EditMode/PlayMode)
 - `test_get_status` — Query test runner progress/results
 
-
 ## Requirements
 
 - **Unity**: 2020.3 LTS or newer (Unity 6 supported)
@@ -242,7 +252,7 @@ npm install -g @akiojin/unity-mcp-server
 
 ## Repository
 
-Full source code and documentation: https://github.com/akiojin/unity-mcp-server
+Full source code and documentation: <https://github.com/akiojin/unity-mcp-server>
 
 ## License
 

package/bin/unity-mcp-server

@@ -1,2 +1,8 @@
 #!/usr/bin/env node
-import '../src/core/server.js';
+import { startServer } from '../src/core/server.js';
+
+startServer().catch((error) => {
+  console.error('Fatal error:', error);
+  console.error('Stack trace:', error?.stack);
+  process.exit(1);
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akiojin/unity-mcp-server",
-  "version": "2.16.1",
+  "version": "2.26.0",
   "description": "MCP server and Unity Editor bridge — enables AI assistants to control Unity for AI-assisted workflows",
   "type": "module",
   "main": "src/core/server.js",
@@ -13,18 +13,24 @@
     "build:index": "node src/tools/buildCodeIndex.js",
     "test": "node --test tests/unit/**/*.test.js tests/integration/*.test.js",
     "test:unit": "NODE_ENV=test node --test tests/unit/**/*.test.js",
-    "test:integration": "NODE_ENV=test node --test tests/integration/*.test.js",
+    "test:integration": "NODE_ENV=test node scripts/run-non-unity-tests.mjs",
     "test:e2e": "NODE_ENV=test node --test tests/e2e/*.test.js",
     "test:coverage": "c8 --reporter=lcov --reporter=text --reporter=html node --test tests/unit/**/*.test.js tests/integration/*.test.js",
     "test:coverage:full": "c8 --reporter=lcov --reporter=text --reporter=html node --test tests/**/*.test.js",
     "test:watch": "node --watch --test tests/unit/**/*.test.js",
     "test:watch:all": "node --watch --test tests/**/*.test.js",
     "test:performance": "node --test tests/performance/*.test.js",
-    "test:ci": "c8 --reporter=lcov --check-coverage=false node --test tests/unit/core/config.test.js tests/unit/handlers/PingToolHandler.test.js tests/unit/handlers/CreateGameObjectToolHandler.test.js",
+    "test:ci": "CI=true NODE_ENV=test node --test tests/unit/core/codeIndex.test.js tests/unit/core/codeIndexDb.test.js tests/unit/core/config.test.js tests/unit/core/indexWatcher.test.js tests/unit/core/projectInfo.test.js tests/unit/core/server.test.js tests/unit/handlers/script/CodeIndexStatusToolHandler.test.js",
     "test:ci:all": "c8 --reporter=lcov node --test tests/unit/**/*.test.js",
+    "simulate:code-index": "node scripts/simulate-code-index-status.mjs",
     "test:verbose": "VERBOSE_TEST=true node --test tests/**/*.test.js",
+    "prepare": "cd .. && husky || true",
     "prepublishOnly": "npm run test:ci",
-    "postinstall": "chmod +x bin/unity-mcp-server || true"
+    "postinstall": "chmod +x bin/unity-mcp-server || true",
+    "test:ci:unity": "timeout 60 node --test tests/unit/core/codeIndex.test.js tests/unit/core/codeIndexDb.test.js tests/unit/core/config.test.js tests/unit/core/indexWatcher.test.js tests/unit/core/projectInfo.test.js tests/unit/core/server.test.js || exit 0",
+    "test:unity": "node tests/run-unity-integration.mjs",
+    "test:nounity": "npm run test:integration",
+    "test:ci:integration": "CI=true NODE_ENV=test node --test tests/integration/code-index-background.test.js"
   },
   "keywords": [
     "mcp",
@@ -68,7 +74,23 @@
     "access": "public"
   },
   "devDependencies": {
+    "@commitlint/cli": "^18.6.1",
+    "@commitlint/config-conventional": "^18.6.3",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/commit-analyzer": "^11.1.0",
+    "@semantic-release/exec": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/release-notes-generator": "^12.1.0",
     "c8": "^10.1.3",
-    "nodemon": "^3.1.7"
+    "eslint": "^8.57.1",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-n": "^16.6.2",
+    "eslint-plugin-promise": "^6.6.0",
+    "husky": "^9.1.7",
+    "markdownlint-cli": "^0.43.0",
+    "nodemon": "^3.1.7",
+    "prettier": "^3.4.2",
+    "semantic-release": "^22.0.12"
   }
 }

package/src/core/config.js

@@ -1,200 +1,242 @@
-import fs from 'fs';
-import path from 'path';
-import { findUpSync } from 'find-up';
-
-/**
- * Shallow merge utility (simple objects only)
- */
-function merge(a, b) {
-  const out = { ...a };
-  for (const [k, v] of Object.entries(b || {})) {
-    if (v && typeof v === 'object' && !Array.isArray(v) && a[k] && typeof a[k] === 'object') {
-      out[k] = { ...a[k], ...v };
-    } else {
-      out[k] = v;
-    }
-  }
-  return out;
-}
-
-/**
- * Base configuration for Unity Editor MCP Server
- */
-const envUnityHost =
-  process.env.UNITY_UNITY_HOST ||
-  process.env.UNITY_BIND_HOST ||
-  process.env.UNITY_HOST ||
-  null;
-
-const envMcpHost =
-  process.env.UNITY_MCP_HOST ||
-  process.env.UNITY_CLIENT_HOST ||
-  process.env.UNITY_HOST ||
-  null;
-
-const envBindHost = process.env.UNITY_BIND_HOST || null;
-
-const baseConfig = {
-  // Unity connection settings
-  unity: {
-    unityHost: envUnityHost,
-    mcpHost: envMcpHost,
-    bindHost: envBindHost,
-    port: parseInt(process.env.UNITY_PORT || '', 10) || 6400,
-    reconnectDelay: 1000,
-    maxReconnectDelay: 30000,
-    reconnectBackoffMultiplier: 2,
-    commandTimeout: 30000,
-  },
-
-  // Server settings
-  server: {
-    name: 'unity-mcp-server',
-    version: '0.1.0',
-    description: 'MCP server for Unity Editor integration',
-  },
-
-  // Logging settings
-  logging: {
-    level: process.env.LOG_LEVEL || 'info',
-    prefix: '[Unity Editor MCP]',
-  },
-
-  // Write queue removed: all edits go through structured Roslyn tools.
-
-  // Search-related defaults and engine selection
-  search: {
-    // detail alias: 'compact' maps to returnMode 'snippets'
-    defaultDetail: (process.env.SEARCH_DEFAULT_DETAIL || 'compact').toLowerCase(), // compact|metadata|snippets|full
-    engine: (process.env.SEARCH_ENGINE || 'naive').toLowerCase(), // naive|treesitter (future)
-  },
-
-  // LSP client defaults
-  lsp: {
-    requestTimeoutMs: Number(process.env.LSP_REQUEST_TIMEOUT_MS || 60000),
-  },
-
-  // Indexing (code index) settings
-  indexing: {
-    // Enable periodic incremental index updates (polling watcher)
-    watch: (process.env.INDEX_WATCH || 'false').toLowerCase() === 'true',
-    // Polling interval (ms)
-    intervalMs: Number(process.env.INDEX_WATCH_INTERVAL_MS || 15000),
-    // Build options
-    concurrency: Number(process.env.INDEX_CONCURRENCY || 8),
-    retry: Number(process.env.INDEX_RETRY || 2),
-    reportEvery: Number(process.env.INDEX_REPORT_EVERY || 500),
-  },
-};
-
-/**
- * External config resolution (no legacy compatibility):
- * Priority:
- * 1) UNITY_MCP_CONFIG (explicit file path)
- * 2) ./.unity/config.json (project-local)
- * 3) ~/.unity/config.json (user-global)
- * If none found, return {} and rely on env/defaults.
- */
-function loadExternalConfig() {
-  const explicitPath = process.env.UNITY_MCP_CONFIG;
-
-  const projectPath = findUpSync((directory) => {
-    const candidate = path.resolve(directory, '.unity', 'config.json');
-    return fs.existsSync(candidate) ? candidate : undefined;
-  }, { cwd: process.cwd() });
-  const homeDir = process.env.HOME || process.env.USERPROFILE || '';
-  const userPath = homeDir ? path.resolve(homeDir, '.unity', 'config.json') : null;
-
-  const candidates = [explicitPath, projectPath, userPath].filter(Boolean);
-  for (const p of candidates) {
-    try {
-      if (p && fs.existsSync(p)) {
-        const raw = fs.readFileSync(p, 'utf8');
-        const json = JSON.parse(raw);
-        const out = json && typeof json === 'object' ? json : {};
-        out.__configPath = p;
-        return out;
-      }
-    } catch (e) {
-      return { __configLoadError: `${p}: ${e.message}` };
-    }
-  }
-  return {};
-}
-
-const external = loadExternalConfig();
-export const config = merge(baseConfig, external);
-
-const normalizeUnityConfig = () => {
-  const unityConfig = config.unity || (config.unity = {});
-
-  // Legacy aliases coming from config files or env vars
-  const legacyHost = unityConfig.host;
-  const legacyClientHost = unityConfig.clientHost;
-  const legacyBindHost = unityConfig.bindHost;
-
-  if (!unityConfig.unityHost) {
-    unityConfig.unityHost = legacyBindHost || legacyHost || envUnityHost || 'localhost';
-  }
-
-  if (!unityConfig.mcpHost) {
-    unityConfig.mcpHost = legacyClientHost || envMcpHost || legacyHost || unityConfig.unityHost;
-  }
-
-  // Keep bindHost for backwards compatibility with legacy code paths
-  if (!unityConfig.bindHost) {
-    unityConfig.bindHost = legacyBindHost || envBindHost || unityConfig.unityHost;
-  }
-
-  // Maintain legacy properties so older handlers keep working
-  unityConfig.host = unityConfig.unityHost;
-  unityConfig.clientHost = unityConfig.mcpHost;
-};
-
-normalizeUnityConfig();
-
-// Workspace root detection: directory that contains .unity/config.json used
-const initialCwd = process.cwd();
-let workspaceRoot = initialCwd;
-try {
-  if (config.__configPath) {
-    const cfgDir = path.dirname(config.__configPath); // <workspace>/.unity
-    workspaceRoot = path.dirname(cfgDir);            // <workspace>
-  }
-} catch {}
-export const WORKSPACE_ROOT = workspaceRoot;
-
-/**
- * Logger utility
- * IMPORTANT: In MCP servers, all stdout output must be JSON-RPC protocol messages.
- * Logging must go to stderr to avoid breaking the protocol.
- */
-export const logger = {
-  info: (message, ...args) => {
-    if (['info', 'debug'].includes(config.logging.level)) {
-      console.error(`${config.logging.prefix} ${message}`, ...args);
-    }
-  },
-  
-  warn: (message, ...args) => {
-    if (['info', 'debug', 'warn'].includes(config.logging.level)) {
-      console.error(`${config.logging.prefix} WARN: ${message}`, ...args);
-    }
-  },
-  
-  error: (message, ...args) => {
-    console.error(`${config.logging.prefix} ERROR: ${message}`, ...args);
-  },
-  
-  debug: (message, ...args) => {
-    if (config.logging.level === 'debug') {
-      console.error(`${config.logging.prefix} DEBUG: ${message}`, ...args);
-    }
-  }
-};
-
-// Late log if external config failed to load
-if (config.__configLoadError) {
-  console.error(`${baseConfig.logging.prefix} WARN: Failed to load external config: ${config.__configLoadError}`);
-  delete config.__configLoadError;
-}
+import fs from 'fs';
+import path from 'path';
+import { findUpSync } from 'find-up';
+
+/**
+ * Shallow merge utility (simple objects only)
+ */
+function merge(a, b) {
+  const out = { ...a };
+  for (const [k, v] of Object.entries(b || {})) {
+    if (v && typeof v === 'object' && !Array.isArray(v) && a[k] && typeof a[k] === 'object') {
+      out[k] = { ...a[k], ...v };
+    } else {
+      out[k] = v;
+    }
+  }
+  return out;
+}
+
+/**
+ * Base configuration for Unity Editor MCP Server
+ */
+const envUnityHost =
+  process.env.UNITY_UNITY_HOST ||
+  process.env.UNITY_BIND_HOST ||
+  process.env.UNITY_HOST ||
+  null;
+
+const envMcpHost =
+  process.env.UNITY_MCP_HOST ||
+  process.env.UNITY_CLIENT_HOST ||
+  process.env.UNITY_HOST ||
+  null;
+
+const envBindHost = process.env.UNITY_BIND_HOST || null;
+
+const baseConfig = {
+  // Unity connection settings
+  unity: {
+    unityHost: envUnityHost,
+    mcpHost: envMcpHost,
+    bindHost: envBindHost,
+    port: parseInt(process.env.UNITY_PORT || '', 10) || 6400,
+    reconnectDelay: 1000,
+    maxReconnectDelay: 30000,
+    reconnectBackoffMultiplier: 2,
+    commandTimeout: 30000,
+  },
+
+  // Server settings
+  server: {
+    name: 'unity-mcp-server',
+    version: '0.1.0',
+    description: 'MCP server for Unity Editor integration',
+  },
+
+  // Logging settings
+  logging: {
+    level: process.env.LOG_LEVEL || 'info',
+    prefix: '[Unity Editor MCP]',
+  },
+
+  // Write queue removed: all edits go through structured Roslyn tools.
+
+  // Search-related defaults and engine selection
+  search: {
+    // detail alias: 'compact' maps to returnMode 'snippets'
+    defaultDetail: (process.env.SEARCH_DEFAULT_DETAIL || 'compact').toLowerCase(), // compact|metadata|snippets|full
+    engine: (process.env.SEARCH_ENGINE || 'naive').toLowerCase(), // naive|treesitter (future)
+  },
+
+  // LSP client defaults
+  lsp: {
+    requestTimeoutMs: Number(process.env.LSP_REQUEST_TIMEOUT_MS || 60000),
+  },
+
+  // Indexing (code index) settings
+  indexing: {
+    // Enable periodic incremental index updates (polling watcher)
+    watch: (process.env.INDEX_WATCH || 'false').toLowerCase() === 'true',
+    // Polling interval (ms)
+    intervalMs: Number(process.env.INDEX_WATCH_INTERVAL_MS || 15000),
+    // Build options
+    concurrency: Number(process.env.INDEX_CONCURRENCY || 8),
+    retry: Number(process.env.INDEX_RETRY || 2),
+    reportEvery: Number(process.env.INDEX_REPORT_EVERY || 500),
+  },
+};
+
+/**
+ * External config resolution (no legacy compatibility):
+ * Priority:
+ * 1) UNITY_MCP_CONFIG (explicit file path)
+ * 2) ./.unity/config.json (project-local)
+ * 3) ~/.unity/config.json (user-global)
+ * If none found, create ./.unity/config.json with defaults.
+ */
+function ensureDefaultProjectConfig(baseDir) {
+  const dir = path.resolve(baseDir, '.unity');
+  const file = path.join(dir, 'config.json');
+
+  try {
+    if (!fs.existsSync(dir)) {
+      fs.mkdirSync(dir, { recursive: true });
+    }
+
+    if (!fs.existsSync(file)) {
+      const inferredRoot = fs.existsSync(path.join(baseDir, 'Assets')) ? baseDir : '';
+      const defaultConfig = {
+        unity: {
+          unityHost: 'localhost',
+          mcpHost: 'localhost',
+          port: 6400,
+        },
+        project: {
+          root: inferredRoot ? inferredRoot.replace(/\\/g, '/') : '',
+        },
+      };
+      fs.writeFileSync(file, `${JSON.stringify(defaultConfig, null, 2)}\n`, 'utf8');
+    }
+    return file;
+  } catch (error) {
+    return null;
+  }
+}
+
+function loadExternalConfig() {
+  const explicitPath = process.env.UNITY_MCP_CONFIG;
+
+  const projectPath = findUpSync((directory) => {
+    const candidate = path.resolve(directory, '.unity', 'config.json');
+    return fs.existsSync(candidate) ? candidate : undefined;
+  }, { cwd: process.cwd() });
+  const homeDir = process.env.HOME || process.env.USERPROFILE || '';
+  const userPath = homeDir ? path.resolve(homeDir, '.unity', 'config.json') : null;
+
+  const candidates = [explicitPath, projectPath, userPath].filter(Boolean);
+  for (const p of candidates) {
+    try {
+      if (p && fs.existsSync(p)) {
+        const raw = fs.readFileSync(p, 'utf8');
+        const json = JSON.parse(raw);
+        const out = json && typeof json === 'object' ? json : {};
+        out.__configPath = p;
+        return out;
+      }
+    } catch (e) {
+      return { __configLoadError: `${p}: ${e.message}` };
+    }
+  }
+  const fallbackPath = ensureDefaultProjectConfig(process.cwd());
+  if (fallbackPath && fs.existsSync(fallbackPath)) {
+    try {
+      const raw = fs.readFileSync(fallbackPath, 'utf8');
+      const json = JSON.parse(raw);
+      const out = json && typeof json === 'object' ? json : {};
+      out.__configPath = fallbackPath;
+      out.__configGenerated = true;
+      return out;
+    } catch (e) {
+      return { __configLoadError: `${fallbackPath}: ${e.message}` };
+    }
+  }
+  return {};
+}
+
+const external = loadExternalConfig();
+export const config = merge(baseConfig, external);
+
+const normalizeUnityConfig = () => {
+  const unityConfig = config.unity || (config.unity = {});
+
+  // Legacy aliases coming from config files or env vars
+  const legacyHost = unityConfig.host;
+  const legacyClientHost = unityConfig.clientHost;
+  const legacyBindHost = unityConfig.bindHost;
+
+  if (!unityConfig.unityHost) {
+    unityConfig.unityHost = legacyBindHost || legacyHost || envUnityHost || 'localhost';
+  }
+
+  if (!unityConfig.mcpHost) {
+    unityConfig.mcpHost = legacyClientHost || envMcpHost || legacyHost || unityConfig.unityHost;
+  }
+
+  // Keep bindHost for backwards compatibility with legacy code paths
+  if (!unityConfig.bindHost) {
+    unityConfig.bindHost = legacyBindHost || envBindHost || unityConfig.unityHost;
+  }
+
+  // Maintain legacy properties so older handlers keep working
+  unityConfig.host = unityConfig.unityHost;
+  unityConfig.clientHost = unityConfig.mcpHost;
+};
+
+normalizeUnityConfig();
+
+// Workspace root detection: directory that contains .unity/config.json used
+const initialCwd = process.cwd();
+let workspaceRoot = initialCwd;
+try {
+  if (config.__configPath) {
+    const cfgDir = path.dirname(config.__configPath); // <workspace>/.unity
+    workspaceRoot = path.dirname(cfgDir);            // <workspace>
+  }
+} catch {}
+export const WORKSPACE_ROOT = workspaceRoot;
+
+/**
+ * Logger utility
+ * IMPORTANT: In MCP servers, all stdout output must be JSON-RPC protocol messages.
+ * Logging must go to stderr to avoid breaking the protocol.
+ */
+export const logger = {
+  info: (message, ...args) => {
+    if (['info', 'debug'].includes(config.logging.level)) {
+      console.error(`${config.logging.prefix} ${message}`, ...args);
+    }
+  },
+  
+  warn: (message, ...args) => {
+    if (['info', 'debug', 'warn'].includes(config.logging.level)) {
+      console.error(`${config.logging.prefix} WARN: ${message}`, ...args);
+    }
+  },
+  
+  error: (message, ...args) => {
+    console.error(`${config.logging.prefix} ERROR: ${message}`, ...args);
+  },
+  
+  debug: (message, ...args) => {
+    if (config.logging.level === 'debug') {
+      console.error(`${config.logging.prefix} DEBUG: ${message}`, ...args);
+    }
+  }
+};
+
+// Late log if external config failed to load
+if (config.__configLoadError) {
+  console.error(`${baseConfig.logging.prefix} WARN: Failed to load external config: ${config.__configLoadError}`);
+  delete config.__configLoadError;
+}