Skip to content

docs(config): add config schema file#236

Open
haosenwang1018 wants to merge 2 commits intophilschmid:mainfrom
haosenwang1018:docs/add-config-schema-file-issue32
Open

docs(config): add config schema file#236
haosenwang1018 wants to merge 2 commits intophilschmid:mainfrom
haosenwang1018:docs/add-config-schema-file-issue32

Conversation

@haosenwang1018
Copy link
Copy Markdown

Summary

  • add a first-class mcp_servers.schema.json at the repo root
  • document how to use the schema via the $schema field in mcp_servers.json
  • highlight editor validation/autocomplete for config fields like command, url, and tool filters

Why

Closes #32.

The config format is described in the README, but there was no schema file that editors could consume directly for validation and autocomplete. This adds that missing schema and shows users how to wire it up.

Testing

  • validated schema structure manually against the documented config shapes used by src/config.ts
  • verified README examples reference the new schema file consistently

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.

Schema File

1 participant