099a2d702e<!-- Provide a brief summary of your changes --> ## Motivation and Context <!-- Why is this change needed? What problem does it solve? --> The following PR eliminates duplicate struct definitions by migrating the publisher tool to use canonical types from pkg/model, creating a single source of truth across the codebase. The publisher tool previously had its own copies of structs that were duplicated, ie. ServerJSON, Package, Repository, VersionDetail, EnvironmentVariable, RuntimeArgument and a few others which was not optimal **Changes in the PR:** - Refactored the structs to single canonical types located at pkg/model - Refactor the implementation to use/build canonical structures directly - Remove all duplicate definitions (5 structs eliminated) - Publisher now uses model.ServerJSON, model.Package, model.Repository, etc. - Renamed some of the structs to better reflect their use case, i.e. ServerJSON instead of ServerDetail - Fixes an issue where the Remote property was missing from the previous publisher copy of the Server **Benefits:** - Single source of truth - Schema changes in one place - Type safety - Compiler catches mismatches - Enhanced validation - Field constraints and bson tags - Zero breaking changes - Same CLI interface and JSON output - Future-proof - New canonical fields automatically available Supersedes: #217 and #240 ## How Has This Been Tested? <!-- Have you tested this in a real application? Which scenarios were tested? --> Locally ## Breaking Changes <!-- Will users need to update their code or configurations? --> No ## Types of changes <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [x] 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) - [ ] Documentation update ## Checklist <!-- Go over all the following points, and put an `x` in all the boxes that apply. --> - [ ] I have read the [MCP Documentation](https://modelcontextprotocol.io) - [ ] My code follows the repository's style guidelines - [ ] New and existing tests pass locally - [ ] I have added appropriate error handling - [ ] I have added or updated documentation as needed ## Additional context <!-- Add any other context, implementation notes, or design decisions --> --------- Signed-off-by: Radoslav Dimitrov <radoslav@stacklok.com>
102 lines
3.1 KiB
Go
102 lines
3.1 KiB
Go
package v0
|
|
|
|
import (
|
|
"context"
|
|
"net/http"
|
|
|
|
"github.com/danielgtaylor/huma/v2"
|
|
"github.com/google/uuid"
|
|
"github.com/modelcontextprotocol/registry/internal/service"
|
|
apiv1 "github.com/modelcontextprotocol/registry/pkg/api/v1"
|
|
)
|
|
|
|
// Metadata contains pagination metadata
|
|
type Metadata struct {
|
|
NextCursor string `json:"next_cursor,omitempty"`
|
|
Count int `json:"count,omitempty"`
|
|
Total int `json:"total,omitempty"`
|
|
}
|
|
|
|
// ListServersInput represents the input for listing servers
|
|
type ListServersInput struct {
|
|
Cursor string `query:"cursor" doc:"Pagination cursor (UUID)" format:"uuid" required:"false"`
|
|
Limit int `query:"limit" doc:"Number of items per page" default:"30" minimum:"1" maximum:"100"`
|
|
}
|
|
|
|
// ListServersBody represents the paginated server list response body
|
|
type ListServersBody struct {
|
|
Servers []apiv1.ServerRecord `json:"servers" doc:"List of MCP servers with extensions"`
|
|
Metadata *Metadata `json:"metadata,omitempty" doc:"Pagination metadata"`
|
|
}
|
|
|
|
// ServerDetailInput represents the input for getting server details
|
|
type ServerDetailInput struct {
|
|
ID string `path:"id" doc:"Server ID (UUID)" format:"uuid"`
|
|
}
|
|
|
|
// RegisterServersEndpoints registers all server-related endpoints
|
|
func RegisterServersEndpoints(api huma.API, registry service.RegistryService) {
|
|
// List servers endpoint
|
|
huma.Register(api, huma.Operation{
|
|
OperationID: "list-servers",
|
|
Method: http.MethodGet,
|
|
Path: "/v0/servers",
|
|
Summary: "List MCP servers",
|
|
Description: "Get a paginated list of MCP servers from the registry",
|
|
Tags: []string{"servers"},
|
|
}, func(_ context.Context, input *ListServersInput) (*Response[ListServersBody], error) {
|
|
// Validate cursor if provided
|
|
if input.Cursor != "" {
|
|
_, err := uuid.Parse(input.Cursor)
|
|
if err != nil {
|
|
return nil, huma.Error400BadRequest("Invalid cursor parameter")
|
|
}
|
|
}
|
|
|
|
// Get paginated results
|
|
servers, nextCursor, err := registry.List(input.Cursor, input.Limit)
|
|
if err != nil {
|
|
return nil, huma.Error500InternalServerError("Failed to get registry list", err)
|
|
}
|
|
|
|
// Build response body
|
|
body := ListServersBody{
|
|
Servers: servers,
|
|
}
|
|
|
|
// Add metadata if there's a next cursor
|
|
if nextCursor != "" {
|
|
body.Metadata = &Metadata{
|
|
NextCursor: nextCursor,
|
|
Count: len(servers),
|
|
}
|
|
}
|
|
|
|
return &Response[ListServersBody]{
|
|
Body: body,
|
|
}, nil
|
|
})
|
|
|
|
// Get server details endpoint
|
|
huma.Register(api, huma.Operation{
|
|
OperationID: "get-server",
|
|
Method: http.MethodGet,
|
|
Path: "/v0/servers/{id}",
|
|
Summary: "Get MCP server details",
|
|
Description: "Get detailed information about a specific MCP server",
|
|
Tags: []string{"servers"},
|
|
}, func(_ context.Context, input *ServerDetailInput) (*Response[apiv1.ServerRecord], error) {
|
|
// Get the server details from the registry service
|
|
serverDetail, err := registry.GetByID(input.ID)
|
|
if err != nil {
|
|
if err.Error() == "record not found" {
|
|
return nil, huma.Error404NotFound("Server not found")
|
|
}
|
|
return nil, huma.Error500InternalServerError("Failed to get server details", err)
|
|
}
|
|
|
|
return &Response[apiv1.ServerRecord]{
|
|
Body: *serverDetail,
|
|
}, nil
|
|
})
|
|
}
|