Skip to content

Commit 36e4b29

Browse files
committed
Add OpenCode MCP support
1 parent ce437db commit 36e4b29

9 files changed

Lines changed: 269 additions & 2 deletions

File tree

‎packages/cli/src/__tests__/lib/EnvironmentSelector.test.ts‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,20 @@ describe('EnvironmentSelector', () => {
119119
expect(getMcpConfigPath('kilocode')).toBe('.kilo/kilo.jsonc');
120120
});
121121

122+
it('includes OpenCode with project skills, global skills, and MCP', () => {
123+
expect(isValidEnvironmentCode('opencode')).toBe(true);
124+
expect(getEnvironment('opencode')).toMatchObject({
125+
code: 'opencode',
126+
name: 'OpenCode',
127+
skillPath: '.opencode/skills',
128+
globalSkillPath: '.config/opencode/skills',
129+
mcpConfigPath: 'opencode.json',
130+
});
131+
expect(getSkillPath('opencode')).toBe('.opencode/skills');
132+
expect(getGlobalSkillPath('opencode')).toBe('.config/opencode/skills');
133+
expect(getMcpConfigPath('opencode')).toBe('opencode.json');
134+
});
135+
122136
it('includes Pi with project and global skill paths', () => {
123137
expect(isValidEnvironmentCode('pi')).toBe(true);
124138
expect(getEnvironment('pi')).toMatchObject({

‎packages/cli/src/__tests__/services/install/mcp/McpConfigGenerator.test.ts‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,13 @@ vi.mock('../../../../services/install/mcp/KiloCodeMcpGenerator.js', () => ({
7070
apply: (...args: unknown[]) => mockApply(...args),
7171
}; }),
7272
}));
73+
vi.mock('../../../../services/install/mcp/OpenCodeMcpGenerator.js', () => ({
74+
OpenCodeMcpGenerator: vi.fn().mockImplementation(function () { return {
75+
agentType: 'opencode' as EnvironmentCode,
76+
plan: (...args: unknown[]) => mockPlan(...args),
77+
apply: (...args: unknown[]) => mockApply(...args),
78+
}; }),
79+
}));
7380

7481
import { installMcpServers } from '../../../../services/install/mcp/McpConfigGenerator.js';
7582

@@ -185,6 +192,22 @@ describe('McpConfigGenerator (orchestrator)', () => {
185192
expect(report.installed).toBe(1);
186193
});
187194

195+
it('installs MCP servers for OpenCode when OpenCode is configured', async () => {
196+
mockPlan.mockResolvedValue({
197+
agentType: 'opencode',
198+
newServers: ['memory'],
199+
conflictServers: [],
200+
skippedServers: [],
201+
resolvedConflicts: [],
202+
});
203+
204+
const report = await installMcpServers(servers, ['opencode'], '/project');
205+
206+
expect(mockPlan).toHaveBeenCalledTimes(1);
207+
expect(mockApply).toHaveBeenCalledTimes(1);
208+
expect(report.installed).toBe(1);
209+
});
210+
188211
it('skips agents without MCP support', async () => {
189212
mockHasMcpSupport.mockReturnValue(false);
190213

Lines changed: 161 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,161 @@
1+
import type { Mocked } from 'vitest';
2+
import fs from 'fs-extra';
3+
import * as path from 'path';
4+
import { OpenCodeMcpGenerator } from '../../../../services/install/mcp/OpenCodeMcpGenerator.js';
5+
import { McpServerDefinition } from '../../../../types.js';
6+
7+
vi.mock('fs-extra', async () => { const { makeFsExtraMock } = await import('../../../__shared__/fs-extra-mock.js'); return makeFsExtraMock(); });
8+
9+
const mockFs = fs as Mocked<typeof fs>;
10+
11+
describe('OpenCodeMcpGenerator', () => {
12+
let generator: OpenCodeMcpGenerator;
13+
const projectRoot = '/project';
14+
15+
beforeEach(() => {
16+
vi.clearAllMocks();
17+
generator = new OpenCodeMcpGenerator();
18+
});
19+
20+
it('marks all servers as new when no existing opencode.json exists', async () => {
21+
mockFs.pathExists.mockResolvedValue(false as never);
22+
23+
const servers: Record<string, McpServerDefinition> = {
24+
memory: { transport: 'stdio', command: 'npx', args: ['-y', '@ai-devkit/memory'] },
25+
docs: { transport: 'http', url: 'https://mcp.example.com/mcp' },
26+
};
27+
28+
const plan = await generator.plan(servers, projectRoot);
29+
30+
expect(plan.newServers).toEqual(['memory', 'docs']);
31+
expect(plan.conflictServers).toEqual([]);
32+
expect(plan.skippedServers).toEqual([]);
33+
});
34+
35+
it('skips servers that already exist with identical OpenCode config', async () => {
36+
mockFs.pathExists.mockResolvedValue(true as never);
37+
mockFs.readFile.mockResolvedValue(JSON.stringify({
38+
mcp: {
39+
memory: {
40+
type: 'local',
41+
command: ['npx', '-y', '@ai-devkit/memory'],
42+
enabled: true,
43+
},
44+
},
45+
}) as never);
46+
47+
const servers: Record<string, McpServerDefinition> = {
48+
memory: { transport: 'stdio', command: 'npx', args: ['-y', '@ai-devkit/memory'] },
49+
};
50+
51+
const plan = await generator.plan(servers, projectRoot);
52+
53+
expect(plan.skippedServers).toEqual(['memory']);
54+
expect(plan.newServers).toEqual([]);
55+
expect(plan.conflictServers).toEqual([]);
56+
});
57+
58+
it('detects conflicts when server exists with different config', async () => {
59+
mockFs.pathExists.mockResolvedValue(true as never);
60+
mockFs.readFile.mockResolvedValue(JSON.stringify({
61+
mcp: {
62+
memory: {
63+
type: 'local',
64+
command: ['node', 'old-server.js'],
65+
enabled: true,
66+
},
67+
},
68+
}) as never);
69+
70+
const servers: Record<string, McpServerDefinition> = {
71+
memory: { transport: 'stdio', command: 'npx', args: ['-y', '@ai-devkit/memory'] },
72+
};
73+
74+
const plan = await generator.plan(servers, projectRoot);
75+
76+
expect(plan.conflictServers).toEqual(['memory']);
77+
expect(plan.newServers).toEqual([]);
78+
});
79+
80+
it('writes MCP servers to opencode.json and preserves unmanaged config', async () => {
81+
mockFs.pathExists.mockResolvedValue(true as never);
82+
mockFs.readFile.mockResolvedValue(JSON.stringify({
83+
$schema: 'https://opencode.ai/config.json',
84+
theme: 'system',
85+
tools: {
86+
'custom_*': false,
87+
},
88+
mcp: {
89+
custom: {
90+
type: 'local',
91+
command: ['my-custom-server'],
92+
enabled: true,
93+
},
94+
},
95+
}) as never);
96+
97+
const servers: Record<string, McpServerDefinition> = {
98+
memory: { transport: 'stdio', command: 'npx', args: ['-y', '@ai-devkit/memory'], env: { DB: './db' } },
99+
browser: { transport: 'http', url: 'https://mcp.example.com/mcp', headers: { Authorization: 'Bearer token' } },
100+
};
101+
102+
await generator.apply(
103+
{ agentType: 'opencode', newServers: ['memory', 'browser'], conflictServers: [], skippedServers: [], resolvedConflicts: [] },
104+
servers,
105+
projectRoot
106+
);
107+
108+
expect(mockFs.ensureDir).toHaveBeenCalledWith(projectRoot);
109+
expect(mockFs.writeFile).toHaveBeenCalledWith(
110+
path.join(projectRoot, 'opencode.json'),
111+
expect.any(String)
112+
);
113+
expect(JSON.parse(mockFs.writeFile.mock.calls[0]![1] as string)).toEqual({
114+
$schema: 'https://opencode.ai/config.json',
115+
theme: 'system',
116+
tools: {
117+
'custom_*': false,
118+
},
119+
mcp: {
120+
custom: {
121+
type: 'local',
122+
command: ['my-custom-server'],
123+
enabled: true,
124+
},
125+
memory: {
126+
type: 'local',
127+
command: ['npx', '-y', '@ai-devkit/memory'],
128+
environment: { DB: './db' },
129+
enabled: true,
130+
},
131+
browser: {
132+
type: 'remote',
133+
url: 'https://mcp.example.com/mcp',
134+
enabled: true,
135+
headers: { Authorization: 'Bearer token' },
136+
},
137+
},
138+
});
139+
});
140+
141+
it('maps sse transport to remote OpenCode server config', async () => {
142+
mockFs.pathExists.mockResolvedValue(false as never);
143+
144+
const servers: Record<string, McpServerDefinition> = {
145+
legacy: { transport: 'sse', url: 'https://api.example.com/sse' },
146+
};
147+
148+
await generator.apply(
149+
{ agentType: 'opencode', newServers: ['legacy'], conflictServers: [], skippedServers: [], resolvedConflicts: [] },
150+
servers,
151+
projectRoot
152+
);
153+
154+
const written = JSON.parse((mockFs.writeFile.mock.calls[0]![1] as string));
155+
expect(written.mcp.legacy).toEqual({
156+
type: 'remote',
157+
url: 'https://api.example.com/sse',
158+
enabled: true,
159+
});
160+
});
161+
});

‎packages/cli/src/__tests__/util/env.test.ts‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -407,6 +407,11 @@ describe('Environment Utilities', () => {
407407
expect(hasMcpSupport('kilocode')).toBe(true);
408408
expect(getMcpConfigPath('kilocode')).toBe('.kilo/kilo.jsonc');
409409
});
410+
411+
it('should return MCP config path for opencode', () => {
412+
expect(hasMcpSupport('opencode')).toBe(true);
413+
expect(getMcpConfigPath('opencode')).toBe('opencode.json');
414+
});
410415
});
411416

412417
});

