registry/docs/reference
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Aleksandr Beshkenadze cce5e5df46
feat: add OpenAPI tags for improved SDK generation and API organization (#655)
## Summary
Adds OpenAPI tags to improve SDK generation and API documentation
organization, as discussed in #644.

## Changes
- **Go Code**: Define tag metadata (name + description) in
`internal/api/router/router.go` using Huma's `api.OpenAPI().Tags`
- **Reference Spec**: Update `docs/reference/api/openapi.yaml` to match
the generated spec
- **Tags Added**: servers, publish, auth, admin, health, ping

## Benefits
- ✅ Improved SDK generation with proper service grouping (e.g.,
`serversService`, `publishService`)
- ✅ Better API documentation organization in Scalar UI, Swagger UI, and
other tools
- ✅ Code-first approach ensures reference spec stays in sync via
compliance tests

## Testing
- ✅ Compliance test passes: `go test -v ./internal/api -run
TestOpenAPIEndpointCompliance`
- ✅ All 4 reference endpoints verified as implemented
- ✅ TypeScript SDK regenerated successfully with proper tag-based
grouping

## Related
Closes #644
2025-10-14 14:30:36 +03:00
..
api feat: add OpenAPI tags for improved SDK generation and API organization (#655) 2025-10-14 14:30:36 +03:00
cli Introduce serverId, rename id to versionId (#465) 2025-09-21 15:00:09 +03:00
server-json Refactor package types to use dedicated schema types per package type (NPM, PyPI, NuGet, OCI, MCPB) (#634) 2025-10-11 10:53:45 +03:00
faq.md Clarify the docs around open/closed source and public/private MCP servers (#573) 2025-09-29 22:29:26 +01:00
README.md Big docs tidy up in preparation for launch (#364) 2025-09-07 10:44:42 +01:00

Reference Documentation

Technical specifications and quick lookups for the MCP Registry.

API Reference

server.json Reference

CLI Reference

Quick Reference