Skip to content

docs: fix MCP server config example to match the loader (mcp.servers, not mcpServers) #334

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ken-jo wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix MCP server config example to match the loader (mcp.servers, not mcpServers) #334

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ You keep using a text model for the session, and Grok saves generated media unde
| **Remote control** | Pair **Telegram** from the TUI (`/remote-control` → Telegram): DM your bot, `**/pair`**, approve the code in-terminal. Keep the CLI running while you ping it from your phone. |
| **No “mystery meat” UI** | OpenTUI React terminal UI—fast, keyboard-driven, not whatever glitchy thing you’re thinking of. |
| **Skills** | Agent Skills under `**.agents/skills/<name>/SKILL.md`** (project) or `**~/.agents/skills/`** (user). Use `**/skills**` in the TUI to list what’s installed. |
| **MCPs** | Extend with Model Context Protocol servers—configure via `**/mcps`** in the TUI or `**.grok/settings.json`** (`mcpServers`). |
| **MCPs** | Extend with Model Context Protocol servers—configure via `**/mcps`** in the TUI or `**~/.grok/user-settings.json`** (`mcp.servers`). |
| **Sessions** | Conversations persist; `**--session latest`** picks up where you left off. |
| **Headless** | `**--prompt`** / `**-p`** for non-interactive runs—pipe it, script it, bench it. |
| **Hackable** | TypeScript, clear agent loop, bash-first tools—fork it, shamelessly. |
Expand Down Expand Up @@ -237,6 +237,25 @@ Optional `**subAgents**` — custom foreground sub-agents. Each entry needs `**n

Names cannot be `general`, `explore`, `vision`, `verify`, or `computer` because those are reserved for the built-in sub-agents.

Optional `**mcp.servers**` — Model Context Protocol servers. Each entry needs `**id**`, `**label**`, `**enabled**`, and `**transport**` (`stdio`, `http`, or `sse`); `stdio` adds `**command**`/`**args**`/`**env**`/`**cwd**`, while `http`/`sse` add `**url**`/`**headers**`:

```json
{
"mcp": {
"servers": [
{
"id": "filesystem",
"label": "Filesystem",
"enabled": true,
"transport": "stdio",
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-filesystem", "."]
}
]
}
}
```

Optional: `**GROK_BASE_URL**` (default `https://api.x.ai/v1`), `**GROK_MODEL**`, `**GROK_MAX_TOKENS**`.

---
Expand Down