README shows how to connect to the server
Why it matters
An MCP server without a connection example in its README forces every new user to read source code before they can use it. Unlike standard npm packages where the import pattern is obvious, MCP clients require a specific JSON config block with command, args, and env — there is no discoverable default. The MCP spec defines mcpServers configuration as the integration point; without it documented, adoption stalls and users connect incorrectly, leading to silent failures or version mismatches.
Severity rationale
Info because missing connection docs create friction and integration errors but do not expose security vulnerabilities or corrupt data.
Remediation
Add a Setup section to your README with the exact mcpServers JSON block for at least one client.
## Setup
Add to `~/.claude/claude_desktop_config.json` (Claude Code) or `~/.cursor/mcp.json` (Cursor):
```json
{
"mcpServers": {
"my-server": {
"command": "npx",
"args": ["-y", "my-mcp-server@latest"],
"env": {
"API_KEY": "your-api-key-here"
}
}
}
}
Include which env vars are required vs. optional, and list which MCP clients have been tested against this server.
DetectionPro
The detection method for this pattern is part of AuditBuffet Pro.
The full method (what to look for, pass and fail conditions, and how results get reported) ships inside the MCP Server Audit. The pattern definition, severity rationale, and remediation remain openly licensed under CC-BY-4.0.
External references
- external · mcp-spec-client-config — MCP Specification — Client configuration and mcpServers JSON
Taxons
History
- 2026-04-18·v1.0.0·Initial import from mcp-server·automated