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

Introduce a /version API (#667)

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 introduces a `/version` API that serves the build
details along with the version of the API server being served. The
`/version` endpoint allows users to programmatically query which exact
version of the registry is running in production for debugging.
~~auditing, and compatibility checks~~.

## 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? -->

## 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
-->

Signed-off-by: Radoslav Dimitrov <radoslav@stacklok.com>
This commit is contained in:
Radoslav Dimitrov 2025-10-15 17:24:46 +03:00 • committed by GitHub
commit 2a80690063
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 142 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

11
internal/api/router/router.go
View file

@ -13,6 +13,7 @@ import (
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/metric"
v0 "github.com/modelcontextprotocol/registry/internal/api/handlers/v0"
"github.com/modelcontextprotocol/registry/internal/config"
"github.com/modelcontextprotocol/registry/internal/service"
"github.com/modelcontextprotocol/registry/internal/telemetry"
@ -129,7 +130,7 @@ func handle404(w http.ResponseWriter, r *http.Request) {
}
// NewHumaAPI creates a new Huma API with all routes registered
func NewHumaAPI(cfg *config.Config, registry service.RegistryService, mux *http.ServeMux, metrics *telemetry.Metrics) huma.API {
func NewHumaAPI(cfg *config.Config, registry service.RegistryService, mux *http.ServeMux, metrics *telemetry.Metrics, versionInfo *v0.VersionBody) huma.API {
// Create Huma API configuration
humaConfig := huma.DefaultConfig("Official MCP Registry", "1.0.0")
humaConfig.Info.Description = "A community driven registry service for Model Context Protocol (MCP) servers.\n\n[GitHub repository](https://github.com/modelcontextprotocol/registry) | [Documentation](https://github.com/modelcontextprotocol/registry/tree/main/docs)"
@ -165,6 +166,10 @@ func NewHumaAPI(cfg *config.Config, registry service.RegistryService, mux *http.
Name: "ping",
Description: "Simple ping endpoint for testing connectivity",
},
{
Name: "version",
Description: "Version information endpoint for retrieving build and version details",
},
}
// Add metrics middleware with options
@ -173,8 +178,8 @@ func NewHumaAPI(cfg *config.Config, registry service.RegistryService, mux *http.
))
// Register routes for all API versions
RegisterV0Routes(api, cfg, registry, metrics)
RegisterV0_1Routes(api, cfg, registry, metrics)
RegisterV0Routes(api, cfg, registry, metrics, versionInfo)
RegisterV0_1Routes(api, cfg, registry, metrics, versionInfo)
// Add /metrics for Prometheus metrics using promhttp
mux.Handle("/metrics", metrics.PrometheusHandler())

6
internal/api/router/v0.go
View file

@ -12,10 +12,11 @@ import (
)
func RegisterV0Routes(
api huma.API, cfg *config.Config, registry service.RegistryService, metrics *telemetry.Metrics,
api huma.API, cfg *config.Config, registry service.RegistryService, metrics *telemetry.Metrics, versionInfo *v0.VersionBody,
) {
v0.RegisterHealthEndpoint(api, "/v0", cfg, metrics)
v0.RegisterPingEndpoint(api, "/v0")
v0.RegisterVersionEndpoint(api, "/v0", versionInfo)
v0.RegisterServersEndpoints(api, "/v0", registry)
v0.RegisterEditEndpoints(api, "/v0", registry, cfg)
v0auth.RegisterAuthEndpoints(api, "/v0", cfg)
@ -23,10 +24,11 @@ func RegisterV0Routes(
}
func RegisterV0_1Routes(
api huma.API, cfg *config.Config, registry service.RegistryService, metrics *telemetry.Metrics,
api huma.API, cfg *config.Config, registry service.RegistryService, metrics *telemetry.Metrics, versionInfo *v0.VersionBody,
) {
v0.RegisterHealthEndpoint(api, "/v0.1", cfg, metrics)
v0.RegisterPingEndpoint(api, "/v0.1")
v0.RegisterVersionEndpoint(api, "/v0.1", versionInfo)
v0.RegisterServersEndpoints(api, "/v0.1", registry)
v0.RegisterEditEndpoints(api, "/v0.1", registry, cfg)
v0auth.RegisterAuthEndpoints(api, "/v0.1", cfg)