mirror of
https://github.com/Kilo-Org/kilocode.git
synced 2026-09-19 01:51:21 +08:00
Merge pull request #6375 from Kilo-Org/jl-fix-cli-mcp-docs
Fix CLI MCP docs
This commit is contained in:
Joshua Lambert
@@ -1,109 +1,182 @@
|
||||
---
|
||||
title: "Using MCP in CLI"
|
||||
description: "How to use MCP servers in the CLI"
|
||||
description: "How to configure and use MCP servers in the Kilo CLI"
|
||||
---
|
||||
|
||||
# Using MCP in the CLI
|
||||
|
||||
The Kilo Code CLI supports MCP servers, but uses a **different configuration path** than the VS Code extension.
|
||||
The Kilo CLI supports both local and remote MCP servers. Once added, MCP tools are automatically available to the LLM alongside built-in tools.
|
||||
|
||||
{% callout type="tip" %}
|
||||
MCP servers add to your context, so be careful with which ones you enable. Certain MCP servers with many tools can quickly add up and exceed the context limit.
|
||||
{% /callout %}
|
||||
|
||||
## Configuration Location
|
||||
|
||||
| Environment | MCP Settings Path |
|
||||
| ----------- | --------------------------------------------------- |
|
||||
| **CLI** | `~/.kilocode/cli/global/settings/mcp_settings.json` |
|
||||
| **VS Code** | VS Code's global storage directory |
|
||||
The CLI accepts several config filenames. The recommended file is `kilo.json`:
|
||||
|
||||
MCP servers configured in VS Code are **not** automatically available in the CLI. You must configure them separately.
|
||||
| Scope | Recommended Path | Also supported |
|
||||
| ----------- | ------------------------------------ | --------------------------- |
|
||||
| **Global** | `~/.config/kilo/kilo.json` | `kilo.jsonc`, `config.json` |
|
||||
| **Project** | `./kilo.json` or `./.kilo/kilo.json` | `kilo.jsonc` |
|
||||
|
||||
Project-level configuration takes precedence over global settings.
|
||||
|
||||
## Configuration Format
|
||||
|
||||
Edit `~/.kilocode/cli/global/settings/mcp_settings.json`:
|
||||
Add MCP servers under the `mcp` key in your config file. Each server has a unique name that you can reference in prompts.
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"server-name": {
|
||||
"command": "node",
|
||||
"args": ["/path/to/server.js"],
|
||||
"env": {
|
||||
"API_KEY": "your_api_key"
|
||||
},
|
||||
"alwaysAllow": ["tool1", "tool2"],
|
||||
"disabled": false
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Transport Types
|
||||
|
||||
### STDIO (Local Servers)
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"local-server": {
|
||||
"command": "node",
|
||||
"args": ["/path/to/server.js"],
|
||||
"env": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Streamable HTTP (Remote Servers)
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"remote-server": {
|
||||
"type": "streamable-http",
|
||||
"url": "https://your-server.com/mcp",
|
||||
"headers": {
|
||||
"Authorization": "Bearer token"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Project-Level Configuration
|
||||
|
||||
You can define MCP servers per-project by creating `.kilocode/mcp.json` in your project root. Project-level servers take precedence over global settings.
|
||||
|
||||
## Configuration Options
|
||||
|
||||
| Option | Description |
|
||||
| ------------- | ----------------------------------------------------------- |
|
||||
| `command` | Executable to run (STDIO) |
|
||||
| `args` | Command arguments (STDIO) |
|
||||
| `env` | Environment variables |
|
||||
| `type` | Transport type: `stdio` (default), `streamable-http`, `sse` |
|
||||
| `url` | Server URL (HTTP transports) |
|
||||
| `headers` | HTTP headers (HTTP transports) |
|
||||
| `alwaysAllow` | Array of tool names to auto-approve |
|
||||
| `disabled` | Set `true` to disable without removing |
|
||||
| `timeout` | Request timeout in seconds (default: 60) |
|
||||
|
||||
## Auto-Approval
|
||||
|
||||
MCP auto-approval is controlled via CLI config (`kilocode config`):
|
||||
|
||||
```json
|
||||
{
|
||||
"autoApproval": {
|
||||
"mcp": {
|
||||
"mcp": {
|
||||
"my-server": {
|
||||
"type": "local",
|
||||
"command": ["npx", "-y", "my-mcp-command"],
|
||||
"enabled": true
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Or via environment variable:
|
||||
You can disable a server by setting `enabled` to `false` without removing it from your config.
|
||||
|
||||
```bash
|
||||
export KILO_AUTO_APPROVAL_MCP_ENABLED=true
|
||||
## Transport Types
|
||||
|
||||
### Local Servers
|
||||
|
||||
Local MCP servers run on your machine and communicate via standard input/output. Set `type` to `"local"`.
|
||||
|
||||
```json
|
||||
{
|
||||
"mcp": {
|
||||
"my-local-server": {
|
||||
"type": "local",
|
||||
"command": ["npx", "-y", "my-mcp-command"],
|
||||
"enabled": true,
|
||||
"environment": {
|
||||
"API_KEY": "your_api_key"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Per-tool auto-approval uses the `alwaysAllow` array in the server configuration.
|
||||
#### Local Server Options
|
||||
|
||||
| Option | Type | Required | Description |
|
||||
| ------------- | ------- | -------- | -------------------------------------------------------------------- |
|
||||
| `type` | String | Yes | Must be `"local"`. |
|
||||
| `command` | Array | Yes | Command and arguments to run the MCP server. |
|
||||
| `environment` | Object | No | Environment variables to set when running the server. |
|
||||
| `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: 5000. |
|
||||
|
||||
### Remote Servers
|
||||
|
||||
Remote MCP servers are accessed over HTTP/HTTPS. Set `type` to `"remote"`.
|
||||
|
||||
```json
|
||||
{
|
||||
"mcp": {
|
||||
"my-remote-server": {
|
||||
"type": "remote",
|
||||
"url": "https://my-mcp-server.com/mcp",
|
||||
"enabled": true,
|
||||
"headers": {
|
||||
"Authorization": "Bearer MY_API_KEY"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Remote Server Options
|
||||
|
||||
| Option | Type | Required | Description |
|
||||
| --------- | ------- | -------- | -------------------------------------------------------------------- |
|
||||
| `type` | String | Yes | Must be `"remote"`. |
|
||||
| `url` | String | Yes | URL of the remote MCP server. |
|
||||
| `enabled` | Boolean | No | Enable or disable the MCP server on startup. |
|
||||
| `headers` | Object | No | HTTP headers to send with requests. |
|
||||
| `timeout` | Number | No | Timeout in ms for fetching tools from the MCP server. Default: 5000. |
|
||||
|
||||
## Managing MCP Servers
|
||||
|
||||
You can manage MCP servers from the CLI:
|
||||
|
||||
| Command | Description |
|
||||
| --------------- | ------------------------------- |
|
||||
| `kilo mcp list` | List all configured MCP servers |
|
||||
| `kilo mcp add` | Add an MCP server |
|
||||
| `kilo mcp auth` | Authenticate with an MCP server |
|
||||
|
||||
Inside the interactive TUI, use the `/mcps` slash command to toggle MCP servers on or off.
|
||||
|
||||
## Examples
|
||||
|
||||
### Figma Desktop
|
||||
|
||||
Connect to the Figma Desktop app's MCP server:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcp": {
|
||||
"Figma Desktop": {
|
||||
"type": "remote",
|
||||
"url": "http://127.0.0.1:3845/mcp"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Context7
|
||||
|
||||
Add the [Context7](https://github.com/upstash/context7) MCP server for documentation search:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcp": {
|
||||
"context7": {
|
||||
"type": "remote",
|
||||
"url": "https://mcp.context7.com/mcp"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Everything Test Server
|
||||
|
||||
Add the test MCP server for development:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcp": {
|
||||
"mcp_everything": {
|
||||
"type": "local",
|
||||
"command": ["npx", "-y", "@modelcontextprotocol/server-everything"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
Use `{env:VARIABLE_NAME}` syntax in config files to reference environment variables:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcp": {
|
||||
"my-server": {
|
||||
"type": "remote",
|
||||
"url": "https://mcp.example.com/mcp",
|
||||
"headers": {
|
||||
"Authorization": "Bearer {env:MY_API_KEY}"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Finding MCP Servers
|
||||
|
||||
Browse community-contributed MCP server configurations and agent skills in the [Kilo Marketplace](https://github.com/Kilo-Org/kilo-marketplace). The marketplace includes ready-to-use configs for popular tools like Figma, Sentry, and more.
|
||||
|
||||
Reference in New Issue
Block a user