modelcontextprotocol/registry
Watch
1
0
Fork
You've already forked registry
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Introduce v0.1 version of the API (#658)

Browse source 
<!-- Provide a brief summary of your changes -->

## Motivation and Context
<!-- Why is this change needed? What problem does it solve? -->
The following PR adds a new v0.1 API version. 

The goal is to mark v0.1 as a "freeze" point while keeping v0 as the
moving target for new features so integrators can start building on top
of something stable(r).

Details:
* This change is quite simple - we re-register the same handlers twice,
once as `v0` and once as `v0.1`
* Going forward, we'll keep v0.1 frozen while we add changes either on
top of both (non-breaking) or we'll have to branch if breaking changes
are necessary
* We all acknowledge this is not exactly best-practice, but it gives us
a way to gather feedback and allow clients to start integrating with the
API without breaking them (**note** this implies a follow up PR that
would branch the handlers used in v0.1).
* For integrators/clients: please provide your feedback - what works
well, what doesn't so we can take this into account going towards GA.

## How Has This Been Tested?
<!-- Have you tested this in a real application? Which scenarios were
tested? -->

## Breaking Changes
<!-- Will users need to update their code or configurations? -->
No, this just adds a new API version alongside the existing one.

## 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)
- [ ] 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
-->
Fixes: #649

Signed-off-by: Radoslav Dimitrov <radoslav@stacklok.com>
This commit is contained in:
Radoslav Dimitrov 2025-10-14 11:04:48 +03:00 • committed by GitHub
commit 1a7cd97099
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 116 additions and 78 deletions
Download patch file Download diff file Expand all files Collapse all files

6
internal/api/handlers/v0/auth/dns.go
View file

@ -50,14 +50,14 @@ func (h *DNSAuthHandler) SetResolver(resolver DNSResolver) {
}
// RegisterDNSEndpoint registers the DNS authentication endpoint
func RegisterDNSEndpoint(api huma.API, cfg *config.Config) {
func RegisterDNSEndpoint(api huma.API, pathPrefix string, cfg *config.Config) {
handler := NewDNSAuthHandler(cfg)
// DNS authentication endpoint
huma.Register(api, huma.Operation{
OperationID: "exchange-dns-token",
OperationID: "exchange-dns-token" + pathPrefix,
Method: http.MethodPost,
Path: "/v0/auth/dns",
Path: pathPrefix + "/auth/dns",
Summary: "Exchange DNS signature for Registry JWT",
Description: "Authenticate using DNS TXT record public key and signed timestamp",
Tags: []string{"auth"},

8
internal/api/handlers/v0/auth/github_at.go
View file

@ -42,15 +42,15 @@ func (h *GitHubHandler) SetBaseURL(url string) {
h.baseURL = url
}
// RegisterGitHubATEndpoint registers the GitHub access token authentication endpoint
func RegisterGitHubATEndpoint(api huma.API, cfg *config.Config) {
// RegisterGitHubATEndpoint registers the GitHub access token authentication endpoint with a custom path prefix
func RegisterGitHubATEndpoint(api huma.API, pathPrefix string, cfg *config.Config) {
handler := NewGitHubHandler(cfg)
// GitHub token exchange endpoint
huma.Register(api, huma.Operation{
OperationID: "exchange-github-token",
OperationID: "exchange-github-token" + pathPrefix,
Method: http.MethodPost,
Path: "/v0/auth/github-at",
Path: pathPrefix + "/auth/github-at",
Summary: "Exchange GitHub OAuth access token for Registry JWT",
Description: "Exchange a GitHub OAuth access token for a short-lived Registry JWT token",
Tags: []string{"auth"},

6
internal/api/handlers/v0/auth/github_oidc.go
View file

@ -226,14 +226,14 @@ func (h *GitHubOIDCHandler) SetValidator(validator OIDCValidator) {
}
// RegisterGitHubOIDCEndpoint registers the GitHub OIDC authentication endpoint
func RegisterGitHubOIDCEndpoint(api huma.API, cfg *config.Config) {
func RegisterGitHubOIDCEndpoint(api huma.API, pathPrefix string, cfg *config.Config) {
handler := NewGitHubOIDCHandler(cfg)
// GitHub OIDC token exchange endpoint
huma.Register(api, huma.Operation{
OperationID: "exchange-github-oidc-token",
OperationID: "exchange-github-oidc-token" + pathPrefix,
Method: http.MethodPost,
Path: "/v0/auth/github-oidc",
Path: pathPrefix + "/auth/github-oidc",
Summary: "Exchange GitHub OIDC token for Registry JWT",
Description: "Exchange a GitHub Actions OIDC token for a short-lived Registry JWT token",
Tags: []string{"auth"},

6
internal/api/handlers/v0/auth/http.go
View file

@ -108,14 +108,14 @@ func (h *HTTPAuthHandler) SetFetcher(fetcher HTTPKeyFetcher) {
}
// RegisterHTTPEndpoint registers the HTTP authentication endpoint
func RegisterHTTPEndpoint(api huma.API, cfg *config.Config) {
func RegisterHTTPEndpoint(api huma.API, pathPrefix string, cfg *config.Config) {
handler := NewHTTPAuthHandler(cfg)
// HTTP authentication endpoint
huma.Register(api, huma.Operation{
OperationID: "exchange-http-token",
OperationID: "exchange-http-token" + pathPrefix,
Method: http.MethodPost,
Path: "/v0/auth/http",
Path: pathPrefix + "/auth/http",
Summary: "Exchange HTTP signature for Registry JWT",
Description: "Authenticate using HTTP-hosted public key and signed timestamp",
Tags: []string{"auth"},

16
internal/api/handlers/v0/auth/main.go
View file

@ -5,23 +5,23 @@ import (
"github.com/modelcontextprotocol/registry/internal/config"
)
// RegisterAuthEndpoints registers all authentication endpoints
func RegisterAuthEndpoints(api huma.API, cfg *config.Config) {
// RegisterAuthEndpoints registers all authentication endpoints with a custom path prefix
func RegisterAuthEndpoints(api huma.API, pathPrefix string, cfg *config.Config) {
// Register GitHub access token authentication endpoint
RegisterGitHubATEndpoint(api, cfg)
RegisterGitHubATEndpoint(api, pathPrefix, cfg)
// Register GitHub OIDC authentication endpoint
RegisterGitHubOIDCEndpoint(api, cfg)
RegisterGitHubOIDCEndpoint(api, pathPrefix, cfg)
// Register configurable OIDC authentication endpoints
RegisterOIDCEndpoints(api, cfg)
RegisterOIDCEndpoints(api, pathPrefix, cfg)
// Register DNS-based authentication endpoint
RegisterDNSEndpoint(api, cfg)
RegisterDNSEndpoint(api, pathPrefix, cfg)
// Register HTTP-based authentication endpoint
RegisterHTTPEndpoint(api, cfg)
RegisterHTTPEndpoint(api, pathPrefix, cfg)
// Register anonymous authentication endpoint
RegisterNoneEndpoint(api, cfg)
RegisterNoneEndpoint(api, pathPrefix, cfg)
}

4
internal/api/handlers/v0/auth/none.go
View file

@ -28,7 +28,7 @@ func NewNoneHandler(cfg *config.Config) *NoneHandler {
// RegisterNoneEndpoint registers the anonymous authentication endpoint
// WARNING: This endpoint is intended for local development and automated tests only.
// It should NOT be enabled in production environments as it bypasses normal authentication.
func RegisterNoneEndpoint(api huma.API, cfg *config.Config) {
func RegisterNoneEndpoint(api huma.API, pathPrefix string, cfg *config.Config) {
if !cfg.EnableAnonymousAuth {
return
}
@ -39,7 +39,7 @@ func RegisterNoneEndpoint(api huma.API, cfg *config.Config) {
huma.Register(api, huma.Operation{
OperationID: "get-anonymous-token",
Method: http.MethodPost,
Path: "/v0/auth/none",
Path: pathPrefix + "/auth/none",
Summary: "Get anonymous Registry JWT (Development/Testing Only)",
Description: "Get a short-lived Registry JWT token for publishing and editing servers in the io.modelcontextprotocol.anonymous/* namespace. This endpoint is intended for local development and automated testing only.",
Tags: []string{"auth"},

6
internal/api/handlers/v0/auth/oidc.go
View file

@ -145,7 +145,7 @@ func (h *OIDCHandler) SetValidator(validator GenericOIDCValidator) {
}
// RegisterOIDCEndpoints registers all OIDC authentication endpoints
func RegisterOIDCEndpoints(api huma.API, cfg *config.Config) {
func RegisterOIDCEndpoints(api huma.API, pathPrefix string, cfg *config.Config) {
if !cfg.OIDCEnabled {
return // Skip registration if OIDC is not enabled
}
@ -154,9 +154,9 @@ func RegisterOIDCEndpoints(api huma.API, cfg *config.Config) {
// Direct token exchange endpoint
huma.Register(api, huma.Operation{
OperationID: "exchange-oidc-token",
OperationID: "exchange-oidc-token" + pathPrefix,
Method: http.MethodPost,
Path: "/v0/auth/oidc",
Path: pathPrefix + "/auth/oidc",
Summary: "Exchange OIDC ID token for Registry JWT",
Description: "Exchange an OIDC ID token from any configured provider for a short-lived Registry JWT token",
Tags: []string{"auth"},