Skip to content

docs: add config JSON schema#249

Open
haosenwang1018 wants to merge 1 commit intophilschmid:mainfrom
haosenwang1018:docs/config-json-schema
Open

docs: add config JSON schema#249
haosenwang1018 wants to merge 1 commit intophilschmid:mainfrom
haosenwang1018:docs/config-json-schema

Conversation

@haosenwang1018
Copy link
Copy Markdown

Summary

  • add a JSON Schema for mcp_servers.json
  • document how to reference the schema from editor tooling via $schema
  • keep the schema aligned with the current stdio/HTTP config options and tool filtering fields

Problem

Issue #32 asks for a schema file that users can point their editors at to validate mcp_servers.json and get autocomplete / formatting guidance.

Changes

  • add mcp_servers.schema.json at the repository root
  • cover both stdio and HTTP server definitions, including allowedTools / disabledTools
  • document the schema in the README with an example $schema entry

Fixes #32

Validation

  • node -e "JSON.parse(require('node:fs').readFileSync('mcp_servers.schema.json', 'utf8'))"
  • git diff --check

Signed-off-by: haosenwang1018 <haosenwang1018@users.noreply.github.com>
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