## 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
134 lines
5.2 KiB
Go
134 lines
5.2 KiB
Go
package v0
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"net/http"
|
|
"net/url"
|
|
"strings"
|
|
|
|
"github.com/danielgtaylor/huma/v2"
|
|
"github.com/modelcontextprotocol/registry/internal/auth"
|
|
"github.com/modelcontextprotocol/registry/internal/config"
|
|
"github.com/modelcontextprotocol/registry/internal/database"
|
|
"github.com/modelcontextprotocol/registry/internal/service"
|
|
"github.com/modelcontextprotocol/registry/internal/validators"
|
|
apiv0 "github.com/modelcontextprotocol/registry/pkg/api/v0"
|
|
"github.com/modelcontextprotocol/registry/pkg/model"
|
|
)
|
|
|
|
// EditServerInput represents the input for editing a server
|
|
type EditServerInput struct {
|
|
Authorization string `header:"Authorization" doc:"Registry JWT token with edit permissions" required:"true"`
|
|
ServerName string `path:"serverName" doc:"URL-encoded server name" example:"com.example%2Fmy-server"`
|
|
Version string `path:"version" doc:"URL-encoded version to edit" example:"1.0.0"`
|
|
Status string `query:"status" doc:"New status for the server (active, deprecated, deleted)" required:"false" enum:"active,deprecated,deleted"`
|
|
Body apiv0.ServerJSON `body:""`
|
|
}
|
|
|
|
// RegisterEditEndpoints registers the edit endpoint with a custom path prefix
|
|
func RegisterEditEndpoints(api huma.API, pathPrefix string, registry service.RegistryService, cfg *config.Config) {
|
|
jwtManager := auth.NewJWTManager(cfg)
|
|
|
|
// Edit server endpoint
|
|
huma.Register(api, huma.Operation{
|
|
OperationID: "edit-server" + strings.ReplaceAll(pathPrefix, "/", "-"),
|
|
Method: http.MethodPut,
|
|
Path: pathPrefix + "/servers/{serverName}/versions/{version}",
|
|
Summary: "Edit MCP server",
|
|
Description: "Update a specific version of an existing MCP server (admin only).",
|
|
Tags: []string{"admin"},
|
|
Security: []map[string][]string{
|
|
{"bearer": {}},
|
|
},
|
|
}, func(ctx context.Context, input *EditServerInput) (*Response[apiv0.ServerResponse], error) {
|
|
// Extract bearer token
|
|
const bearerPrefix = "Bearer "
|
|
authHeader := input.Authorization
|
|
if len(authHeader) < len(bearerPrefix) || !strings.EqualFold(authHeader[:len(bearerPrefix)], bearerPrefix) {
|
|
return nil, huma.Error401Unauthorized("Invalid Authorization header format. Expected 'Bearer <token>'")
|
|
}
|
|
token := authHeader[len(bearerPrefix):]
|
|
|
|
// Validate Registry JWT token
|
|
claims, err := jwtManager.ValidateToken(ctx, token)
|
|
if err != nil {
|
|
return nil, huma.Error401Unauthorized("Invalid or expired Registry JWT token", err)
|
|
}
|
|
|
|
// URL-decode the server name
|
|
serverName, err := url.PathUnescape(input.ServerName)
|
|
if err != nil {
|
|
return nil, huma.Error400BadRequest("Invalid server name encoding", err)
|
|
}
|
|
|
|
// URL-decode the version
|
|
version, err := url.PathUnescape(input.Version)
|
|
if err != nil {
|
|
return nil, huma.Error400BadRequest("Invalid version encoding", err)
|
|
}
|
|
|
|
// Get current server to check permissions against existing name
|
|
currentServer, err := registry.GetServerByNameAndVersion(ctx, serverName, version)
|
|
if err != nil {
|
|
if errors.Is(err, database.ErrNotFound) {
|
|
return nil, huma.Error404NotFound("Server not found")
|
|
}
|
|
return nil, huma.Error500InternalServerError("Failed to get current server", err)
|
|
}
|
|
|
|
// Verify edit permissions for this server using the existing server name
|
|
if !jwtManager.HasPermission(currentServer.Server.Name, auth.PermissionActionEdit, claims.Permissions) {
|
|
return nil, huma.Error403Forbidden("You do not have edit permissions for this server")
|
|
}
|
|
|
|
// Prevent renaming servers
|
|
if currentServer.Server.Name != input.Body.Name {
|
|
return nil, huma.Error400BadRequest("Cannot rename server")
|
|
}
|
|
|
|
// Validate that the version in the body matches the URL parameter
|
|
if input.Body.Version != version {
|
|
return nil, huma.Error400BadRequest("Version in request body must match URL path parameter")
|
|
}
|
|
|
|
// Validate server JSON structure and schema (returns 422 on validation failure)
|
|
validationResult := validators.ValidateServerJSON(&input.Body, validators.ValidationSchemaVersionAndSemantic)
|
|
if !validationResult.Valid {
|
|
return nil, huma.Error422UnprocessableEntity("Failed to edit server, invalid schema: call /validate for details")
|
|
}
|
|
|
|
// Handle status changes with proper permission validation
|
|
if input.Status != "" {
|
|
newStatus := model.Status(input.Status)
|
|
|
|
// Prevent undeleting servers - once deleted, they stay deleted
|
|
if currentServer.Meta.Official != nil &&
|
|
currentServer.Meta.Official.Status == model.StatusDeleted &&
|
|
newStatus != model.StatusDeleted {
|
|
return nil, huma.Error400BadRequest("Cannot change status of deleted server. Deleted servers cannot be undeleted.")
|
|
}
|
|
|
|
// For now, only allow status changes for admins
|
|
// Future: Implement logic to allow server authors to change active <-> deprecated
|
|
// but only admins can set to deleted
|
|
}
|
|
|
|
// Update the server using the service
|
|
var statusPtr *string
|
|
if input.Status != "" {
|
|
statusPtr = &input.Status
|
|
}
|
|
updatedServer, err := registry.UpdateServer(ctx, serverName, version, &input.Body, statusPtr)
|
|
if err != nil {
|
|
if errors.Is(err, database.ErrNotFound) {
|
|
return nil, huma.Error404NotFound("Server not found")
|
|
}
|
|
return nil, huma.Error400BadRequest("Failed to edit server", err)
|
|
}
|
|
|
|
return &Response[apiv0.ServerResponse]{
|
|
Body: *updatedServer,
|
|
}, nil
|
|
})
|
|
}
|