-
Notifications
You must be signed in to change notification settings - Fork 65
Expand file tree
/
Copy pathmcp.kuadrant.io_mcpserverregistrations.yaml
More file actions
229 lines (229 loc) · 10.4 KB
/
mcp.kuadrant.io_mcpserverregistrations.yaml
File metadata and controls
229 lines (229 loc) · 10.4 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
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.20.0
name: mcpserverregistrations.mcp.kuadrant.io
spec:
group: mcp.kuadrant.io
names:
kind: MCPServerRegistration
listKind: MCPServerRegistrationList
plural: mcpserverregistrations
shortNames:
- mcpsr
singular: mcpserverregistration
scope: Namespaced
versions:
- additionalPrinterColumns:
- description: Tool prefix for federation
jsonPath: .spec.toolPrefix
name: Prefix
type: string
- description: Target HTTPRoute. MCP Gateway only supports routes with a single
BackendRef
jsonPath: .spec.targetRef.name
name: Target
type: string
- description: MCP endpoint path
jsonPath: .spec.path
name: Path
type: string
- description: Ready status
jsonPath: .status.conditions[?(@.type=='Ready')].status
name: Ready
type: string
- description: Number of discovered tools
jsonPath: .status.discoveredTools
name: Tools
type: integer
- jsonPath: .spec.credentialRef.name
name: Credentials
type: string
- jsonPath: .metadata.creationTimestamp
name: Age
type: date
name: v1alpha1
schema:
openAPIV3Schema:
description: |-
MCPServerRegistration defines a collection of MCP (Model Context Protocol) servers to be aggregated by the gateway.
It enables discovery and federation of tools from multiple backend MCP servers through HTTPRoute references, providing a declarative way to configure which MCP servers should be accessible through the gateway.
properties:
apiVersion:
description: |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
type: string
kind:
description: |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
type: string
metadata:
type: object
spec:
description: spec defines the desired state of MCPServerRegistration.
properties:
category:
description: |-
category is a free-text classification of the server's domain.
Used by the discover_tools meta-tool to present a high-level overview of available servers.
Defaults to "uncategorised" if not set.
type: string
credentialRef:
description: |-
credentialRef references a Secret containing authentication credentials for the MCP server.
The Secret should contain a key with the authentication token or credentials.
The controller will aggregate these credentials and make them available to the broker via environment variables following the pattern: KAGENTI_{MCP_NAME}_CRED
properties:
key:
default: token
description: |-
key is the key within the Secret that contains the credential value.
If not specified, defaults to "token".
type: string
name:
description: name is the name of the Secret resource.
minLength: 1
type: string
required:
- name
type: object
hint:
description: |-
hint is a short natural-language description of what the server's tools do.
Used by the discover_tools meta-tool to help agents decide which tools are relevant
without loading full tool schemas.
type: string
path:
default: /mcp
description: |-
path specifies the URL path where the MCP server endpoint is exposed.
If not specified, defaults to "/mcp".
This allows connecting to MCP servers that use custom paths like "/v1/mcp" or "/api/mcp".
type: string
targetRef:
description: |-
targetRef specifies an HTTPRoute that points to a backend MCP server.
The referenced HTTPRoute should have a backend service that implements the MCP protocol.
The controller will discover the backend service from this HTTPRoute and configure
the broker to federate tools from that MCP server.
properties:
group:
default: gateway.networking.k8s.io
description: group is the group of the target resource.
enum:
- gateway.networking.k8s.io
type: string
kind:
default: HTTPRoute
description: kind is the kind of the target resource.
enum:
- HTTPRoute
type: string
name:
description: name is the name of the target resource.
minLength: 1
type: string
namespace:
description: namespace of the target resource (optional, defaults
to same namespace).
type: string
required:
- name
type: object
toolPrefix:
description: |-
toolPrefix is the prefix to add to all federated tools from referenced servers.
This helps avoid naming conflicts when aggregating tools from multiple sources.
For example, if two servers both provide a 'search' tool, prefixes like 'server1_' and 'server2_' ensure they can coexist as 'server1_search' and 'server2_search'.
type: string
x-kubernetes-validations:
- message: toolPrefix is immutable once set
rule: self == oldSelf
required:
- targetRef
type: object
status:
description: status defines the observed state of MCPServerRegistration.
properties:
conditions:
description: |-
conditions represent the latest available observations of the MCPServerRegistration's state.
Common conditions include 'Ready' to indicate if all referenced servers are accessible.
items:
description: Condition contains details for one aspect of the current
state of this API Resource.
properties:
lastTransitionTime:
description: |-
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
format: date-time
type: string
message:
description: |-
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength: 32768
type: string
observedGeneration:
description: |-
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
format: int64
minimum: 0
type: integer
reason:
description: |-
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
maxLength: 1024
minLength: 1
pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
type: string
status:
description: status of the condition, one of True, False, Unknown.
enum:
- "True"
- "False"
- Unknown
type: string
type:
description: type of condition in CamelCase or in foo.example.com/CamelCase.
maxLength: 316
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
type: string
required:
- lastTransitionTime
- message
- reason
- status
- type
type: object
type: array
x-kubernetes-list-map-keys:
- type
x-kubernetes-list-type: map
discoveredTools:
description: discoveredTools is the number of tools discovered from
this MCPServerRegistration.
format: int32
type: integer
type: object
type: object
served: true
storage: true
subresources:
status: {}