feat(opencode): native opencode integration — /mcpctl switcher, live project switching, footer indicator
Adds `mcpctl config opencode`, two opencode plugins and an `opencode` skills
sync target, so an mcpctl project can be switched from inside opencode's TUI
and the active one is visible at a glance.
Unlike `config claude` / `config prime-agent`, this writes NO MCP entry into
the host's config. opencode exposes an HTTP API for its own MCP registry
(`POST /mcp`), so the project is mounted through the running app:
- the token stays in ~/.mcpctl/opencode-state.json (0600) instead of a
mode-0644 opencode.json users paste into bug reports;
- switching projects takes effect on the next turn, with no restart.
Inside opencode:
/mcpctl filterable project picker; switches live
/mcpctl-status active project, mount state, gateway URL
/mcpctl-skills re-sync this project's skills
plus a `mcpctl:<project>` indicator in the prompt footer, next to the model
name and one line above the token counter.
Design notes:
- the MCP server is registered under a constant name, so tools keep a stable
`mcpctl_*` prefix and opencode's per-request tool resolution shows the new
project's tools by itself — no "your old tool names are dead" message to
the model, unlike the pi extension;
- an unchanged mount is never re-registered: mcp.add rebuilds the connection
and mcplocal binds a gated project's unlocked state to that connection's
mcp-session-id, so re-adding would re-lock a project begin_session had just
opened;
- the server plugin does not mount during setup — setup runs before the
server accepts connections and mcp.add calls back into it, which hangs
opencode on a blank screen before the TUI draws;
- the switcher shells out to this CLI (--skip-plugin --skip-marker) so token
minting, state and skills stay in one place;
- no usable credential aborts non-zero with the state file untouched, so a
failed switch leaves the previous project working rather than swapping it
for a mount that 401s.
`skills sync --agent opencode` installs into ~/.config/opencode/skill (XDG
aware) with the same shared-tree semantics as pi and prime-agent. The
credential plumbing shared with `config prime-agent` is lifted to one place and
parameterised by agent rather than copied.
The plugin sources are embedded in the CLI (generated, freshness-tested) so an
installed binary with no source tree can provision them, and are typechecked
against the real @opencode-ai/plugin types.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BVwuCjuMoA13gmzYEfcrNP
2026-08-08 21:03:53 +01:00
|
|
|
|
import { describe, it, expect } from 'vitest';
|
|
|
|
|
|
import { readFileSync } from 'node:fs';
|
|
|
|
|
|
import { join } from 'node:path';
|
|
|
|
|
|
import {
|
|
|
|
|
|
OPENCODE_SERVER_PLUGIN_SOURCE,
|
|
|
|
|
|
OPENCODE_TUI_PLUGIN_SOURCE,
|
|
|
|
|
|
OPENCODE_SERVER_PLUGIN_FILENAME,
|
|
|
|
|
|
OPENCODE_TUI_PLUGIN_FILENAME,
|
|
|
|
|
|
} from '../../src/config/opencode-extension.js';
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
|
* `mcpctl config opencode` installs the *embedded* copy of the plugins, not the
|
|
|
|
|
|
* files in src/opencode-ext/. Editing the sources without re-running the
|
|
|
|
|
|
* generator therefore ships stale code to users while the repo looks correct —
|
|
|
|
|
|
* and the embedded copy is the one thing no typecheck covers. Same guarantee
|
|
|
|
|
|
* the completions check gives.
|
|
|
|
|
|
*/
|
|
|
|
|
|
const repoRoot = join(import.meta.dirname, '..', '..', '..', '..');
|
|
|
|
|
|
const extDir = join(repoRoot, 'src', 'opencode-ext');
|
|
|
|
|
|
|
|
|
|
|
|
describe('embedded opencode plugins', () => {
|
|
|
|
|
|
it('match the sources in src/opencode-ext (re-run scripts/generate-opencode-extension.ts)', () => {
|
|
|
|
|
|
expect(OPENCODE_SERVER_PLUGIN_SOURCE, 'server plugin is stale — regenerate the embed')
|
|
|
|
|
|
.toBe(readFileSync(join(extDir, 'mcpctl-opencode.ts'), 'utf-8'));
|
|
|
|
|
|
expect(OPENCODE_TUI_PLUGIN_SOURCE, 'TUI plugin is stale — regenerate the embed')
|
|
|
|
|
|
.toBe(readFileSync(join(extDir, 'mcpctl-opencode-tui.tsx'), 'utf-8'));
|
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
|
|
it('install under names opencode can actually load', () => {
|
|
|
|
|
|
// The server plugin is auto-discovered from plugin/*.ts; the TUI plugin is
|
|
|
|
|
|
// referenced by path from tui.json and must stay .tsx for its JSX to be
|
|
|
|
|
|
// transpiled.
|
|
|
|
|
|
expect(OPENCODE_SERVER_PLUGIN_FILENAME).toBe('mcpctl.ts');
|
|
|
|
|
|
expect(OPENCODE_TUI_PLUGIN_FILENAME).toBe('mcpctl-tui.tsx');
|
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
|
|
it('are self-contained — the installed files have no mcpctl imports to resolve', () => {
|
|
|
|
|
|
for (const src of [OPENCODE_SERVER_PLUGIN_SOURCE, OPENCODE_TUI_PLUGIN_SOURCE]) {
|
|
|
|
|
|
expect(src).not.toMatch(/from '@mcpctl\//);
|
|
|
|
|
|
expect(src).not.toMatch(/from '\.\.\//);
|
|
|
|
|
|
}
|
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
|
|
it('keep the JSX pragma the TUI plugin needs to render its indicator', () => {
|
|
|
|
|
|
expect(OPENCODE_TUI_PLUGIN_SOURCE.startsWith('/** @jsxImportSource @opentui/solid */')).toBe(true);
|
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
|
|
it('agree on the MCP server name, so a switch re-points one mount instead of stacking two', () => {
|
|
|
|
|
|
for (const src of [OPENCODE_SERVER_PLUGIN_SOURCE, OPENCODE_TUI_PLUGIN_SOURCE]) {
|
|
|
|
|
|
expect(src).toContain("const SERVER_NAME = 'mcpctl'");
|
|
|
|
|
|
}
|
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
|
|
it('agree on the state file both read', () => {
|
|
|
|
|
|
for (const src of [OPENCODE_SERVER_PLUGIN_SOURCE, OPENCODE_TUI_PLUGIN_SOURCE]) {
|
|
|
|
|
|
expect(src).toContain("join(homedir(), '.mcpctl', 'opencode-state.json')");
|
|
|
|
|
|
}
|
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
|
|
it('spawn the CLI without a shell, so a project name is never interpolated into a command string', () => {
|
|
|
|
|
|
expect(OPENCODE_TUI_PLUGIN_SOURCE).toContain("execFile('mcpctl', args");
|
|
|
|
|
|
expect(OPENCODE_TUI_PLUGIN_SOURCE).not.toMatch(/\bexecSync\s*\(/);
|
|
|
|
|
|
expect(OPENCODE_TUI_PLUGIN_SOURCE).not.toMatch(/\bexec\(`/);
|
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
|
|
it('sync skills into opencode’s own tree, never Claude’s', () => {
|
|
|
|
|
|
expect(OPENCODE_TUI_PLUGIN_SOURCE).toContain("'--agent', 'opencode'");
|
|
|
|
|
|
});
|
|
|
|
|
|
|
2026-08-09 18:02:52 +01:00
|
|
|
|
it('bind the switcher to a chord as well as a slash command', () => {
|
|
|
|
|
|
// Switching is the repeated action; typing /mcpctl every time is friction.
|
|
|
|
|
|
expect(OPENCODE_TUI_PLUGIN_SOURCE).toContain("slashName: 'mcpctl'");
|
|
|
|
|
|
expect(OPENCODE_TUI_PLUGIN_SOURCE).toContain("key: '<leader>m'");
|
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
|
|
it('tear the outgoing mount down before re-pointing it', () => {
|
|
|
|
|
|
// An abandoned client keeps its mcp-session-id — and a gated project's
|
|
|
|
|
|
// unlocked state — alive on mcplocal.
|
|
|
|
|
|
expect(OPENCODE_TUI_PLUGIN_SOURCE).toContain('mcp.disconnect({ name: SERVER_NAME })');
|
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
|
|
it('clip rather than wrap the footer label on the narrow home prompt', () => {
|
|
|
|
|
|
expect(OPENCODE_TUI_PLUGIN_SOURCE).toContain('wrapMode="none"');
|
|
|
|
|
|
});
|
|
|
|
|
|
|
feat(opencode): native opencode integration — /mcpctl switcher, live project switching, footer indicator
Adds `mcpctl config opencode`, two opencode plugins and an `opencode` skills
sync target, so an mcpctl project can be switched from inside opencode's TUI
and the active one is visible at a glance.
Unlike `config claude` / `config prime-agent`, this writes NO MCP entry into
the host's config. opencode exposes an HTTP API for its own MCP registry
(`POST /mcp`), so the project is mounted through the running app:
- the token stays in ~/.mcpctl/opencode-state.json (0600) instead of a
mode-0644 opencode.json users paste into bug reports;
- switching projects takes effect on the next turn, with no restart.
Inside opencode:
/mcpctl filterable project picker; switches live
/mcpctl-status active project, mount state, gateway URL
/mcpctl-skills re-sync this project's skills
plus a `mcpctl:<project>` indicator in the prompt footer, next to the model
name and one line above the token counter.
Design notes:
- the MCP server is registered under a constant name, so tools keep a stable
`mcpctl_*` prefix and opencode's per-request tool resolution shows the new
project's tools by itself — no "your old tool names are dead" message to
the model, unlike the pi extension;
- an unchanged mount is never re-registered: mcp.add rebuilds the connection
and mcplocal binds a gated project's unlocked state to that connection's
mcp-session-id, so re-adding would re-lock a project begin_session had just
opened;
- the server plugin does not mount during setup — setup runs before the
server accepts connections and mcp.add calls back into it, which hangs
opencode on a blank screen before the TUI draws;
- the switcher shells out to this CLI (--skip-plugin --skip-marker) so token
minting, state and skills stay in one place;
- no usable credential aborts non-zero with the state file untouched, so a
failed switch leaves the previous project working rather than swapping it
for a mount that 401s.
`skills sync --agent opencode` installs into ~/.config/opencode/skill (XDG
aware) with the same shared-tree semantics as pi and prime-agent. The
credential plumbing shared with `config prime-agent` is lifted to one place and
parameterised by agent rather than copied.
The plugin sources are embedded in the CLI (generated, freshness-tested) so an
installed binary with no source tree can provision them, and are typechecked
against the real @opencode-ai/plugin types.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BVwuCjuMoA13gmzYEfcrNP
2026-08-08 21:03:53 +01:00
|
|
|
|
it('switch without rewriting the plugin file opencode has already loaded', () => {
|
|
|
|
|
|
expect(OPENCODE_TUI_PLUGIN_SOURCE).toContain("'--skip-plugin'");
|
|
|
|
|
|
expect(OPENCODE_TUI_PLUGIN_SOURCE).toContain("'--skip-marker'");
|
|
|
|
|
|
});
|
|
|
|
|
|
});
|