mirror of
https://github.com/Kilo-Org/kilocode.git
synced 2026-09-19 10:02:04 +08:00
docs(kilo-docs): remove outdated video and reorder MCP tabs
Remove the outdated YouTube video from the Using MCP in Kilo Code page. Ensure 'VSCode (Legacy)' is always the last tab option in every section for consistency.
This commit is contained in:
Josh Lambert
@@ -7,8 +7,6 @@ description: "How to use MCP servers in Kilo Code"
|
||||
|
||||
Model Context Protocol (MCP) extends Kilo Code's capabilities by connecting to external tools and services. This guide covers everything you need to know about using MCP with Kilo Code.
|
||||
|
||||
{% youtube url="https://youtu.be/6O9RQoQRX8A" caption="Demonstrating MCP installation in Kilo Code" /%}
|
||||
|
||||
## Configuring MCP Servers
|
||||
|
||||
{% tabs %}
|
||||
@@ -73,6 +71,16 @@ MCP servers are configured under the `mcp` key in `kilo.jsonc`:
|
||||
|
||||
Remote servers support OAuth 2.0 authentication. If the server supports it, Kilo Code will automatically start the OAuth flow when you connect. You can also disable OAuth with `"oauth": false`.
|
||||
|
||||
{% /tab %}
|
||||
{% tab label="CLI" %}
|
||||
|
||||
The CLI accepts several config filenames. The recommended file is `kilo.json`:
|
||||
|
||||
| Scope | Recommended Path | Also supported |
|
||||
| ----------- | ------------------------------------ | -------------------------------------------------------------- |
|
||||
| **Global** | `~/.config/kilo/kilo.json` | `kilo.jsonc`, `opencode.json`, `opencode.jsonc`, `config.json` |
|
||||
| **Project** | `./kilo.json` or `./.kilo/kilo.json` | `kilo.jsonc`, `opencode.jsonc`, `opencode.json` |
|
||||
|
||||
{% /tab %}
|
||||
{% tab label="VSCode (Legacy)" %}
|
||||
|
||||
@@ -85,45 +93,12 @@ MCP server configurations can be managed at two levels: **global** (applies acro
|
||||
|
||||
Project-level configs can be committed to version control to share with your team.
|
||||
|
||||
{% /tab %}
|
||||
{% tab label="CLI" %}
|
||||
|
||||
The CLI accepts several config filenames. The recommended file is `kilo.json`:
|
||||
|
||||
| Scope | Recommended Path | Also supported |
|
||||
| ----------- | ------------------------------------ | -------------------------------------------------------------- |
|
||||
| **Global** | `~/.config/kilo/kilo.json` | `kilo.jsonc`, `opencode.json`, `opencode.jsonc`, `config.json` |
|
||||
| **Project** | `./kilo.json` or `./.kilo/kilo.json` | `kilo.jsonc`, `opencode.jsonc`, `opencode.json` |
|
||||
|
||||
{% /tab %}
|
||||
{% /tabs %}
|
||||
|
||||
## Configuration Format
|
||||
|
||||
{% tabs %}
|
||||
{% tab label="VSCode (Legacy)" %}
|
||||
|
||||
Both global and project-level files use a JSON format with a `mcpServers` object containing named server configurations:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"server1": {
|
||||
"command": "python",
|
||||
"args": ["/path/to/server.py"],
|
||||
"env": {
|
||||
"API_KEY": "your_api_key"
|
||||
},
|
||||
"alwaysAllow": ["tool1", "tool2"],
|
||||
"disabled": false
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
_Example of MCP Server config in Kilo Code (STDIO Transport)_
|
||||
|
||||
{% /tab %}
|
||||
{% tab label="VSCode" %}
|
||||
|
||||
In the VS Code extension, open **Settings → MCP** and click **Add Server** to configure a new server through the UI. You can also edit the config files directly — see the **CLI** tab for the JSON format.
|
||||
@@ -147,6 +122,29 @@ Add MCP servers under the `mcp` key in your config file. Each server has a uniqu
|
||||
|
||||
You can disable a server by setting `enabled` to `false` without removing it from your config.
|
||||
|
||||
{% /tab %}
|
||||
{% tab label="VSCode (Legacy)" %}
|
||||
|
||||
Both global and project-level files use a JSON format with a `mcpServers` object containing named server configurations:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"server1": {
|
||||
"command": "python",
|
||||
"args": ["/path/to/server.py"],
|
||||
"env": {
|
||||
"API_KEY": "your_api_key"
|
||||
},
|
||||
"alwaysAllow": ["tool1", "tool2"],
|
||||
"disabled": false
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
_Example of MCP Server config in Kilo Code (STDIO Transport)_
|
||||
|
||||
{% /tab %}
|
||||
{% /tabs %}
|
||||
|
||||
@@ -174,25 +172,6 @@ For more in-depth information about how STDIO transport works, see [STDIO Transp
|
||||
STDIO configuration example:
|
||||
|
||||
{% tabs %}
|
||||
{% tab label="VSCode (Legacy)" %}
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"local-server": {
|
||||
"command": "node",
|
||||
"args": ["/path/to/server.js"],
|
||||
"env": {
|
||||
"API_KEY": "your_api_key"
|
||||
},
|
||||
"alwaysAllow": ["tool1", "tool2"],
|
||||
"disabled": false
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
{% /tab %}
|
||||
{% tab label="VSCode" %}
|
||||
|
||||
In the VS Code extension, open **Settings → MCP**, click **Add Server**, and choose **Local (stdio)**. Fill in the command, arguments, and optional environment variables through the UI. You can also edit the config files directly — see the **CLI** tab for the JSON format.
|
||||
@@ -225,6 +204,25 @@ In the VS Code extension, open **Settings → MCP**, click **Add Server**, and c
|
||||
| `enabled` | Boolean | No | Enable or disable the MCP server on startup. |
|
||||
| `timeout` | Number | No | Timeout in ms for fetching tools from the MCP server. Default: 30000. |
|
||||
|
||||
{% /tab %}
|
||||
{% tab label="VSCode (Legacy)" %}
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"local-server": {
|
||||
"command": "node",
|
||||
"args": ["/path/to/server.js"],
|
||||
"env": {
|
||||
"API_KEY": "your_api_key"
|
||||
},
|
||||
"alwaysAllow": ["tool1", "tool2"],
|
||||
"disabled": false
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
{% /tab %}
|
||||
{% /tabs %}
|
||||
|
||||
@@ -238,25 +236,6 @@ Used for remote servers accessed over HTTP/HTTPS:
|
||||
- Allows centralized deployment and management
|
||||
|
||||
{% tabs %}
|
||||
{% tab label="VSCode (Legacy)" %}
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"remote-server": {
|
||||
"type": "streamable-http",
|
||||
"url": "https://your-server-url.com/mcp",
|
||||
"headers": {
|
||||
"Authorization": "Bearer your-token"
|
||||
},
|
||||
"alwaysAllow": ["tool3"],
|
||||
"disabled": false
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
{% /tab %}
|
||||
{% tab label="VSCode" %}
|
||||
|
||||
In the VS Code extension, open **Settings → MCP**, click **Add Server**, and choose **Remote (HTTP)**. Enter the server URL and optional headers through the UI. You can also edit the config files directly — see the **CLI** tab for the JSON format.
|
||||
@@ -289,6 +268,25 @@ In the VS Code extension, open **Settings → MCP**, click **Add Server**, and c
|
||||
| `headers` | Object | No | HTTP headers to send with requests. |
|
||||
| `timeout` | Number | No | Timeout in ms for fetching tools from the MCP server. Default: 30000. |
|
||||
|
||||
{% /tab %}
|
||||
{% tab label="VSCode (Legacy)" %}
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"remote-server": {
|
||||
"type": "streamable-http",
|
||||
"url": "https://your-server-url.com/mcp",
|
||||
"headers": {
|
||||
"Authorization": "Bearer your-token"
|
||||
},
|
||||
"alwaysAllow": ["tool3"],
|
||||
"disabled": false
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
{% /tab %}
|
||||
{% /tabs %}
|
||||
|
||||
@@ -326,37 +324,6 @@ SSE configuration example:
|
||||
## Managing MCP Servers
|
||||
|
||||
{% tabs %}
|
||||
{% tab label="VSCode (Legacy)" %}
|
||||
|
||||
### Editing MCP Settings Files
|
||||
|
||||
You can edit both global and project-level MCP configuration files directly from the Kilo Code settings.
|
||||
|
||||
1. Click the {% codicon name="gear" /%} icon in the top navigation of the Kilo Code pane to open `Settings`.
|
||||
2. Click the `Agent Behaviour` tab on the left side
|
||||
3. Select the `MCP Servers` sub-tab
|
||||
4. Click the appropriate button:
|
||||
- **`Edit Global MCP`**: Opens the global `mcp_settings.json` file.
|
||||
- **`Edit Project MCP`**: Opens the project-specific `.kilocode/mcp.json` file. If this file doesn't exist, Kilo Code will create it for you.
|
||||
|
||||
{% image src="/docs/img/using-mcp-in-kilo-code/mcp-installed-config.png" alt="Edit Global MCP and Edit Project MCP buttons" width="600" caption="Edit Global MCP and Edit Project MCP buttons" /%}
|
||||
|
||||
### Deleting a Server
|
||||
|
||||
1. Press the {% codicon name="trash" /%} next to the MCP server you would like to delete
|
||||
2. Press the `Delete` button on the confirmation box
|
||||
|
||||
{% image src="/docs/img/using-mcp-in-kilo-code/using-mcp-in-kilo-code-5.png" alt="Delete confirmation box" width="400" caption="Delete confirmation box" /%}
|
||||
|
||||
### Restarting a Server
|
||||
|
||||
1. Press the {% codicon name="refresh" /%} button next to the MCP server you would like to restart
|
||||
|
||||
### Enabling or Disabling a Server
|
||||
|
||||
1. Press the {% codicon name="activate" /%} toggle switch next to the MCP server to enable/disable it
|
||||
|
||||
{% /tab %}
|
||||
{% tab label="VSCode" %}
|
||||
|
||||
In the VS Code extension, manage MCP servers from **Settings → MCP**:
|
||||
@@ -400,6 +367,37 @@ Use `{env:VARIABLE_NAME}` syntax in config files to reference environment variab
|
||||
}
|
||||
```
|
||||
|
||||
{% /tab %}
|
||||
{% tab label="VSCode (Legacy)" %}
|
||||
|
||||
### Editing MCP Settings Files
|
||||
|
||||
You can edit both global and project-level MCP configuration files directly from the Kilo Code settings.
|
||||
|
||||
1. Click the {% codicon name="gear" /%} icon in the top navigation of the Kilo Code pane to open `Settings`.
|
||||
2. Click the `Agent Behaviour` tab on the left side
|
||||
3. Select the `MCP Servers` sub-tab
|
||||
4. Click the appropriate button:
|
||||
- **`Edit Global MCP`**: Opens the global `mcp_settings.json` file.
|
||||
- **`Edit Project MCP`**: Opens the project-specific `.kilocode/mcp.json` file. If this file doesn't exist, Kilo Code will create it for you.
|
||||
|
||||
{% image src="/docs/img/using-mcp-in-kilo-code/mcp-installed-config.png" alt="Edit Global MCP and Edit Project MCP buttons" width="600" caption="Edit Global MCP and Edit Project MCP buttons" /%}
|
||||
|
||||
### Deleting a Server
|
||||
|
||||
1. Press the {% codicon name="trash" /%} next to the MCP server you would like to delete
|
||||
2. Press the `Delete` button on the confirmation box
|
||||
|
||||
{% image src="/docs/img/using-mcp-in-kilo-code/using-mcp-in-kilo-code-5.png" alt="Delete confirmation box" width="400" caption="Delete confirmation box" /%}
|
||||
|
||||
### Restarting a Server
|
||||
|
||||
1. Press the {% codicon name="refresh" /%} button next to the MCP server you would like to restart
|
||||
|
||||
### Enabling or Disabling a Server
|
||||
|
||||
1. Press the {% codicon name="activate" /%} toggle switch next to the MCP server to enable/disable it
|
||||
|
||||
{% /tab %}
|
||||
{% /tabs %}
|
||||
|
||||
@@ -410,6 +408,11 @@ Use `{env:VARIABLE_NAME}` syntax in config files to reference environment variab
|
||||
|
||||
Set the `timeout` field (in milliseconds) in the server's config entry. The default is 10 seconds for local servers and 15 seconds for remote servers.
|
||||
|
||||
{% /tab %}
|
||||
{% tab label="CLI" %}
|
||||
|
||||
Set the `timeout` field (in milliseconds) in the server's config entry. The default is 30000 (30 seconds).
|
||||
|
||||
{% /tab %}
|
||||
{% tab label="VSCode (Legacy)" %}
|
||||
|
||||
@@ -442,6 +445,24 @@ MCP tool calls use the same permission system as built-in tools. Each MCP tool's
|
||||
}
|
||||
```
|
||||
|
||||
{% /tab %}
|
||||
{% tab label="CLI" %}
|
||||
|
||||
Add `alwaysAllow` entries to your server config to auto-approve specific tools:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcp": {
|
||||
"my-server": {
|
||||
"type": "local",
|
||||
"command": ["npx", "-y", "my-mcp-server"],
|
||||
"enabled": true,
|
||||
"alwaysAllow": ["tool1", "tool2"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
{% /tab %}
|
||||
{% tab label="VSCode (Legacy)" %}
|
||||
|
||||
@@ -461,48 +482,6 @@ When enabled, Kilo Code will automatically approve this specific tool without pr
|
||||
## Platform-Specific MCP Configuration Examples
|
||||
|
||||
{% tabs %}
|
||||
{% tab label="VSCode (Legacy)" %}
|
||||
|
||||
### Windows Configuration Example
|
||||
|
||||
When setting up MCP servers on Windows, you'll need to use the Windows Command Prompt (`cmd`) to execute commands. Here's an example of configuring a Puppeteer MCP server on Windows:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"puppeteer": {
|
||||
"command": "cmd",
|
||||
"args": ["/c", "npx", "-y", "@modelcontextprotocol/server-puppeteer"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
This Windows-specific configuration:
|
||||
|
||||
- Uses the `cmd` command to access the Windows Command Prompt
|
||||
- Uses `/c` to tell cmd to execute the command and then terminate
|
||||
- Uses `npx` to run the package without installing it permanently
|
||||
- The `-y` flag automatically answers "yes" to any prompts during installation
|
||||
- Runs the `@modelcontextprotocol/server-puppeteer` package which provides browser automation capabilities
|
||||
|
||||
{% callout type="note" %}
|
||||
For macOS or Linux, you would use a different configuration:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"puppeteer": {
|
||||
"command": "npx",
|
||||
"args": ["-y", "@modelcontextprotocol/server-puppeteer"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
{% /callout %}
|
||||
|
||||
{% /tab %}
|
||||
{% tab label="VSCode" %}
|
||||
|
||||
In the VS Code extension, use **Settings → MCP → Add Server** to add any of the examples below through the UI. You can also edit the config files directly — see the **CLI** tab for the JSON format.
|
||||
@@ -573,6 +552,48 @@ Add the test MCP server for development:
|
||||
}
|
||||
```
|
||||
|
||||
{% /tab %}
|
||||
{% tab label="VSCode (Legacy)" %}
|
||||
|
||||
### Windows Configuration Example
|
||||
|
||||
When setting up MCP servers on Windows, you'll need to use the Windows Command Prompt (`cmd`) to execute commands. Here's an example of configuring a Puppeteer MCP server on Windows:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"puppeteer": {
|
||||
"command": "cmd",
|
||||
"args": ["/c", "npx", "-y", "@modelcontextprotocol/server-puppeteer"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
This Windows-specific configuration:
|
||||
|
||||
- Uses the `cmd` command to access the Windows Command Prompt
|
||||
- Uses `/c` to tell cmd to execute the command and then terminate
|
||||
- Uses `npx` to run the package without installing it permanently
|
||||
- The `-y` flag automatically answers "yes" to any prompts during installation
|
||||
- Runs the `@modelcontextprotocol/server-puppeteer` package which provides browser automation capabilities
|
||||
|
||||
{% callout type="note" %}
|
||||
For macOS or Linux, you would use a different configuration:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"puppeteer": {
|
||||
"command": "npx",
|
||||
"args": ["-y", "@modelcontextprotocol/server-puppeteer"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
{% /callout %}
|
||||
|
||||
{% /tab %}
|
||||
{% /tabs %}
|
||||
|
||||
@@ -607,14 +628,6 @@ Example: "Analyze the performance of my API" might use an MCP tool that tests AP
|
||||
- **`failed` status:** Check the CLI output for error details. Ensure commands and paths are correct.
|
||||
- **Tool Not Available:** Confirm the server is properly implementing the tool and it's not disabled in settings.
|
||||
|
||||
{% /tab %}
|
||||
{% tab label="VSCode (Legacy)" %}
|
||||
|
||||
- **Server Not Responding:** Check if the server process is running and verify network connectivity
|
||||
- **Permission Errors:** Ensure proper API keys and credentials are configured in your `mcp_settings.json` (for global settings) or `.kilocode/mcp.json` (for project settings).
|
||||
- **Tool Not Available:** Confirm the server is properly implementing the tool and it's not disabled in settings
|
||||
- **Slow Performance:** Try adjusting the network timeout value for the specific MCP server
|
||||
|
||||
{% /tab %}
|
||||
{% tab label="CLI" %}
|
||||
|
||||
@@ -623,6 +636,14 @@ Example: "Analyze the performance of my API" might use an MCP tool that tests AP
|
||||
- **Tool Not Available:** Confirm the server is properly implementing the tool and it is not disabled (`"enabled": false`) in your config.
|
||||
- **Slow Performance:** Increase the `timeout` value for the specific MCP server in your config.
|
||||
|
||||
{% /tab %}
|
||||
{% tab label="VSCode (Legacy)" %}
|
||||
|
||||
- **Server Not Responding:** Check if the server process is running and verify network connectivity
|
||||
- **Permission Errors:** Ensure proper API keys and credentials are configured in your `mcp_settings.json` (for global settings) or `.kilocode/mcp.json` (for project settings).
|
||||
- **Tool Not Available:** Confirm the server is properly implementing the tool and it's not disabled in settings
|
||||
- **Slow Performance:** Try adjusting the network timeout value for the specific MCP server
|
||||
|
||||
{% /tab %}
|
||||
{% /tabs %}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user