2e7108d366## Motivation and Context Docs currently don't have very clear organisation, and don't explain core flows. This fixes #89 (although we still might want to push these to `https://modelcontextprotocol.io/docs/`), based on the plan there. One minor change from that plan is that I merged tutorials and guides, because they ended up basically being duplicates which I thought would be annoying for us to keep in sync. Additionally in the Diátaxis framework, tutorials and guides are separated by whether they are focused on acquisition of skills (e.g. in a learning environment) or application of skills (e.g. in a work environment). I expect the registry to be something that will be used occasionally in a work environment, rather than a fundamental 'learnable' skill so I think it's reasonable not to have tutorials and fold these into guides. ## How Has This Been Tested? - Read through all these updated docs - Unit and integration tests (that previously used examples.md and use the schema) working - Ran `npx markdown-link-check .` to check all the links work ## Breaking Changes Links to old docs will break, but I don't think there are any. All internal links have been checked and updated. ## Types of changes <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [x] Documentation update
93 lines
2.3 KiB
Go
93 lines
2.3 KiB
Go
// validate-schemas validates that server.schema.json and registry-schema.json
|
|
// are valid JSON Schema documents.
|
|
//
|
|
// For more information, see docs/server-json/README.md
|
|
package main
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/json"
|
|
"fmt"
|
|
"log"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
|
|
jsonschema "github.com/santhosh-tekuri/jsonschema/v5"
|
|
)
|
|
|
|
func main() {
|
|
log.SetFlags(0) // Remove timestamp from logs
|
|
|
|
if err := runValidation(); err != nil {
|
|
log.Fatalf("Error: %v", err)
|
|
}
|
|
}
|
|
|
|
func runValidation() error {
|
|
basePath := filepath.Join("docs", "reference", "server-json")
|
|
|
|
schemas := []struct {
|
|
name string
|
|
path string
|
|
}{
|
|
{"server.schema.json", filepath.Join(basePath, "server.schema.json")},
|
|
}
|
|
|
|
expectedSchemaCount := len(schemas)
|
|
validatedCount := 0
|
|
|
|
for _, schemaFile := range schemas {
|
|
log.Printf("Validating %s...", schemaFile.name)
|
|
|
|
if err := validateSchema(schemaFile.path); err != nil {
|
|
log.Printf(" ❌ Invalid: %v", err)
|
|
} else {
|
|
log.Printf(" ✅ Valid JSON Schema")
|
|
validatedCount++
|
|
}
|
|
}
|
|
|
|
if validatedCount != expectedSchemaCount {
|
|
return fmt.Errorf("validation failed: expected to validate %d schemas but only %d passed",
|
|
expectedSchemaCount, validatedCount)
|
|
}
|
|
|
|
log.Printf("\nSuccessfully validated all %d schemas!", validatedCount)
|
|
return nil
|
|
}
|
|
|
|
func validateSchema(path string) error {
|
|
data, err := os.ReadFile(path)
|
|
if err != nil {
|
|
return fmt.Errorf("failed to read file: %w", err)
|
|
}
|
|
|
|
var schemaData any
|
|
if err := json.Unmarshal(data, &schemaData); err != nil {
|
|
return fmt.Errorf("invalid JSON: %w", err)
|
|
}
|
|
|
|
compiler := jsonschema.NewCompiler()
|
|
compiler.Draft = jsonschema.Draft7
|
|
|
|
// For registry-schema.json, we need to register the base schema it references
|
|
if strings.Contains(path, "registry-schema.json") {
|
|
basePath := filepath.Join(filepath.Dir(path), "server.schema.json")
|
|
baseData, err := os.ReadFile(basePath)
|
|
if err != nil {
|
|
return fmt.Errorf("failed to read base schema: %w", err)
|
|
}
|
|
|
|
// Add the base schema to the compiler with the expected URL
|
|
if err := compiler.AddResource("https://static.modelcontextprotocol.io/schemas/2025-07-09/server.schema.json", bytes.NewReader(baseData)); err != nil {
|
|
return fmt.Errorf("failed to add base schema resource: %w", err)
|
|
}
|
|
}
|
|
|
|
if _, err := compiler.Compile(path); err != nil {
|
|
return fmt.Errorf("invalid schema: %w", err)
|
|
}
|
|
|
|
return nil
|
|
}
|