‎packages/cli/src/services/install/mcp/McpConfigGenerator.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import { GitHubCopilotMcpGenerator } from './GitHubCopilotMcpGenerator.js';
99
import { DevinMcpGenerator } from './DevinMcpGenerator.js';
1010
import { RooCodeMcpGenerator } from './RooCodeMcpGenerator.js';
1111
import { KiloCodeMcpGenerator } from './KiloCodeMcpGenerator.js';
12+
import { OpenCodeMcpGenerator } from './OpenCodeMcpGenerator.js';
1213
import { confirm, select } from '@inquirer/prompts';
1314

1415
export interface McpInstallOptions {
@@ -23,6 +24,7 @@ const GENERATORS: McpAgentGenerator[] = [
2324
new DevinMcpGenerator(),
2425
new RooCodeMcpGenerator(),
2526
new KiloCodeMcpGenerator(),
27+
new OpenCodeMcpGenerator(),
2628
];
2729

2830
export async function installMcpServers(
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
import fs from 'fs-extra';
2+
import * as path from 'path';
3+
import { EnvironmentCode, McpServerDefinition } from '../../../types.js';
4+
import { BaseMcpGenerator } from './BaseMcpGenerator.js';
5+
6+
interface OpenCodeConfig {
7+
mcp?: Record<string, Record<string, unknown>>;
8+
[key: string]: unknown;
9+
}
10+
11+
export class OpenCodeMcpGenerator extends BaseMcpGenerator {
12+
readonly agentType: EnvironmentCode = 'opencode';
13+
14+
private fullConfig: OpenCodeConfig = {};
15+
16+
protected toAgentFormat(def: McpServerDefinition): Record<string, unknown> {
17+
if (def.transport === 'stdio') {
18+
const entry: Record<string, unknown> = {
19+
type: 'local',
20+
command: [def.command!, ...(def.args || [])],
21+
enabled: true,
22+
};
23+
if (def.env && Object.keys(def.env).length > 0) entry.environment = def.env;
24+
return entry;
25+
}
26+
27+
const entry: Record<string, unknown> = {
28+
type: 'remote',
29+
url: def.url!,
30+
enabled: true,
31+
};
32+
if (def.headers && Object.keys(def.headers).length > 0) entry.headers = def.headers;
33+
return entry;
34+
}
35+
36+
protected async readExistingServers(projectRoot: string): Promise<Record<string, unknown>> {
37+
const configPath = path.join(projectRoot, 'opencode.json');
38+
try {
39+
if (await fs.pathExists(configPath)) {
40+
const content = await fs.readFile(configPath, 'utf8');
41+
this.fullConfig = JSON.parse(content || '{}') as OpenCodeConfig;
42+
return (this.fullConfig.mcp || {}) as Record<string, unknown>;
43+
}
44+
} catch {
45+
// Malformed file — treat as empty.
46+
}
47+
this.fullConfig = {};
48+
return {};
49+
}
50+
51+
protected async writeServers(
52+
projectRoot: string,
53+
mergedServers: Record<string, unknown>
54+
): Promise<void> {
55+
const output = { ...this.fullConfig, mcp: mergedServers };
56+
const configPath = path.join(projectRoot, 'opencode.json');
57+
await fs.ensureDir(path.dirname(configPath));
58+
await fs.writeFile(configPath, `${JSON.stringify(output, null, 2)}\n`);
59+
}
60+
}

‎packages/cli/src/util/env.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ export const ENVIRONMENT_DEFINITIONS: Record<EnvironmentCode, EnvironmentDefinit
5252
name: 'OpenCode',
5353
skillPath: '.opencode/skills',
5454
globalSkillPath: '.config/opencode/skills',
55+
mcpConfigPath: 'opencode.json',
5556
},
5657
roo: {
5758
code: 'roo',

‎web/content/docs/2-supported-agents.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ These environments are fully supported with stable integrations.
5656
- `AGENTS.md` — OpenCode [custom instructions](https://opencode.ai/docs/rules/)
5757
- `.opencode/skills/` — Project-level skills
5858
- `~/.config/opencode/skills/` — Global skills
59+
- `opencode.json` — Project-level MCP server configuration under the `mcp` key
5960

6061
### [Antigravity](https://antigravity.google/)
6162
**What AI DevKit provides:**

‎web/content/docs/9-agent-setup.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ ai-devkit install --overwrite
7575

7676
Based on your configured environments, AI DevKit installs or updates files such as:
7777
- Agent skill files (for example `.cursor/skills/`, `.claude/skills/`, `.github/skills/` for GitHub Copilot, `.devin/skills/`, and `.agents/skills/` for Codex) refer [Skills](/docs/7-skills) for more on skills
78-
- MCP server configuration files (`.mcp.json` for Claude Code and GitHub Copilot, `.codex/config.toml` for Codex, `.junie/mcp/mcp.json` for Junie, `.devin/config.json` for Devin, `.roo/mcp.json` for Roo Code, `.kilo/kilo.jsonc` for Kilo Code)
78+
- MCP server configuration files (`.mcp.json` for Claude Code and GitHub Copilot, `.codex/config.toml` for Codex, `opencode.json` for OpenCode, `.junie/mcp/mcp.json` for Junie, `.devin/config.json` for Devin, `.roo/mcp.json` for Roo Code, `.kilo/kilo.jsonc` for Kilo Code)
7979
- Other environment-specific templates defined by AI DevKit
8080

8181
The exact artifacts depend on the environments configured in `.ai-devkit.json`. `ai-devkit install` only manages project-local files generated from that config.
@@ -178,7 +178,7 @@ When using a template with a `skills` section, skills from the template are inst
178178

179179
> **Note:** `mcpServers` generation and install flow require AI DevKit `0.23.0` or later.
180180

181-
MCP configuration is currently generated for **Claude Code** (`.mcp.json`), **GitHub Copilot** (`.mcp.json`), **Codex** (`.codex/config.toml`), **Junie** (`.junie/mcp/mcp.json`), **Devin** (`.devin/config.json`), **Roo Code** (`.roo/mcp.json`), and **Kilo Code** (`.kilo/kilo.jsonc`).
181+
MCP configuration is currently generated for **Claude Code** (`.mcp.json`), **GitHub Copilot** (`.mcp.json`), **Codex** (`.codex/config.toml`), **OpenCode** (`opencode.json`), **Junie** (`.junie/mcp/mcp.json`), **Devin** (`.devin/config.json`), **Roo Code** (`.roo/mcp.json`), and **Kilo Code** (`.kilo/kilo.jsonc`).
182182

183183
If your project uses only environments that do not currently support MCP generation, AI DevKit still saves the `mcpServers` definitions in `.ai-devkit.json`, but no environment-specific MCP config files are created.
184184

0 commit comments

Comments
 (0)