docs(readme): synchronize troubleshooting and support sections across all languages EN, CN & JA

CoderGamester · CoderGamester · commit 79153f4d83a5 · 2025-04-26T03:05:37.000+03:00
change: renamed notify_message tool to send_console_log
diff --git a/Editor/Tools/SendConsoleLogTool.cs b/Editor/Tools/SendConsoleLogTool.cs
@@ -8,11 +8,11 @@ namespace McpUnity.Tools
     /// <summary>
     /// Tool for sending notification messages to the Unity console
     /// </summary>
-    public class NotifyMessageTool : McpToolBase
+    public class SendConsoleLogTool : McpToolBase
     {
-        public NotifyMessageTool()
+        public SendConsoleLogTool()
         {
-            Name = "notify_message";
+            Name = "send_console_log";
             Description = "Sends a message to the Unity console";
         }
         
diff --git a/Editor/Tools/SendConsoleLogTool.cs.meta b/Editor/Tools/SendConsoleLogTool.cs.meta
diff --git a/Editor/UnityBridge/McpUnityServer.cs b/Editor/UnityBridge/McpUnityServer.cs
@@ -163,9 +163,9 @@ private void RegisterTools()
             RunTestsTool runTestsTool = new RunTestsTool(_testRunnerService);
             _tools.Add(runTestsTool.Name, runTestsTool);
             
-            // Register NotifyMessageTool
-            NotifyMessageTool notifyMessageTool = new NotifyMessageTool();
-            _tools.Add(notifyMessageTool.Name, notifyMessageTool);
+            // Register SendConsoleLogTool
+            SendConsoleLogTool sendConsoleLogTool = new SendConsoleLogTool();
+            _tools.Add(sendConsoleLogTool.Name, sendConsoleLogTool);
             
             // Register UpdateComponentTool
             UpdateComponentTool updateComponentTool = new UpdateComponentTool();
diff --git a/README-ja.md b/README-ja.md
@@ -76,8 +76,8 @@ MCP Unityは、Unityの`Library/PackedCache`フォルダーをワークスペー
 - `run_tests`: Unityテストランナーを使用してテストを実行
   > **例:** "プロジェクト内のすべてのEditModeテストを実行"
 
-- `notify_message`: Unityエディターにメッセージを表示
-  > **例:** "タスクが完了したことをUnityに通知"
+- `send_console_log`: Unityにコンソールログを送信
+  > **例:** "Unity Editorにコンソールログを送信"
 
 - `add_asset_to_scene`: AssetDatabaseからアセットをUnityシーンに追加
   > **例:** "プロジェクトからPlayerプレハブを現在のシーンに追加"
@@ -230,30 +230,61 @@ MCP Unityサーバーをデバッグするには、以下の方法を使用で
 
 ## トラブルシューティング
 
-### <a name="common-issues"></a>よくある問題
-
-#### サーバーが起動しない
+<details>
+<summary><span style="font-size: 1.1em; font-weight: bold;">接続の問題</span></summary>
 
-- Node.js 18以降がインストールされていることを確認
-- npm 9以降がインストールされていることを確認
-- MCP Unityサーバーディレクトリが正しいことを確認
+- WebSocketサーバーが実行中であることを確認してください（UnityのServer Windowを確認）
+- ファイアウォールの制限が接続を妨げていないか確認してください
+- ポート番号が正しいことを確認してください（デフォルトは8080）
+- UnityエディターのMCP Serverウィンドウでポート番号を変更できます（ツール > MCP Unity > Server Window）
+</details>
 
-#### メニュー項目が実行されない
+<details>
+<summary><span style="font-size: 1.1em; font-weight: bold;">サーバーが起動しない</span></summary>
 
-- メニュー項目のパスが正しいことを確認（大文字小文字を区別）
-- メニュー項目が確認を必要とするかどうかを確認
-- メニュー項目が現在のコンテキストで利用可能であることを確認
+- Unityコンソールにエラーメッセージがないか確認してください
+- Node.jsが正しくインストールされ、PATHで利用可能であることを確認してください
+- Serverディレクトリ内の依存関係がすべてインストールされていることを確認してください
+</details>
 
-#### Play Modeテスト実行時に `Connection failed` エラー
+<details>
+<summary><span style="font-size: 1.1em; font-weight: bold;">Play Modeテスト実行時の接続失敗</span></summary>
 
-`run_tests` ツールの実行が次のエラーを返します：
+`run_tests` ツールは以下の応答を返します：
 ```
 Error:
 Connection failed: Unknown error
 ```
 
-このエラーは、Play Modeに切り替わる際にドメインがリロードされるため、ブリッジ接続が失われることで発生します。  
-回避方法は、**Edit > Project Settings > Editor > "Enter Play Mode Settings"** で **Reload Domain** をオフにすることです。
+このエラーは、Play Modeへ切り替える際にドメインリロードが発生し、ブリッジ接続が失われるために発生します。  
+回避策は、**Edit > Project Settings > Editor > "Enter Play Mode Settings"** で **Reload Domain** をオフにすることです。
+</details>
+
+## サポート・フィードバック
+
+ご質問やサポートが必要な場合は、このリポジトリの[issue](https://github.com/CoderGamester/mcp-unity/issues)をご利用ください。
+
+また、以下でも連絡可能です：
+- Linkedin: [![](https://img.shields.io/badge/LinkedIn-0077B5?style=flat&logo=linkedin&logoColor=white 'LinkedIn')](https://www.linkedin.com/in/miguel-tomas/)
+- Discord: gamester7178
+- メール: game.gamester@gmail.com
+
+## コントリビューション
+
+コントリビューションは大歓迎です！Pull Requestの送信やIssueの提出をお待ちしています。
+
+**変更は [Conventional Commits](https://www.conventionalcommits.org/ja/v1.0.0/) フォーマットに従ってください。**
+
+## ライセンス
+
+本プロジェクトは [MIT License](License.md) の下で提供されています。
+
+## 謝辞
+
+- [Model Context Protocol](https://modelcontextprotocol.io)
+- [Unity Technologies](https://unity.com)
+- [Node.js](https://nodejs.org)
+- [WebSocket-Sharp](https://github.com/sta/websocket-sharp)
 
 ## 貢献
 
diff --git a/README.md b/README.md
@@ -76,8 +76,8 @@ MCP Unity provides automatic integration with VSCode-like IDEs (Visual Studio Co
 - `run_tests`: Runs tests using the Unity Test Runner
   > **Example prompt:** "Run all the EditMode tests in my project"
 
-- `notify_message`: Displays messages in the Unity Editor
-  > **Example prompt:** "Send a notification to Unity that the task has been completed"
+- `send_console_log`: Send a console log to Unity
+  > **Example prompt:** "Send a console log to Unity Editor"
 
 - `add_asset_to_scene`: Adds an asset from the AssetDatabase to the Unity scene
   > **Example prompt:** "Add the Player prefab from my project to the current scene"
@@ -306,8 +306,7 @@ Don't forget to shutdown the server with `Ctrl + C` before closing the terminal
 <summary><span style="font-size: 1.1em; font-weight: bold;">Connection Issues</span></summary>
 
 - Ensure the WebSocket server is running (check the Server Window in Unity)
-- Check if there are any firewall restrictions blocking the connection
-- Make sure the port number is correct (default is 8080)
+- Send a console log message from MCP client to force a reconnection between MCP client and Unity server
 - Change the port number in the Unity Editor MCP Server window. (Tools > MCP Unity > Server Window)
 </details>
 
@@ -319,14 +318,6 @@ Don't forget to shutdown the server with `Ctrl + C` before closing the terminal
 - Verify that all dependencies are installed in the Server directory
 </details>
 
-<details>
-<summary><span style="font-size: 1.1em; font-weight: bold;">Menu Items Not Executing</span></summary>
-
-- Ensure the menu item path is correct (case-sensitive)
-- Check if the menu item requires confirmation
-- Verify that the menu item is available in the current context
-</details>
-
 <details>
 <summary><span style="font-size: 1.1em; font-weight: bold;">Connection failed when running Play Mode tests</span></summary>
 
diff --git a/README_zh-CN.md b/README_zh-CN.md
@@ -78,8 +78,8 @@ MCP Unity 通过将 Unity `Library/PackedCache` 文件夹添加到您的工作
 - `run_tests`: 使用 Unity 测试运行器运行测试
   > **示例提示:** "运行我项目中所有的 EditMode 测试"
 
-- `notify_message`: 在 Unity 编辑器中显示消息
-  > **示例提示:** "发送通知到 Unity 告知任务已完成"
+- `send_console_log`: 发送控制台日志到 Unity
+  > **示例提示:** "发送控制台日志到 Unity 编辑器"
 
 - `add_asset_to_scene`: 将 AssetDatabase 中的资源添加到 Unity 场景中
   > **示例提示:** "将我的项目中的 Player 预制体添加到当前场景"
@@ -232,30 +232,61 @@ MCP Unity 通过将 Unity `Library/PackedCache` 文件夹添加到您的工作
 
 ## 故障排除
 
-### <a name="common-issues"></a>常见问题
-
-#### 服务器无法启动
+<details>
+<summary><span style="font-size: 1.1em; font-weight: bold;">连接问题</span></summary>
 
-- 确保 Node.js 18 或更高版本已安装
-- 验证 npm 9 或更高版本已安装
-- 检查 MCP Unity 服务器目录是否正确
+- 确保 WebSocket 服务器正在运行（检查 Unity 的 Server Window）
+- 检查是否有防火墙限制阻止连接
+- 确认端口号正确（默认是 8080）
+- 可在 Unity 编辑器 MCP Server 窗口更改端口号。(工具 > MCP Unity > Server Window)
+</details>
 
-#### 菜单项无法执行
+<details>
+<summary><span style="font-size: 1.1em; font-weight: bold;">服务器无法启动</span></summary>
 
-- 确保菜单项路径正确（区分大小写）
-- 检查菜单项是否需要确认
-- 验证菜单项在当前上下文中是否可用
+- 检查 Unity 控制台是否有错误消息
+- 确保 Node.js 已正确安装并可在 PATH 中访问
+- 验证 Server 目录下所有依赖均已安装
+</details>
 
-#### 运行播放模式测试时连接失败
+<details>
+<summary><span style="font-size: 1.1em; font-weight: bold;">运行播放模式测试时连接失败</span></summary>
 
 `run_tests` 工具返回以下响应：
 ```
 Error:
 Connection failed: Unknown error
 ```
 
-发生此错误的原因是在切换到播放模式触发域重新加载时，桥接连接会丢失。  
+发生此错误的原因是在切换到播放模式时域重新加载，导致桥接连接丢失。  
 解决方法是在 **Edit > Project Settings > Editor > "Enter Play Mode Settings"** 中关闭 **Reload Domain**。
+</details>
+
+## 支持与反馈
+
+如有任何问题或需要支持，请在本仓库[提交 issue](https://github.com/CoderGamester/mcp-unity/issues)。
+
+你也可以通过以下方式联系：
+- Linkedin: [![](https://img.shields.io/badge/LinkedIn-0077B5?style=flat&logo=linkedin&logoColor=white 'LinkedIn')](https://www.linkedin.com/in/miguel-tomas/)
+- Discord: gamester7178
+- 邮箱: game.gamester@gmail.com
+
+## 贡献
+
+欢迎贡献！请随时提交 Pull Request 或提出 Issue。
+
+**请遵循 [Conventional Commits](https://www.conventionalcommits.org/zh-hans/v1.0.0/) 格式提交更改。**
+
+## 许可证
+
+本项目采用 [MIT License](License.md) 授权。
+
+## 鸣谢
+
+- [Model Context Protocol](https://modelcontextprotocol.io)
+- [Unity Technologies](https://unity.com)
+- [Node.js](https://nodejs.org)
+- [WebSocket-Sharp](https://github.com/sta/websocket-sharp)
 
 ## 贡献
 
diff --git a/Server/build/index.js b/Server/build/index.js
@@ -7,7 +7,7 @@ import { createMenuItemTool } from './tools/menuItemTool.js';
 import { createSelectGameObjectTool } from './tools/selectGameObjectTool.js';
 import { createAddPackageTool } from './tools/addPackageTool.js';
 import { createRunTestsTool } from './tools/runTestsTool.js';
-import { createNotifyMessageTool } from './tools/notifyMessageTool.js';
+import { createSendConsoleLogTool } from './tools/sendConsoleLogTool.js';
 import { createUpdateComponentTool } from './tools/updateComponentTool.js';
 import { createAddAssetToSceneTool } from './tools/addAssetToSceneTool.js';
 import { createGetMenuItemsResource } from './resources/getMenuItemResource.js';
@@ -39,7 +39,7 @@ createMenuItemTool(server, mcpUnity, toolLogger);
 createSelectGameObjectTool(server, mcpUnity, toolLogger);
 createAddPackageTool(server, mcpUnity, toolLogger);
 createRunTestsTool(server, mcpUnity, toolLogger);
-createNotifyMessageTool(server, mcpUnity, toolLogger);
+createSendConsoleLogTool(server, mcpUnity, toolLogger);
 createUpdateComponentTool(server, mcpUnity, toolLogger);
 createAddAssetToSceneTool(server, mcpUnity, toolLogger);
 // Create and register all resources with the MCP server
diff --git a/Server/build/tools/sendConsoleLogTool.d.ts b/Server/build/tools/sendConsoleLogTool.d.ts
@@ -0,0 +1,12 @@
+import { Logger } from '../utils/logger.js';
+import { McpUnity } from '../unity/mcpUnity.js';
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+/**
+ * Creates and registers the Send Console Log tool with the MCP server
+ * This tool allows sending messages to the Unity console
+ *
+ * @param server The MCP server instance to register with
+ * @param mcpUnity The McpUnity instance to communicate with Unity
+ * @param logger The logger instance for diagnostic information
+ */
+export declare function createSendConsoleLogTool(server: McpServer, mcpUnity: McpUnity, logger: Logger): void;
diff --git a/Server/build/tools/sendConsoleLogTool.d.ts.meta b/Server/build/tools/sendConsoleLogTool.d.ts.meta
diff --git a/Server/build/tools/sendConsoleLogTool.js b/Server/build/tools/sendConsoleLogTool.js
@@ -0,0 +1,61 @@
+import { z } from 'zod';
+import { McpUnityError, ErrorType } from '../utils/errors.js';
+// Constants for the tool
+const toolName = 'send_console_log';
+const toolDescription = 'Sends console log messages to the Unity console';
+const paramsSchema = z.object({
+    message: z.string().describe('The message to display in the Unity console'),
+    type: z.string().optional().describe('The type of message (info, warning, error) - defaults to info (optional)')
+});
+/**
+ * Creates and registers the Send Console Log tool with the MCP server
+ * This tool allows sending messages to the Unity console
+ *
+ * @param server The MCP server instance to register with
+ * @param mcpUnity The McpUnity instance to communicate with Unity
+ * @param logger The logger instance for diagnostic information
+ */
+export function createSendConsoleLogTool(server, mcpUnity, logger) {
+    logger.info(`Registering tool: ${toolName}`);
+    // Register this tool with the MCP server
+    server.tool(toolName, toolDescription, paramsSchema.shape, async (params) => {
+        try {
+            logger.info(`Executing tool: ${toolName}`, params);
+            const result = await toolHandler(mcpUnity, params);
+            logger.info(`Tool execution successful: ${toolName}`);
+            return result;
+        }
+        catch (error) {
+            logger.error(`Tool execution failed: ${toolName}`, error);
+            throw error;
+        }
+    });
+}
+/**
+ * Handles notification message requests
+ *
+ * @param mcpUnity The McpUnity instance to communicate with Unity
+ * @param params The parameters for the tool
+ * @returns A promise that resolves to the tool execution result
+ * @throws McpUnityError if the request to Unity fails
+ */
+async function toolHandler(mcpUnity, params) {
+    const { message, type = 'info' } = params;
+    // Send to Unity
+    const response = await mcpUnity.sendRequest({
+        method: toolName,
+        params: {
+            message,
+            type
+        }
+    });
+    if (!response.success) {
+        throw new McpUnityError(ErrorType.TOOL_EXECUTION, response.message || `Failed to send message to Unity console`);
+    }
+    return {
+        content: [{
+                type: response.type,
+                text: response.message
+            }]
+    };
+}
diff --git a/Server/build/tools/sendConsoleLogTool.js.meta b/Server/build/tools/sendConsoleLogTool.js.meta
diff --git a/Server/src/index.ts b/Server/src/index.ts
@@ -7,7 +7,7 @@ import { createMenuItemTool } from './tools/menuItemTool.js';
 import { createSelectGameObjectTool } from './tools/selectGameObjectTool.js';
 import { createAddPackageTool } from './tools/addPackageTool.js';
 import { createRunTestsTool } from './tools/runTestsTool.js';
-import { createNotifyMessageTool } from './tools/notifyMessageTool.js';
+import { createSendConsoleLogTool } from './tools/sendConsoleLogTool.js';
 import { createUpdateComponentTool } from './tools/updateComponentTool.js';
 import { createAddAssetToSceneTool } from './tools/addAssetToSceneTool.js';
 import { createGetMenuItemsResource } from './resources/getMenuItemResource.js';
@@ -46,7 +46,7 @@ createMenuItemTool(server, mcpUnity, toolLogger);
 createSelectGameObjectTool(server, mcpUnity, toolLogger);
 createAddPackageTool(server, mcpUnity, toolLogger);
 createRunTestsTool(server, mcpUnity, toolLogger);
-createNotifyMessageTool(server, mcpUnity, toolLogger);
+createSendConsoleLogTool(server, mcpUnity, toolLogger);
 createUpdateComponentTool(server, mcpUnity, toolLogger);
 createAddAssetToSceneTool(server, mcpUnity, toolLogger);
 
diff --git a/Server/src/tools/sendConsoleLogTool.ts b/Server/src/tools/sendConsoleLogTool.ts
@@ -6,22 +6,22 @@ import { McpUnityError, ErrorType } from '../utils/errors.js';
 import { CallToolResult } from '@modelcontextprotocol/sdk/types.js';
 
 // Constants for the tool
-const toolName = 'notify_message';
-const toolDescription = 'Sends a message to the Unity console';
+const toolName = 'send_console_log';
+const toolDescription = 'Sends console log messages to the Unity console';
 const paramsSchema = z.object({
   message: z.string().describe('The message to display in the Unity console'),
   type: z.string().optional().describe('The type of message (info, warning, error) - defaults to info (optional)')
 });
 
 /**
- * Creates and registers the Notify Message tool with the MCP server
+ * Creates and registers the Send Console Log tool with the MCP server
  * This tool allows sending messages to the Unity console
  * 
  * @param server The MCP server instance to register with
  * @param mcpUnity The McpUnity instance to communicate with Unity
  * @param logger The logger instance for diagnostic information
  */
-export function createNotifyMessageTool(server: McpServer, mcpUnity: McpUnity, logger: Logger) {
+export function createSendConsoleLogTool(server: McpServer, mcpUnity: McpUnity, logger: Logger) {
   logger.info(`Registering tool: ${toolName}`);
   
   // Register this tool with the MCP server
diff --git a/Server/src/tools/sendConsoleLogTool.ts.meta b/Server/src/tools/sendConsoleLogTool.ts.meta

Original file line number	Diff line number	Diff line change
`@@ -8,11 +8,11 @@ namespace McpUnity.Tools`
`8`	`8`	`/// <summary>`
`9`	`9`	`/// Tool for sending notification messages to the Unity console`
`10`	`10`	`/// </summary>`
`11`		`- public class NotifyMessageTool : McpToolBase`
	`11`	`+ public class SendConsoleLogTool : McpToolBase`
`12`	`12`	`{`
`13`		`- public NotifyMessageTool()`
	`13`	`+ public SendConsoleLogTool()`
`14`	`14`	`{`
`15`		`- Name = "notify_message";`
	`15`	`+ Name = "send_console_log";`
`16`	`16`	`Description = "Sends a message to the Unity console";`
`17`	`17`	`}`
`18`	`18`