## Motivation and Context Per discussion with @rdimitrov - all validation now happens in a new `/validate` endpoint. For details, see below. ## Breaking Changes None. Validation on /publish only validates schema version and semantic checks (manual checks) as before. We can add schema validation by changing a flag in the called to `ValidateJSONSchema` when we're ready. ## Types of changes - [X] New feature (non-breaking change which adds functionality) ## Checklist - [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 ## Additional context ## API Changes ### 1. New `/validate` Endpoint A new public endpoint was added for validating `server.json` files without publishing them. **Details:** - **Paths:** `/v0/validate` and `/v0.1/validate` - **Method:** `POST` - **Authentication:** None required (public endpoint) - **Request:** JSON body containing `ServerJSON` - **Response:** `200 OK` with `ValidationResult` containing: - `valid` (boolean) - `issues` (array of validation issues with type, path, message, severity, reference) **Implementation:** - New handler file: `internal/api/handlers/v0/validate.go` - Performs comprehensive validation using `ValidationAll` option: - Schema version validation - Full schema validation - Semantic validation - Always returns `200 OK` - validity is indicated in `result.Valid` field - Registered in router for both `/v0` and `/v0.1` prefixes ### 2. `/publish` Endpoint Validation Flow Changes The publish endpoint now validates earlier in the request flow and provides clearer error responses. **Before:** Validation was mixed into `ValidatePublishRequest()` (which also handled publisher extensions and registry ownership). **After:** 1. Validates `ServerJSON` structure first using `ValidateServerJSON()` (schema version + semantic validation) 2. Returns `422 Unprocessable Entity` with message: "Failed to publish server, invalid schema: call /validate for details" 3. Only proceeds to publisher extensions/registry validation if schema validation passes 4. No longer calls `ValidatePublishRequest()` internally for schema validation **Key Changes:** - Validation happens before `CreateServer()` call - Returns `422` on schema/semantic validation failures - Error message directs users to `/validate` endpoint for details - `ValidatePublishRequest()` no longer performs schema validation (added note in comments) ### 3. `/edit` Endpoint Validation Flow Changes Similar validation changes were applied to the edit endpoint. **Changes:** - Added `ValidateServerJSON()` call before server update - Returns `422` with same error message format on validation failure - Matches the `/publish` endpoint behavior ### 4. Validator Functions Refactoring Updated validator functions to reflect that schema validation is now done separately. **Changes to `ValidatePublishRequest()`:** - Removed internal `ValidateServerJSON()` call - Added note: "ValidateServerJSON should be called separately before this function" - Now only validates publisher extensions and registry ownership **Changes to `ValidateUpdateRequest()`:** - Same change (removed schema validation, added note) - Now only validates registry ownership ## CLI Changes ### 1. `validate` Command: Now Uses API Endpoint **Before:** Performed local validation using `validators.ValidateServerJSON()`. **After:** Calls the `/v0/validate` endpoint on the registry. **Details:** - Reads `server.json` and sends it to the registry API - Displays validation results returned by the server - Uses the same error formatting as before - Registry URL comes from token file (or default) - No authentication required (public endpoint) **Implementation:** - Added `validateViaAPI()` function that POSTs to `/v0/validate` - Parses `ValidationResult` response from server - Uses shared `printValidationIssues()` for formatting ### 2. `publish` Command: Validation Only on 422 Errors **Before:** Performed upfront local schema validation before publishing. **After:** Attempts publish first, then validates only if server returns 422. **Details:** - Attempts publish immediately (no upfront validation) - If publish returns 422 (Unprocessable Entity): - Calls `/v0/validate` endpoint to get detailed validation errors - Formats and displays them using same logic as `validate` command - Returns error with migration links - For non-422 errors (401, 403, etc.), returns original error (no validation call) **Implementation Changes:** - Removed upfront `runValidationAndPrintIssues()` call - Modified `publishToRegistry()` to return HTTP status code alongside response/error - Added 422 detection logic that calls `validateViaAPI()` ### 3. Shared Validation Error Formatting **Before:** `runValidationAndPrintIssues()` function handled both validation and printing together. **After:** Refactored to separate printing logic. **Details:** - Created `printValidationIssues()` function - just prints validation issues (no validation logic) - Removed `runValidationAndPrintIssues()` function (no longer used) - Both `validate` and `publish` commands use `printValidationIssues()` for consistent output **Behavior:** - Prints schema validation errors with migration guidance - Prints all other validation issues with formatting - Returns formatted error message string for schema issues ## Summary Both CLI commands now use the `/validate` API endpoint for validation instead of local validation. The `publish` command validates only after receiving a 422 error response, and both commands share the same error formatting via `printValidationIssues()`. ### Benefits - **Centralized validation logic** - All validation happens on the server - **Always up-to-date** - CLI always uses current server validation rules - **Consistent experience** - Same validation behavior whether using CLI or API directly - **Better separation of concerns** - Schema validation separated from publisher-specific validation
246 lines
9 KiB
Go
246 lines
9 KiB
Go
package commands
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"io"
|
|
"net/http"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
|
|
"github.com/modelcontextprotocol/registry/internal/validators"
|
|
apiv0 "github.com/modelcontextprotocol/registry/pkg/api/v0"
|
|
"github.com/modelcontextprotocol/registry/pkg/model"
|
|
)
|
|
|
|
// printSchemaValidationErrors prints nicely formatted error messages for schema validation issues
|
|
// (empty schema or non-current schema) with migration guidance to stdout.
|
|
// Returns the formatted error message string if any schema errors were printed, empty string otherwise.
|
|
func printSchemaValidationErrors(result *validators.ValidationResult, serverJSON *apiv0.ServerJSON) string {
|
|
currentSchemaURL := model.CurrentSchemaURL
|
|
migrationURL := "https://github.com/modelcontextprotocol/registry/blob/main/docs/reference/server-json/CHANGELOG.md"
|
|
checklistURL := migrationURL + "#migration-checklist-for-publishers"
|
|
|
|
var formattedMsg strings.Builder
|
|
|
|
for _, issue := range result.Issues {
|
|
switch issue.Reference {
|
|
case "schema-field-required":
|
|
// Empty/missing schema
|
|
_, _ = fmt.Fprintf(os.Stdout, "$schema field is required.\n")
|
|
_, _ = fmt.Fprintln(os.Stdout)
|
|
_, _ = fmt.Fprintf(os.Stdout, "Expected current schema: %s\n", currentSchemaURL)
|
|
_, _ = fmt.Fprintln(os.Stdout)
|
|
_, _ = fmt.Fprintln(os.Stdout, "Run 'mcp-publisher init' to create a new server.json with the correct schema, or update your existing server.json file.")
|
|
_, _ = fmt.Fprintln(os.Stdout)
|
|
_, _ = fmt.Fprintf(os.Stdout, "📋 Migration checklist: %s\n", checklistURL)
|
|
_, _ = fmt.Fprintf(os.Stdout, "📖 Full changelog with examples: %s\n", migrationURL)
|
|
_, _ = fmt.Fprintln(os.Stdout)
|
|
|
|
// Build formatted error message
|
|
_, _ = fmt.Fprintf(&formattedMsg, "$schema field is required. Expected current schema: %s. 📋 Migration checklist: %s 📖 Full changelog with examples: %s", currentSchemaURL, checklistURL, migrationURL)
|
|
return formattedMsg.String() // Only one schema error at a time
|
|
|
|
case "schema-version-deprecated":
|
|
// Non-current schema
|
|
if issue.Severity == validators.ValidationIssueSeverityWarning {
|
|
// Warning format (for validate command)
|
|
_, _ = fmt.Fprintf(os.Stdout, "⚠️ Deprecated schema detected: %s\n", serverJSON.Schema)
|
|
} else {
|
|
// Error format (for publish command)
|
|
_, _ = fmt.Fprintf(os.Stdout, "deprecated schema detected: %s.\n", serverJSON.Schema)
|
|
}
|
|
_, _ = fmt.Fprintln(os.Stdout)
|
|
_, _ = fmt.Fprintf(os.Stdout, "Expected current schema: %s\n", currentSchemaURL)
|
|
_, _ = fmt.Fprintln(os.Stdout)
|
|
_, _ = fmt.Fprintln(os.Stdout, "Migrate to the current schema format for new servers.")
|
|
_, _ = fmt.Fprintln(os.Stdout)
|
|
_, _ = fmt.Fprintf(os.Stdout, "📋 Migration checklist: %s\n", checklistURL)
|
|
_, _ = fmt.Fprintf(os.Stdout, "📖 Full changelog with examples: %s\n", migrationURL)
|
|
_, _ = fmt.Fprintln(os.Stdout)
|
|
|
|
// Build formatted error message - include the original issue message for test compatibility
|
|
_, _ = fmt.Fprintf(&formattedMsg, "%s. deprecated schema detected: %s. Expected current schema: %s. Migrate to the current schema format for new servers. 📋 Migration checklist: %s 📖 Full changelog with examples: %s", issue.Message, serverJSON.Schema, currentSchemaURL, checklistURL, migrationURL)
|
|
return formattedMsg.String() // Only one schema error at a time
|
|
|
|
case "schema-version-extraction-error":
|
|
// Invalid schema URL format - also include migration links for consistency
|
|
// Build formatted error message with migration links
|
|
_, _ = fmt.Fprintf(&formattedMsg, "%s. 📋 Migration checklist: %s 📖 Full changelog with examples: %s", issue.Message, checklistURL, migrationURL)
|
|
return formattedMsg.String()
|
|
}
|
|
}
|
|
|
|
return ""
|
|
}
|
|
|
|
// printValidationIssues prints schema validation errors and all other validation issues.
|
|
// Returns the formatted error message string for schema validation errors (empty string if none).
|
|
func printValidationIssues(result *validators.ValidationResult, serverJSON *apiv0.ServerJSON) string {
|
|
// Print schema validation errors/warnings with friendly messages
|
|
formattedErrorMsg := printSchemaValidationErrors(result, serverJSON)
|
|
|
|
if result.Valid {
|
|
return formattedErrorMsg
|
|
}
|
|
|
|
// Print all issues
|
|
_, _ = fmt.Fprintf(os.Stdout, "❌ Validation failed with %d issue(s):\n", len(result.Issues))
|
|
_, _ = fmt.Fprintln(os.Stdout)
|
|
|
|
// Track which schema issues we've already printed to avoid duplicates
|
|
issueNum := 1
|
|
|
|
for _, issue := range result.Issues {
|
|
// Skip schema issues that were already printed (they're printed by printSchemaValidationErrors above)
|
|
if issue.Reference == "schema-field-required" || issue.Reference == "schema-version-deprecated" {
|
|
continue
|
|
}
|
|
|
|
// Print other issues normally
|
|
_, _ = fmt.Fprintf(os.Stdout, "%d. [%s] %s (%s)\n", issueNum, issue.Severity, issue.Path, issue.Type)
|
|
_, _ = fmt.Fprintf(os.Stdout, " %s\n", issue.Message)
|
|
if issue.Reference != "" {
|
|
_, _ = fmt.Fprintf(os.Stdout, " Reference: %s\n", issue.Reference)
|
|
}
|
|
_, _ = fmt.Fprintln(os.Stdout)
|
|
issueNum++
|
|
}
|
|
|
|
return formattedErrorMsg
|
|
}
|
|
|
|
func ValidateCommand(args []string) error {
|
|
// Parse arguments
|
|
serverFile := "server.json"
|
|
|
|
for _, arg := range args {
|
|
if arg == "--help" || arg == "-h" {
|
|
_, _ = fmt.Fprintln(os.Stdout, "Usage: mcp-publisher validate [file]")
|
|
_, _ = fmt.Fprintln(os.Stdout)
|
|
_, _ = fmt.Fprintln(os.Stdout, "Validate a server.json file without publishing.")
|
|
_, _ = fmt.Fprintln(os.Stdout)
|
|
_, _ = fmt.Fprintln(os.Stdout, "Arguments:")
|
|
_, _ = fmt.Fprintln(os.Stdout, " file Path to server.json file (default: ./server.json)")
|
|
_, _ = fmt.Fprintln(os.Stdout)
|
|
_, _ = fmt.Fprintln(os.Stdout, "The validate command performs exhaustive validation, reporting all issues at once.")
|
|
_, _ = fmt.Fprintln(os.Stdout, "It validates JSON syntax, schema compliance, and semantic rules.")
|
|
return nil
|
|
}
|
|
if !strings.HasPrefix(arg, "-") {
|
|
serverFile = arg
|
|
}
|
|
}
|
|
|
|
// Read server file
|
|
serverData, err := os.ReadFile(serverFile)
|
|
if err != nil {
|
|
if os.IsNotExist(err) {
|
|
return fmt.Errorf("%s not found, please check the file path", serverFile)
|
|
}
|
|
return fmt.Errorf("failed to read %s: %w", serverFile, err)
|
|
}
|
|
|
|
// Validate JSON
|
|
var serverJSON apiv0.ServerJSON
|
|
if err := json.Unmarshal(serverData, &serverJSON); err != nil {
|
|
return fmt.Errorf("invalid JSON: %w", err)
|
|
}
|
|
|
|
// Get registry URL (same pattern as publish)
|
|
homeDir, err := os.UserHomeDir()
|
|
if err != nil {
|
|
return fmt.Errorf("failed to get home directory: %w", err)
|
|
}
|
|
|
|
tokenPath := filepath.Join(homeDir, TokenFileName)
|
|
registryURL := DefaultRegistryURL
|
|
// Try to read registry URL from token file (if it exists)
|
|
if tokenData, err := os.ReadFile(tokenPath); err == nil {
|
|
var tokenInfo map[string]string
|
|
if err := json.Unmarshal(tokenData, &tokenInfo); err == nil {
|
|
if url := tokenInfo["registry"]; url != "" {
|
|
registryURL = url
|
|
}
|
|
}
|
|
}
|
|
|
|
// Validate via API
|
|
_, _ = fmt.Fprintf(os.Stdout, "Validating against %s...\n", registryURL)
|
|
result, err := validateViaAPI(registryURL, serverData)
|
|
if err != nil {
|
|
return fmt.Errorf("validation failed: %w", err)
|
|
}
|
|
|
|
// Print validation results using shared formatting logic
|
|
formattedErrorMsg := printValidationIssues(result, &serverJSON)
|
|
|
|
if result.Valid {
|
|
_, _ = fmt.Fprintln(os.Stdout, "✅ server.json is valid")
|
|
return nil
|
|
}
|
|
|
|
// Return error with formatted message if available
|
|
if formattedErrorMsg != "" {
|
|
return fmt.Errorf("%s", formattedErrorMsg)
|
|
}
|
|
|
|
return fmt.Errorf("validation failed")
|
|
}
|
|
|
|
// validateViaAPI calls the /validate endpoint on the registry
|
|
func validateViaAPI(registryURL string, serverData []byte) (*validators.ValidationResult, error) {
|
|
// Parse the server JSON data to ensure it's valid JSON
|
|
var serverJSON apiv0.ServerJSON
|
|
err := json.Unmarshal(serverData, &serverJSON)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error parsing server.json file: %w", err)
|
|
}
|
|
|
|
// Convert to JSON
|
|
jsonData, err := json.Marshal(serverJSON)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error serializing request: %w", err)
|
|
}
|
|
|
|
// Ensure URL ends with / and add validate endpoint
|
|
if !strings.HasSuffix(registryURL, "/") {
|
|
registryURL += "/"
|
|
}
|
|
validateURL := registryURL + "v0/validate"
|
|
|
|
// Create and send request
|
|
req, err := http.NewRequestWithContext(context.Background(), http.MethodPost, validateURL, bytes.NewBuffer(jsonData))
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error creating request: %w", err)
|
|
}
|
|
req.Header.Set("Content-Type", "application/json")
|
|
|
|
client := &http.Client{}
|
|
resp, err := client.Do(req)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error sending request: %w", err)
|
|
}
|
|
defer resp.Body.Close()
|
|
|
|
// Read response
|
|
body, err := io.ReadAll(resp.Body)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error reading response: %w", err)
|
|
}
|
|
|
|
if resp.StatusCode != http.StatusOK {
|
|
return nil, fmt.Errorf("server returned status %d: %s", resp.StatusCode, body)
|
|
}
|
|
|
|
// Parse response - Huma returns ValidationResult directly
|
|
var result validators.ValidationResult
|
|
if err := json.Unmarshal(body, &result); err != nil {
|
|
return nil, fmt.Errorf("error parsing response: %w", err)
|
|
}
|
|
|
|
return &result, nil
|
|
}
|