-
Notifications
You must be signed in to change notification settings - Fork 33
Expand file tree
/
Copy pathregistryclient.go
More file actions
406 lines (352 loc) · 12.1 KB
/
Copy pathregistryclient.go
File metadata and controls
406 lines (352 loc) · 12.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
package externalmcp
import (
"context"
"encoding/json"
"fmt"
"io"
"log/slog"
"net/http"
"net/url"
"github.com/google/uuid"
"github.com/hashicorp/go-retryablehttp"
"go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"
"go.opentelemetry.io/otel/trace"
"github.com/speakeasy-api/gram/server/gen/types"
"github.com/speakeasy-api/gram/server/internal/attr"
"github.com/speakeasy-api/gram/server/internal/cache"
externalmcptypes "github.com/speakeasy-api/gram/server/internal/externalmcp/repo/types"
"github.com/speakeasy-api/gram/server/internal/o11y"
"github.com/speakeasy-api/gram/server/internal/oops"
)
type RegistryBackend interface {
Match(req *http.Request) bool
Authorize(req *http.Request) error
}
// RegistryClient handles communication with external MCP registries.
type RegistryClient struct {
httpClient *http.Client
logger *slog.Logger
backend RegistryBackend
listCache *cache.TypedCacheObject[CachedListServersResponse]
detailsCache *cache.TypedCacheObject[CachedServerDetailsResponse]
}
// NewRegistryClient creates a new registry client. The cacheImpl parameter is
// optional — pass nil to disable caching.
func NewRegistryClient(logger *slog.Logger, tracerProvider trace.TracerProvider, backend RegistryBackend, cacheImpl cache.Cache) *RegistryClient {
rc := &RegistryClient{
httpClient: &http.Client{
Transport: otelhttp.NewTransport(
retryablehttp.NewClient().StandardClient().Transport,
otelhttp.WithTracerProvider(tracerProvider),
),
},
logger: logger.With(attr.SlogComponent("mcp-registry-client")),
backend: backend,
listCache: nil,
detailsCache: nil,
}
if cacheImpl != nil {
listCache := cache.NewTypedObjectCache[CachedListServersResponse](
logger.With(attr.SlogCacheNamespace("registry-list")),
cacheImpl,
cache.SuffixNone,
)
rc.listCache = &listCache
detailsCache := cache.NewTypedObjectCache[CachedServerDetailsResponse](
logger.With(attr.SlogCacheNamespace("registry-details")),
cacheImpl,
cache.SuffixNone,
)
rc.detailsCache = &detailsCache
}
return rc
}
// Registry represents an MCP registry endpoint.
type Registry struct {
ID uuid.UUID
URL string
}
// ListServersParams contains optional parameters for listing servers.
type ListServersParams struct {
Search *string
Cursor *string
}
// listResponse represents the response from the MCP registry API.
type listResponse struct {
Servers []serverEntry `json:"servers"`
Metadata struct {
Count int `json:"count"`
NextCursor *string `json:"nextCursor"`
} `json:"metadata"`
}
type serverEntry struct {
Server serverJSON `json:"server"`
Meta serverMeta `json:"_meta"`
}
type serverMeta struct {
Server serverMetaServer `json:"com.pulsemcp/server"`
Version serverMetaVersion `json:"com.pulsemcp/server-version"`
}
type serverMetaServer struct {
VisitorsEstimateMostRecentWeek int `json:"visitorsEstimateMostRecentWeek"`
VisitorsEstimateLastFourWeeks int `json:"visitorsEstimateLastFourWeeks"`
VisitorsEstimateTotal int `json:"visitorsEstimateTotal"`
IsOfficial bool `json:"isOfficial"`
}
type serverMetaVersion struct {
Source string `json:"source"`
Status string `json:"status"`
PublishedAt string `json:"publishedAt"`
UpdatedAt string `json:"updatedAt"`
IsLatest bool `json:"isLatest"`
FirstRemote serverRemoteMeta `json:"remotes[0]"`
SecondRemote serverRemoteMeta `json:"remotes[1]"`
ThirdRemote serverRemoteMeta `json:"remotes[2]"`
FourthRemote serverRemoteMeta `json:"remotes[3]"`
FifthRemote serverRemoteMeta `json:"remotes[4]"`
}
type serverJSON struct {
Name string `json:"name"`
Description string `json:"description"`
Version string `json:"version"`
Title *string `json:"title"`
WebsiteURL *string `json:"websiteUrl"`
Icons []struct {
Src string `json:"src"`
} `json:"icons"`
Remotes []serverRemoteBasic `json:"remotes"`
}
type serverRemoteBasic struct {
URL string `json:"url"`
Type string `json:"type"`
Headers []RemoteHeader `json:"headers"`
}
// RemoteHeader represents a header requirement from the registry.
type RemoteHeader struct {
Name string `json:"name"`
IsSecret bool `json:"isSecret"`
IsRequired bool `json:"isRequired"`
Description *string `json:"description,omitempty"`
Placeholder *string `json:"placeholder,omitempty"`
}
type serverRemoteMeta struct {
Auth any `json:"auth"`
Tools []serverTool `json:"tools"`
}
// serverDetailsEntry represents the response from the server details endpoint
type serverDetailsEntry struct {
Server serverDetailsJSON `json:"server"`
Meta serverMeta `json:"_meta"`
}
type serverDetailsJSON struct {
Name string `json:"name"`
Description string `json:"description"`
Version string `json:"version"`
Remotes []serverRemoteBasic `json:"remotes"`
}
type serverTool struct {
Name string `json:"name"`
Description string `json:"description"`
InputSchema json.RawMessage `json:"inputSchema"`
Annotations map[string]any `json:"annotations"`
}
// ListServers fetches servers from the given registry.
func (c *RegistryClient) ListServers(ctx context.Context, registry Registry, params ListServersParams) ([]*types.ExternalMCPServer, error) {
reqURL := fmt.Sprintf("%s/v0.1/servers?version=latest&limit=50", registry.URL)
if params.Search != nil && *params.Search != "" {
reqURL += fmt.Sprintf("&search=%s", *params.Search)
}
if params.Cursor != nil && *params.Cursor != "" {
reqURL += fmt.Sprintf("&cursor=%s", *params.Cursor)
}
c.logger.InfoContext(ctx, "fetching servers from registry", attr.SlogMCPRegistryURL(reqURL))
req, err := http.NewRequestWithContext(ctx, http.MethodGet, reqURL, nil)
if err != nil {
return nil, fmt.Errorf("create list servers request: %w", err)
}
if c.backend.Match(req) {
if err := c.backend.Authorize(req); err != nil {
return nil, fmt.Errorf("authorize list servers request: %w", err)
}
}
// Check cache after authorization so headers are populated.
if c.listCache != nil {
cacheKey := registryCacheKey("list", req)
cached, err := c.listCache.Get(ctx, cacheKey)
if err == nil {
c.logger.DebugContext(ctx, "registry list cache hit", attr.SlogCacheKey(cacheKey))
return cached.Servers, nil
}
}
resp, err := c.httpClient.Do(req)
if err != nil {
return nil, fmt.Errorf("failed to fetch from registry: %w", err)
}
defer o11y.LogDefer(ctx, c.logger, func() error {
return resp.Body.Close()
})
if resp.StatusCode != http.StatusOK {
return nil, fmt.Errorf("registry returned status %d", resp.StatusCode)
}
body, err := io.ReadAll(resp.Body)
if err != nil {
return nil, fmt.Errorf("failed to read response body: %w", err)
}
var listResp listResponse
if err := json.Unmarshal(body, &listResp); err != nil {
return nil, fmt.Errorf("failed to decode registry response: %w", err)
}
registryID := registry.ID.String()
servers := make([]*types.ExternalMCPServer, 0, len(listResp.Servers))
for _, s := range listResp.Servers {
if s.Meta.Version.Status == "deleted" {
continue
}
var iconURL *string
if len(s.Server.Icons) > 0 {
iconURL = &s.Server.Icons[0].Src
}
tools := make([]*types.ExternalMCPTool, 0)
for _, tool := range s.Meta.Version.FirstRemote.Tools {
tools = append(tools, &types.ExternalMCPTool{
Name: &tool.Name,
Description: &tool.Description,
InputSchema: tool.InputSchema,
Annotations: tool.Annotations,
})
}
server := &types.ExternalMCPServer{
RegistrySpecifier: s.Server.Name,
Version: s.Server.Version,
Description: s.Server.Description,
RegistryID: registryID,
Title: s.Server.Title,
IconURL: iconURL,
Meta: s.Meta,
Tools: tools,
}
servers = append(servers, server)
}
// Store in cache on success.
if c.listCache != nil {
cacheKey := registryCacheKey("list", req)
if storeErr := c.listCache.Store(ctx, CachedListServersResponse{
Key: cacheKey,
Servers: servers,
}); storeErr != nil {
c.logger.WarnContext(ctx, "failed to store registry list in cache", attr.SlogError(storeErr))
}
}
return servers, nil
}
// ServerDetails contains detailed information about an MCP server including connection info.
type ServerDetails struct {
Name string
Description string
Version string
RemoteURL string
TransportType externalmcptypes.TransportType
Tools []serverTool
Headers []RemoteHeader
}
// GetServerDetails fetches server details including the remote URL from the registry.
func (c *RegistryClient) GetServerDetails(ctx context.Context, registry Registry, serverName string) (*ServerDetails, error) {
u, err := url.Parse(registry.URL)
if err != nil {
return nil, oops.Permanent(fmt.Errorf("parse external mcp registry url: %w", err))
}
u = u.JoinPath("v0.1", "servers", url.PathEscape(serverName), "versions", "latest")
c.logger.InfoContext(ctx, "fetching server details from registry", attr.SlogURL(u.String()))
req, err := http.NewRequestWithContext(ctx, http.MethodGet, u.String(), nil)
if err != nil {
return nil, oops.Permanent(fmt.Errorf("create external mcp server details request: %w", err))
}
if c.backend.Match(req) {
if err := c.backend.Authorize(req); err != nil {
return nil, fmt.Errorf("authorize external mcp server details request: %w", err)
}
}
// Check cache after authorization so headers are populated.
if c.detailsCache != nil {
cacheKey := registryCacheKey("details", req)
cached, err := c.detailsCache.Get(ctx, cacheKey)
if err == nil {
c.logger.DebugContext(ctx, "registry details cache hit", attr.SlogCacheKey(cacheKey))
return cached.Details, nil
}
}
resp, err := c.httpClient.Do(req)
if err != nil {
return nil, fmt.Errorf("send external mcp server details request: %w", err)
}
defer o11y.NoLogDefer(func() error { return resp.Body.Close() })
if resp.StatusCode != http.StatusOK {
err := fmt.Errorf("registry returned status %d", resp.StatusCode)
isRetryable := resp.StatusCode == 429 || resp.StatusCode >= 500 && resp.StatusCode < 600
if !isRetryable {
err = oops.Permanent(err)
}
return nil, err
}
body, err := io.ReadAll(resp.Body)
if err != nil {
return nil, fmt.Errorf("read external mcp server details response: %w", err)
}
var serverResp serverDetailsEntry
if err := json.Unmarshal(body, &serverResp); err != nil {
return nil, fmt.Errorf("decode external mcp server details response: %w", err)
}
// Find the remote URL, preferring streamable-http over sse
var remoteURL string
var transportType externalmcptypes.TransportType
var tools []serverTool
var headers []RemoteHeader
var remoteIndex int
for i, remote := range serverResp.Server.Remotes {
if remote.Type == "streamable-http" {
remoteURL = remote.URL
transportType = externalmcptypes.TransportTypeStreamableHTTP
headers = remote.Headers
remoteIndex = i
break
} else if remote.Type == "sse" {
remoteURL = remote.URL
transportType = externalmcptypes.TransportTypeSSE
headers = remote.Headers
remoteIndex = i
}
}
// Obviously not ideal, this is just the way the registry API is structured
switch remoteIndex {
case 0:
tools = serverResp.Meta.Version.FirstRemote.Tools
case 1:
tools = serverResp.Meta.Version.SecondRemote.Tools
case 2:
tools = serverResp.Meta.Version.ThirdRemote.Tools
case 3:
tools = serverResp.Meta.Version.FourthRemote.Tools
case 4:
tools = serverResp.Meta.Version.FifthRemote.Tools
}
details := &ServerDetails{
Name: serverResp.Server.Name,
Description: serverResp.Server.Description,
Version: serverResp.Server.Version,
RemoteURL: remoteURL,
TransportType: transportType,
Tools: tools,
Headers: headers,
}
// Store in cache on success.
if c.detailsCache != nil {
cacheKey := registryCacheKey("details", req)
if storeErr := c.detailsCache.Store(ctx, CachedServerDetailsResponse{
Key: cacheKey,
Details: details,
}); storeErr != nil {
c.logger.WarnContext(ctx, "failed to store registry details in cache", attr.SlogError(storeErr))
}
}
return details, nil
}