Skip to content

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

Open
ken-jo wants to merge 1 commit into
superagent-ai:mainfrom
ken-jo:docs/fix-mcp-config-key
Open

docs: fix MCP server config example to match the loader (mcp.servers, not mcpServers)#334
ken-jo wants to merge 1 commit into
superagent-ai:mainfrom
ken-jo:docs/fix-mcp-config-key

Conversation

@ken-jo

@ken-jo ken-jo commented Jun 21, 2026

Copy link
Copy Markdown

What does this PR do?

The README points MCP users at .grok/settings.json with an mcpServers key, but loadMcpServers() (src/utils/settings.ts) reads them from ~/.grok/user-settings.json under a nested mcp.servers array (return loadUserSettings().mcp?.servers ?? []). So following the README puts servers under the wrong key in the wrong file, and they silently never load.

This corrects the feature-table reference (file + key) and adds a short example using the real McpServerConfig shape (id, label, enabled, transport, plus the stdio/http fields). Docs-only — no loader or runtime change.

(No tracking issue — direct documentation correction.)

Checklist

  • I tested my changes — verified the documented file/key/shape against loadMcpServers() and the McpServerConfig interface in src/utils/settings.ts
  • I reviewed my own code

🤖 Generated with Claude Code

… not mcpServers)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@open-cla

open-cla Bot commented Jun 21, 2026

Copy link
Copy Markdown

Contributor License Agreement

All contributors are covered by a CLA.

@superagent-security

Copy link
Copy Markdown

Superagent didn't find any vulnerabilities or security issues in this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant