Added schema validation and support for exhaustive and more detailed validation to existing validators. Added new `mcp-publisher validate` command. No change to any existing tests or behavior other than the new command. ## Motivation and Context Many currently published servers fail schema validation. Of those that pass, many have semantic/logical errors or other errors that make them impossible to configure, or their configuration when applied doesn't generate correct MCP server configuration (per their own documentation). To address this, we need better tooling to validate servers and to inform server publishers of errors, issues, and best practices in a way that is clear and actionable, both during server development and at time of publishing. I have started a discussion about the broader topic: https://github.com/modelcontextprotocol/registry/discussions/635 There is also a fairly detailed document describing the design, architecture, implementation, future plans, etc. See [Enhanced Validation Design](docs/explanations/proposed-enhanced-validation.md) This PR is the first step in the process of improving validation. It adds schema validation and updates all existing validators to use a new model that allows them to track context and return rich and exhaustive results. This has been done in a way that is backward compatible (ValidateServerJSON is unchanged as are all existing validation unit tests). There is a new `mcp-publisher` command called `validate` that is currenty the only place that schema validation and enhanced (exhaustive/rich) validation results are exposed. ### Changes Internal Validation improvements - Schema validation has been implemented and is available as an option in validation methods (defaults to off) - Existing validators track the JSON path (context) of the attribute they're evaluating, passing it to any child validators - Existing validators are exhaustive (return all issues, not failing fast on the first error) - Existing validators return rich validation results, including: - type (schema, semantic, linter) - severity (error, warn, info) - path (JSON path to server.json element) - reference (to the schema element or rule that triggered the result) - message (currently the same as previous error message) A new `validate` command has been added to `mcp-publisher` so publishers can evaluate their server.json before publishing - Includes new schema validation and previous semantic validation - Shows full details of all issues encountered during validation ### Usage Given a server.json that looks like this: ```json { "$schema": "https://static.modelcontextprotocol.io/schemas/2025-09-29/server.schema.json", "name": "io.github.BobDickinson/registry", "description": "An MCP server that provides [describe what your server does]", "repository": { "url": "", "source": "" }, "version": "=1.0.0", "packages": [ { "registryType": "oci", "registryBaseUrl": "https://docker.io", "identifier": "registry", "version": "1.0.0", "transport": { "type": "sse" }, "packageArguments": [ { "type": "named", "name": "--mode", "description": "Operation mode", "format": "foo" } ], "environmentVariables": [ { "description": "Your API key for the service", "isRequired": true, "format": "string", "isSecret": true, "name": "YOUR_API_KEY" } ] } ] } ``` Run the command: `mcp-publisher validate server.json` Which will produce the output: ```bash ❌ Validation failed with 5 issue(s): 1. [error] packages.0.packageArguments.0.format (schema) value must be one of "string", "number", "boolean", "filepath" Reference: #/definitions/Input/properties/format/enum from: [#/definitions/ServerDetail]/properties/packages/items/[#/definitions/Package]/properties/packageArguments/items/[#/definitions/Argument]/else/[#/definitions/NamedArgument]/allOf/0/[#/definitions/InputWithVariables]/allOf/0/[#/definitions/Input]/properties/format/enum 2. [error] packages.0.transport (schema) missing required fields: 'url' Reference: #/definitions/SseTransport/required from: [#/definitions/ServerDetail]/properties/packages/items/[#/definitions/Package]/properties/transport/else/else/[#/definitions/SseTransport]/required 3. [error] repository.url (schema) '' has invalid format 'uri' Reference: #/definitions/Repository/properties/url/format from: [#/definitions/ServerDetail]/properties/repository/[#/definitions/Repository]/properties/url/format 4. [error] version (semantic) version must be a specific version, not a range: "=1.0.0" Reference: version-looks-like-range 5. [error] packages[0].transport.url (semantic) url is required for sse transport type Reference: streamable-transport-url-required Error: validation failed ``` Note in the results above: - All errors contain the JSON path of the triggering element from server.json. - The first three errors are schema errors detected during schema validation. The `Reference` provided contains an absolute path to the schema rule that was violated, followed by the full schema path that enforced that rule (with $ref redirect values substited and enclosed in square brackets). - The error messages provided by the existing semantic validators are exactly the same as the previous error messages those validators produced. In the final solution we would remove semantic validators that are redundant to schema validation (as in number 5 above). We have the option to use the structured data produced by schema validation to replace the generic schema validation message with a more descriptive message if that is an issue (in particular, if the only argument for an ad-hoc validator is that is produces a better/cleaner message, we would just move that message creation code to the schema error result formatter and special case it as opposed to having a redundant validator). ### What's Next If this general direction is supported and this PR is accepted, a fast follow would include: - Add new validators (infliuenced by observed issues) for both semantic errors and best practices - Require passing schema validation (in addition to improved semantic validation) in order to publish - Remove existing validation code that is redundant to schema validation (ensuring error messages remain intelligible) - Update validation client code and tests to handle the new rich return types natively ### Issues Schema validation requires embedding the `server.schema.json` file into the validators package via `go:embed`, which is restricted from embedding files outside of the package. For this reason we copy the schema file into a schema subdir (via a prep target in the makefile) and we .gitignore it. I tried cleaning up the copy in the make clean target, but then the linter would complain about the embed target being missing if it wasn't there during development. I also considered just checking in the schema file and assuming a separate workflow for updating the embedded schema file, but it's not clear what that workflow would be or how it would be maintained. I'm open to a different approach, but the schema file does need to be embedded somehow for schema validation to work. ## How Has This Been Tested? All existing validation tests pass, new tests implemented and all pass. ## Breaking Changes No breaking changes, no behavior change except new `validate` command ## 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) - [X] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update ## Checklist <!-- Go over all the following points, and put an `x` in all the boxes that apply. --> - [X] I have read the [MCP Documentation](https://modelcontextprotocol.io) - [X] My code follows the repository's style guidelines - [X] New and existing tests pass locally - [X] I have added appropriate error handling - [X] I have added or updated documentation as needed --------- Co-authored-by: GitHub Action <action@github.com>
193 lines
5.9 KiB
Go
193 lines
5.9 KiB
Go
package importer
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"io"
|
|
"log"
|
|
"net/http"
|
|
"os"
|
|
"strings"
|
|
|
|
"github.com/modelcontextprotocol/registry/internal/service"
|
|
"github.com/modelcontextprotocol/registry/internal/validators"
|
|
apiv0 "github.com/modelcontextprotocol/registry/pkg/api/v0"
|
|
)
|
|
|
|
// Service handles importing seed data into the registry
|
|
type Service struct {
|
|
registry service.RegistryService
|
|
}
|
|
|
|
// NewService creates a new importer service
|
|
func NewService(registry service.RegistryService) *Service {
|
|
return &Service{registry: registry}
|
|
}
|
|
|
|
// ImportFromPath imports seed data from various sources:
|
|
// 1. Local file paths (*.json files) - expects ServerJSON array format
|
|
// 2. Direct HTTP URLs to seed.json files - expects ServerJSON array format
|
|
// 3. Registry root URLs (automatically appends /v0/servers and paginates)
|
|
func (s *Service) ImportFromPath(ctx context.Context, path string) error {
|
|
servers, err := readSeedFile(ctx, path)
|
|
if err != nil {
|
|
return fmt.Errorf("failed to read seed data: %w", err)
|
|
}
|
|
|
|
// Import each server using registry service CreateServer
|
|
var successfullyCreated []string
|
|
var failedCreations []string
|
|
|
|
for _, server := range servers {
|
|
_, err := s.registry.CreateServer(ctx, server)
|
|
if err != nil {
|
|
failedCreations = append(failedCreations, fmt.Sprintf("%s: %v", server.Name, err))
|
|
log.Printf("Failed to create server %s: %v", server.Name, err)
|
|
} else {
|
|
successfullyCreated = append(successfullyCreated, server.Name)
|
|
}
|
|
}
|
|
|
|
// Report import results after actual creation attempts
|
|
if len(failedCreations) > 0 {
|
|
log.Printf("Import completed with errors: %d servers created successfully, %d servers failed",
|
|
len(successfullyCreated), len(failedCreations))
|
|
log.Printf("Failed servers: %v", failedCreations)
|
|
return fmt.Errorf("failed to import %d servers", len(failedCreations))
|
|
}
|
|
|
|
log.Printf("Import completed successfully: all %d servers created", len(successfullyCreated))
|
|
return nil
|
|
}
|
|
|
|
// readSeedFile reads seed data from various sources
|
|
func readSeedFile(ctx context.Context, path string) ([]*apiv0.ServerJSON, error) {
|
|
var data []byte
|
|
var err error
|
|
|
|
if strings.HasPrefix(path, "http://") || strings.HasPrefix(path, "https://") {
|
|
// Handle HTTP URLs
|
|
if strings.HasSuffix(path, "/v0/servers") || strings.Contains(path, "/v0/servers") {
|
|
// This is a registry API endpoint - fetch paginated data
|
|
return fetchFromRegistryAPI(ctx, path)
|
|
}
|
|
// This is a direct file URL
|
|
data, err = fetchFromHTTP(ctx, path)
|
|
} else {
|
|
// Handle local file paths
|
|
data, err = os.ReadFile(path)
|
|
}
|
|
|
|
if err != nil {
|
|
return nil, fmt.Errorf("failed to read seed data from %s: %w", path, err)
|
|
}
|
|
|
|
// Parse ServerJSON array format
|
|
var serverResponses []apiv0.ServerJSON
|
|
if err := json.Unmarshal(data, &serverResponses); err != nil {
|
|
return nil, fmt.Errorf("failed to parse seed data as ServerJSON array format: %w", err)
|
|
}
|
|
|
|
if len(serverResponses) == 0 {
|
|
return []*apiv0.ServerJSON{}, nil
|
|
}
|
|
|
|
// Validate servers and collect warnings instead of failing the whole batch
|
|
var validRecords []*apiv0.ServerJSON
|
|
var invalidServers []string
|
|
var validationFailures []string
|
|
|
|
for _, response := range serverResponses {
|
|
// ValidateServerJSON returns all validation results; using FirstError() to preserve existing behavior
|
|
// In future, consider logging all issues from result.Issues for better diagnostics
|
|
result := validators.ValidateServerJSON(&response, validators.ValidationSchemaVersionAndSemantic)
|
|
if err := result.FirstError(); err != nil {
|
|
// Log warning and track invalid server instead of failing
|
|
invalidServers = append(invalidServers, response.Name)
|
|
validationFailures = append(validationFailures, fmt.Sprintf("Server '%s': %v", response.Name, err))
|
|
log.Printf("Warning: Skipping invalid server '%s': %v", response.Name, err)
|
|
continue
|
|
}
|
|
|
|
// Add valid ServerJSON to records
|
|
validRecords = append(validRecords, &response)
|
|
}
|
|
|
|
// Print summary of validation results
|
|
if len(invalidServers) > 0 {
|
|
log.Printf("Validation summary: %d servers passed validation, %d invalid servers skipped", len(validRecords), len(invalidServers))
|
|
log.Printf("Invalid servers: %v", invalidServers)
|
|
for _, failure := range validationFailures {
|
|
log.Printf(" - %s", failure)
|
|
}
|
|
} else {
|
|
log.Printf("Validation summary: All %d servers passed validation", len(validRecords))
|
|
}
|
|
|
|
return validRecords, nil
|
|
}
|
|
|
|
func fetchFromHTTP(ctx context.Context, url string) ([]byte, error) {
|
|
req, err := http.NewRequestWithContext(ctx, http.MethodGet, url, nil)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("failed to create HTTP request: %w", err)
|
|
}
|
|
|
|
resp, err := http.DefaultClient.Do(req)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("failed to fetch from HTTP: %w", err)
|
|
}
|
|
defer resp.Body.Close()
|
|
|
|
if resp.StatusCode != http.StatusOK {
|
|
return nil, fmt.Errorf("HTTP request failed with status: %d", resp.StatusCode)
|
|
}
|
|
|
|
return io.ReadAll(resp.Body)
|
|
}
|
|
|
|
func fetchFromRegistryAPI(ctx context.Context, baseURL string) ([]*apiv0.ServerJSON, error) {
|
|
var allRecords []*apiv0.ServerJSON
|
|
cursor := ""
|
|
|
|
for {
|
|
url := baseURL
|
|
if cursor != "" {
|
|
if strings.Contains(url, "?") {
|
|
url += "&cursor=" + cursor
|
|
} else {
|
|
url += "?cursor=" + cursor
|
|
}
|
|
}
|
|
|
|
data, err := fetchFromHTTP(ctx, url)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("failed to fetch page from registry API: %w", err)
|
|
}
|
|
|
|
var response struct {
|
|
Servers []apiv0.ServerResponse `json:"servers"`
|
|
Metadata *struct {
|
|
NextCursor string `json:"nextCursor,omitempty"`
|
|
} `json:"metadata,omitempty"`
|
|
}
|
|
|
|
if err := json.Unmarshal(data, &response); err != nil {
|
|
return nil, fmt.Errorf("failed to parse registry API response: %w", err)
|
|
}
|
|
|
|
// Extract ServerJSON from each ServerResponse
|
|
for _, serverResponse := range response.Servers {
|
|
allRecords = append(allRecords, &serverResponse.Server)
|
|
}
|
|
|
|
// Check if there's a next page
|
|
if response.Metadata == nil || response.Metadata.NextCursor == "" {
|
|
break
|
|
}
|
|
cursor = response.Metadata.NextCursor
|
|
}
|
|
|
|
return allRecords, nil
|
|
}
|