Add Cherry Studio MCP client support (#505)

* Add Cherry Studio MCP client support * Fix misleading message in HTTP mode for Cherry Studio * Address code review feedback
2026-01-04 07:00:13 +03:00 · 2026-01-04 07:00:13 +03:00 · 46b844a56f
parent 5afa2960f8
commit 46b844a56f
1 changed files with 93 additions and 0 deletions
--- a/MCPForUnity/Editor/Clients/Configurators/CherryStudioConfigurator.cs
+++ b/MCPForUnity/Editor/Clients/Configurators/CherryStudioConfigurator.cs
@ -0,0 +1,93 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using MCPForUnity.Editor.Constants;
+using MCPForUnity.Editor.Models;
+using UnityEditor;
+
+namespace MCPForUnity.Editor.Clients.Configurators
+{
+    public class CherryStudioConfigurator : JsonFileMcpConfigurator
+    {
+        public const string ClientName = "Cherry Studio";
+
+        public CherryStudioConfigurator() : base(new McpClient
+        {
+            name = ClientName,
+            windowsConfigPath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), "Cherry Studio", "config"),
+            macConfigPath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.UserProfile), "Library", "Application Support", "Cherry Studio", "config"),
+            linuxConfigPath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.UserProfile), ".config", "Cherry Studio", "config"),
+            SupportsHttpTransport = false
+        })
+        { }
+
+        public override bool SupportsAutoConfigure => false;
+
+        public override IList<string> GetInstallationSteps() => new List<string>
+        {
+            "Open Cherry Studio",
+            "Go to Settings (⚙️) → MCP Server",
+            "Click 'Add Server' button",
+            "For STDIO mode (recommended):",
+            "  - Name: unity-mcp",
+            "  - Type: STDIO",
+            "  - Command: uvx",
+            "  - Arguments: Copy from the Manual Configuration JSON below",
+            "Click Save and restart Cherry Studio",
+            "",
+            "Note: Cherry Studio uses UI-based configuration.",
+            "Use the manual snippet below as reference for the values to enter."
+        };
+
+        public override McpStatus CheckStatus(bool attemptAutoRewrite = true)
+        {
+            client.SetStatus(McpStatus.NotConfigured, "Cherry Studio requires manual UI configuration");
+            return client.status;
+        }
+
+        public override void Configure()
+        {
+            throw new InvalidOperationException(
+                "Cherry Studio uses UI-based configuration. " +
+                "Please use the Manual Configuration snippet and Installation Steps to configure manually."
+            );
+        }
+
+        public override string GetManualSnippet()
+        {
+            bool useHttp = EditorPrefs.GetBool(EditorPrefKeys.UseHttpTransport, true);
+
+            if (useHttp)
+            {
+                return "# Cherry Studio does not support WebSocket transport.\n" +
+                       "# Cherry Studio supports STDIO and SSE transports.\n" +
+                       "# \n" +
+                       "# To use Cherry Studio:\n" +
+                       "# 1. Switch transport to 'Stdio' in Advanced Settings below\n" +
+                       "# 2. Return to this configuration screen\n" +
+                       "# 3. Copy the STDIO configuration snippet that will appear\n" +
+                       "# \n" +
+                       "# OPTION 2: SSE mode (future support)\n" +
+                       "# Note: Unity MCP does not currently have an SSE endpoint.\n" +
+                       "# This may be added in a future update.";
+            }
+
+            return base.GetManualSnippet() + "\n\n" +
+                   "# Cherry Studio Configuration Instructions:\n" +
+                   "# Cherry Studio uses UI-based configuration, not a JSON file.\n" +
+                   "# \n" +
+                   "# To configure:\n" +
+                   "# 1. Open Cherry Studio\n" +
+                   "# 2. Go to Settings (⚙️) → MCP Server\n" +
+                   "# 3. Click 'Add Server'\n" +
+                   "# 4. Enter the following values from the JSON above:\n" +
+                   "#    - Name: unity-mcp\n" +
+                   "#    - Type: STDIO\n" +
+                   "#    - Command: (copy 'command' value from JSON)\n" +
+                   "#    - Arguments: (copy 'args' array values, space-separated or as individual entries)\n" +
+                   "#    - Active: true\n" +
+                   "# 5. Click Save\n" +
+                   "# 6. Restart Cherry Studio";
+        }
+    }
+}