Skip to content

Commit 2e3d4d8

Browse files
feat(mcp): simplify remote MCP setup for remote workspaces (anomalyco#747)
* feat(mcp): simplify remote MCP setup and cover with e2e test * fix(mcp): apply remote runtime changes before OAuth retry
1 parent ef7b2e4 commit 2e3d4d8

11 files changed

Lines changed: 135 additions & 17 deletions

File tree

‎packages/app/src/app/app.tsx‎

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3350,13 +3350,38 @@ export default function App() {
33503350
const canReloadLocalEngine = () =>
33513351
isTauriRuntime() && workspaceStore.activeWorkspaceDisplay().workspaceType === "local";
33523352

3353-
const canReloadWorkspace = createMemo(() => canReloadLocalEngine());
3353+
const canReloadWorkspace = createMemo(() => {
3354+
if (canReloadLocalEngine()) return true;
3355+
if (workspaceStore.activeWorkspaceDisplay().workspaceType !== "remote") return false;
3356+
return openworkServerStatus() === "connected" && Boolean(openworkServerClient() && openworkServerWorkspaceId());
3357+
});
33543358

33553359
const reloadWorkspaceEngineFromUi = async () => {
3356-
if (!canReloadLocalEngine()) {
3360+
if (canReloadLocalEngine()) {
3361+
return workspaceStore.reloadWorkspaceEngine();
3362+
}
3363+
3364+
if (workspaceStore.activeWorkspaceDisplay().workspaceType !== "remote") {
3365+
return false;
3366+
}
3367+
3368+
const client = openworkServerClient();
3369+
const workspaceId = openworkServerWorkspaceId();
3370+
if (!client || !workspaceId || openworkServerStatus() !== "connected") {
3371+
setError("Connect to this worker before applying runtime changes.");
3372+
return false;
3373+
}
3374+
3375+
try {
3376+
await client.reloadEngine(workspaceId);
3377+
await workspaceStore.activateWorkspace(workspaceStore.activeWorkspaceId());
3378+
await refreshMcpServers();
3379+
return true;
3380+
} catch (error) {
3381+
const message = error instanceof Error ? error.message : "Failed to apply runtime changes.";
3382+
setError(message);
33573383
return false;
33583384
}
3359-
return workspaceStore.reloadWorkspaceEngine();
33603385
};
33613386

33623387
const systemState = createSystemState({
@@ -5756,6 +5781,7 @@ export default function App() {
57565781
refreshSoulData: (options?: { force?: boolean }) => refreshSoulData(options).catch(() => undefined),
57575782
runSoulPrompt,
57585783
activeWorkspaceRoot: workspaceStore.activeWorkspaceRoot().trim(),
5784+
isRemoteWorkspace: workspaceStore.activeWorkspaceDisplay().workspaceType === "remote",
57595785
refreshSkills: (options?: { force?: boolean }) => refreshSkills(options).catch(() => undefined),
57605786
refreshHubSkills: (options?: { force?: boolean }) => refreshHubSkills(options).catch(() => undefined),
57615787
refreshPlugins: (scopeOverride?: PluginScope) =>

‎packages/app/src/app/components/add-mcp-modal.tsx‎

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ export type AddMcpModalProps = {
1010
onClose: () => void;
1111
onAdd: (entry: McpDirectoryInfo) => void;
1212
busy: boolean;
13+
isRemoteWorkspace: boolean;
1314
language: Language;
1415
};
1516

@@ -20,13 +21,15 @@ export default function AddMcpModal(props: AddMcpModalProps) {
2021
const [serverType, setServerType] = createSignal<"remote" | "local">("remote");
2122
const [url, setUrl] = createSignal("");
2223
const [command, setCommand] = createSignal("");
24+
const [oauthRequired, setOauthRequired] = createSignal(false);
2325
const [error, setError] = createSignal<string | null>(null);
2426

2527
const reset = () => {
2628
setName("");
2729
setServerType("remote");
2830
setUrl("");
2931
setCommand("");
32+
setOauthRequired(false);
3033
setError(null);
3134
};
3235

@@ -56,7 +59,7 @@ export default function AddMcpModal(props: AddMcpModalProps) {
5659
description: "",
5760
type: "remote",
5861
url: trimmedUrl,
59-
oauth: true,
62+
oauth: oauthRequired(),
6063
});
6164
} else {
6265
const trimmedCommand = command().trim();
@@ -129,25 +132,43 @@ export default function AddMcpModal(props: AddMcpModalProps) {
129132
</button>
130133
<button
131134
type="button"
135+
disabled={props.isRemoteWorkspace}
132136
class={`px-3 py-1.5 rounded-lg text-xs font-medium transition-colors ${
133137
serverType() === "local"
134138
? "bg-dls-active text-dls-text"
135139
: "text-dls-secondary hover:text-dls-text hover:bg-dls-hover"
136-
}`}
137-
onClick={() => setServerType("local")}
140+
} ${props.isRemoteWorkspace ? "opacity-50 cursor-not-allowed" : ""}`}
141+
onClick={() => {
142+
if (props.isRemoteWorkspace) return;
143+
setServerType("local");
144+
}}
138145
>
139146
{tr("mcp.type_local_cmd")}
140147
</button>
141148
</div>
149+
<Show when={props.isRemoteWorkspace}>
150+
<div class="mt-2 text-[11px] text-dls-secondary">{tr("mcp.remote_workspace_url_hint")}</div>
151+
</Show>
142152
</div>
143153

144154
<Show when={serverType() === "remote"}>
145-
<TextInput
146-
label={tr("mcp.server_url")}
147-
placeholder={tr("mcp.server_url_placeholder")}
148-
value={url()}
149-
onInput={(e) => setUrl(e.currentTarget.value)}
150-
/>
155+
<div class="space-y-3">
156+
<TextInput
157+
label={tr("mcp.server_url")}
158+
placeholder={tr("mcp.server_url_placeholder")}
159+
value={url()}
160+
onInput={(e) => setUrl(e.currentTarget.value)}
161+
/>
162+
<label class="flex items-center gap-2 text-xs text-dls-secondary">
163+
<input
164+
type="checkbox"
165+
class="h-4 w-4 rounded border border-dls-border"
166+
checked={oauthRequired()}
167+
onChange={(event) => setOauthRequired(event.currentTarget.checked)}
168+
/>
169+
{tr("mcp.oauth_optional_label")}
170+
</label>
171+
</div>
151172
</Show>
152173

153174
<Show when={serverType() === "local"}>

‎packages/app/src/app/components/mcp-auth-modal.tsx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -341,6 +341,10 @@ export default function McpAuthModal(props: McpAuthModalProps) {
341341

342342
const handleReloadAndRetry = async () => {
343343
if (!props.onReloadEngine) return;
344+
if (props.isRemoteWorkspace && typeof window !== "undefined") {
345+
const proceed = window.confirm(translate("mcp.auth.reload_remote_confirm"));
346+
if (!proceed) return;
347+
}
344348
await props.onReloadEngine();
345349
startAuth(true);
346350
};

‎packages/app/src/app/pages/dashboard.tsx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,7 @@ export type DashboardViewProps = {
167167
refreshSoulData: (options?: { force?: boolean }) => void;
168168
runSoulPrompt: (prompt: string) => void;
169169
activeWorkspaceRoot: string;
170+
isRemoteWorkspace: boolean;
170171
refreshSkills: (options?: { force?: boolean }) => void;
171172
refreshHubSkills: (options?: { force?: boolean }) => void;
172173
refreshPlugins: (scopeOverride?: PluginScope) => void;
@@ -1215,6 +1216,7 @@ export default function DashboardView(props: DashboardViewProps) {
12151216
setDashboardTab={props.setTab}
12161217
busy={props.busy}
12171218
activeWorkspaceRoot={props.activeWorkspaceRoot}
1219+
isRemoteWorkspace={props.isRemoteWorkspace}
12181220
refreshMcpServers={props.refreshMcpServers}
12191221
mcpServers={props.mcpServers}
12201222
mcpStatus={props.mcpStatus}

‎packages/app/src/app/pages/extensions.tsx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,7 @@ export default function ExtensionsView(props: ExtensionsViewProps) {
128128
showHeader={false}
129129
busy={props.busy}
130130
activeWorkspaceRoot={props.activeWorkspaceRoot}
131+
isRemoteWorkspace={props.isRemoteWorkspace}
131132
mcpServers={props.mcpServers}
132133
mcpStatus={props.mcpStatus}
133134
mcpLastUpdatedAt={props.mcpLastUpdatedAt}

‎packages/app/src/app/pages/mcp.tsx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ import { currentLocale, t, type Language } from "../../i18n";
3333
export type McpViewProps = {
3434
busy: boolean;
3535
activeWorkspaceRoot: string;
36+
isRemoteWorkspace: boolean;
3637
showHeader?: boolean;
3738
mcpServers: McpServerEntry[];
3839
mcpStatus: string | null;
@@ -686,6 +687,7 @@ export default function McpView(props: McpViewProps) {
686687
onClose={() => setAddMcpModalOpen(false)}
687688
onAdd={(entry) => props.connectMcp(entry)}
688689
busy={props.busy}
690+
isRemoteWorkspace={props.isRemoteWorkspace}
689691
language={locale()}
690692
/>
691693
</section>

‎packages/app/src/i18n/locales/en.ts‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -444,6 +444,8 @@ export default {
444444
"mcp.server_command": "Command",
445445
"mcp.server_command_placeholder": "npx -y @modelcontextprotocol/server-sequential-thinking",
446446
"mcp.server_command_hint": "The shell command to start the server.",
447+
"mcp.oauth_optional_label": "Requires OAuth sign-in",
448+
"mcp.remote_workspace_url_hint": "Remote workers connect fastest with URL-based MCP servers.",
447449
"mcp.add_server_button": "Add server",
448450
"mcp.name_required": "Enter a server name.",
449451
"mcp.url_or_command_required": "Enter a URL for remote or a command for local servers.",
@@ -463,12 +465,13 @@ export default {
463465
"mcp.auth.already_connected": "Already Connected",
464466
"mcp.auth.already_connected_description": "{server} is already authenticated and ready to use.",
465467
"mcp.auth.configured_previously": "The MCP may have been configured globally or in a previous session. You can close this modal and start using the MCP tools right away.",
466-
"mcp.auth.reload_engine_retry": "Reload engine and retry",
468+
"mcp.auth.reload_engine_retry": "Apply changes and retry",
467469
"mcp.auth.retry_now": "Retry Now",
468470
"mcp.auth.retry": "Retry",
469471
"mcp.auth.reload_before_oauth": "Reload the engine to finish setting up this MCP before starting OAuth.",
470-
"mcp.auth.reload_notice": "Finish setup by reloading the engine to activate this MCP. This is a required step, not an error.",
472+
"mcp.auth.reload_notice": "For this to take effect, OpenWork needs to refresh the worker service. This can interrupt a running session.",
471473
"mcp.auth.reload_blocked": "Reload is paused while a session is running. Stop the run to finish setup.",
474+
"mcp.auth.reload_remote_confirm": "For this to take effect, OpenWork needs to refresh the worker service. This might stop your running session. Continue?",
472475
"mcp.auth.reload_needed": "Finish setup by reloading the engine, then try connecting again.",
473476
"mcp.auth.manual_finish_title": "Remote server?",
474477
"mcp.auth.manual_finish_hint": "Paste the callback URL (localhost:19876) or just the code to finish connecting.",

‎packages/app/src/i18n/locales/zh.ts‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -381,6 +381,8 @@ export default {
381381
"mcp.server_command": "命令",
382382
"mcp.server_command_placeholder": "npx -y @modelcontextprotocol/server-sequential-thinking",
383383
"mcp.server_command_hint": "启动服务器的 shell 命令。",
384+
"mcp.oauth_optional_label": "需要 OAuth 登录",
385+
"mcp.remote_workspace_url_hint": "远程工作区建议优先使用 URL 类型的 MCP 服务器。",
384386
"mcp.add_server_button": "添加服务器",
385387
"mcp.name_required": "请输入服务器名称。",
386388
"mcp.url_or_command_required": "远程服务器需要 URL,本地服务器需要命令。",
@@ -434,7 +436,10 @@ export default {
434436
"mcp.auth.already_connected": "已连接",
435437
"mcp.auth.already_connected_description": "{server} 已通过身份验证,可以正常使用。",
436438
"mcp.auth.configured_previously": "该 MCP 可能在全局或之前的会话中已配置。您可以关闭此弹窗,立即开始使用 MCP 工具。",
437-
"mcp.auth.reload_engine_retry": "重新加载引擎并重试",
439+
"mcp.auth.reload_engine_retry": "应用更改并重试",
440+
"mcp.auth.reload_notice": "要使更改生效,OpenWork 需要刷新 worker 服务。这可能会中断正在运行的会话。",
441+
"mcp.auth.reload_blocked": "会话运行中,暂时无法刷新。请先停止运行后再完成设置。",
442+
"mcp.auth.reload_remote_confirm": "要使更改生效,OpenWork 需要刷新 worker 服务。这可能会停止您正在运行的会话。是否继续?",
438443
"mcp.auth.retry_now": "立即重试",
439444
"mcp.auth.retry": "重试",
440445
"mcp.auth.step1_title": "正在打开您的浏览器",
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
import { describe, expect, test } from "bun:test";
2+
import { mkdtemp, readFile, rm } from "node:fs/promises";
3+
import { join } from "node:path";
4+
import { tmpdir } from "node:os";
5+
6+
import { addMcp, listMcp, removeMcp } from "./mcp.js";
7+
8+
describe("mcp remote connect flow", () => {
9+
test("adds, lists, and removes a remote MCP without OAuth", async () => {
10+
const workspaceRoot = await mkdtemp(join(tmpdir(), "openwork-mcp-remote-e2e-"));
11+
12+
try {
13+
const added = await addMcp(workspaceRoot, "simple-remote", {
14+
type: "remote",
15+
url: "https://example.com/mcp",
16+
enabled: true,
17+
});
18+
expect(added.action).toBe("added");
19+
20+
const listedAfterAdd = await listMcp(workspaceRoot);
21+
const item = listedAfterAdd.find((entry) => entry.name === "simple-remote");
22+
expect(item).toBeDefined();
23+
expect(item?.config).toEqual({
24+
type: "remote",
25+
url: "https://example.com/mcp",
26+
enabled: true,
27+
});
28+
expect(item?.source).toBe("config.project");
29+
30+
const configText = await readFile(join(workspaceRoot, "opencode.jsonc"), "utf8");
31+
expect(configText).toContain("\"simple-remote\"");
32+
expect(configText).toContain("\"https://example.com/mcp\"");
33+
34+
const removed = await removeMcp(workspaceRoot, "simple-remote");
35+
expect(removed).toBe(true);
36+
37+
const listedAfterRemove = await listMcp(workspaceRoot);
38+
expect(listedAfterRemove.some((entry) => entry.name === "simple-remote")).toBe(false);
39+
} finally {
40+
await rm(workspaceRoot, { recursive: true, force: true });
41+
}
42+
});
43+
});

‎packages/server/src/server.ts‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2447,10 +2447,21 @@ function createRoutes(config: ServerConfig, approvals: ApprovalService, tokens:
24472447

24482448
addRoute(routes, "POST", "/workspace/:id/engine/reload", "client", async (ctx) => {
24492449
const workspace = await resolveWorkspace(config, ctx.params.id);
2450-
throw new ApiError(410, "engine_reload_deprecated", "OpenWork-managed engine reload is disabled", {
2450+
requireClientScope(ctx, "collaborator");
2451+
2452+
await reloadOpencodeEngine(workspace);
2453+
2454+
await recordAudit(workspace.path, {
2455+
id: shortId(),
24512456
workspaceId: workspace.id,
2452-
guidance: "Use OpenCode hot reload instead",
2457+
actor: ctx.actor ?? { type: "remote" },
2458+
action: "engine.reload",
2459+
target: workspace.baseUrl ?? "opencode",
2460+
summary: "Reloaded workspace engine",
2461+
timestamp: Date.now(),
24532462
});
2463+
2464+
return jsonResponse({ ok: true, reloadedAt: Date.now() });
24542465
});
24552466

24562467
addRoute(routes, "GET", "/workspace/:id/inbox", "client", async (ctx) => {

0 commit comments

Comments
 (0)