Home/Config Files/settings.json
Config File Wiki

settings.json config guide

Editor and agent settings for VS Code-like tools, extensions, formatters, and MCP integrations.

Field explanations

  • Top-level settings define the tool behavior
  • Environment-specific blocks override defaults
  • Paths are usually relative to the config file or project root
  • Secrets should be referenced, not committed

Minimal template

{
  "name": "example",
  "enabled": true
}

Common usage patterns

  • Keep settings.json small and reviewable
  • Use comments only when the format supports them
  • Commit example files with placeholder values
  • Validate locally before deploying

Common errors

  • User setting overrides workspace
  • Invalid JSON with comments in strict parser
  • Path uses Windows backslashes incorrectly
  • Extension reads old config after restart

Online validation

Validate syntax first, then compare behavior against your deploy target. For JSON-based configs, use the JSON formatter before debugging tool-specific behavior.

Related tools