Resources / MCPEndpoint

MCPEndpoint

A Model Context Protocol server for this project that gives an AI client two tools only: search the project's API, and run one GraphQL document against it. It acts as a named service account, so it can never do more than that account may; make one endpoint per client and per purpose. Clients connect over Streamable HTTP with a token of an MCPCredential.

Overview

APIintelligence.etorm.com/v1alpha1
Resourcemcpendpoints (cluster-scoped inside its cluster)
Short namesmcp
Available inproject clusters only
Statuswritten by a controller through /status

Minimal example

apiVersion: intelligence.etorm.com/v1alpha1
kind: MCPEndpoint
metadata:
  name: example
spec:
  serviceAccountRef:
    name: "<name>"

Spec

FieldTypeRequiredDefaultAllowedDescription
serviceAccountRefreference to ServiceAccountyesThe service account the endpoint acts as. Every call is authorized as this account, like any call it would make itself. Whoever creates the endpoint must be allowed to act as it.
workspaceRefreference to WorkspaceServe a whole workspace instead of this project alone: documents reach every project below the workspace that the service account may use, and name the project they write in. This project must be in the workspace or below it, and the service account's rights come from its own bindings here and from bindings scoped to the workspace or its ancestors, never from above. Cannot be changed.
descriptionstringup to 500 charactersWhat this endpoint is for (who connects, to do what).
readOnlybooleantruetrue refuses every document that creates, changes or deletes anything, whatever the service account may do. Turn it off deliberately.
allowobject{}Narrows what a document may touch, within what the service account may do.
allow.groupslist of stringup to 50 itemsAPI groups a document may touch. Empty means every group the service account may use except the sensitive ones (identity and access, secrets, billing, projects), which must be named here to be reachable.
allow.kindslist of stringup to 200 itemsFurther narrows to these kinds, each written group/plural (for example network.etorm.com/vpcs). Empty means no narrowing.
limitsobject{}Limits of one call.
limits.maxResultBytesinteger2621441024 to 1048576The largest answer a call returns; a document whose answer is larger is refused with advice to ask for less.
retentionDaysinteger301 to 365How long the record of each call (MCPCall) is kept.
disabledbooleanfalsetrue ends every session at once and refuses new ones; credentials stay.

Status

FieldTypeRequiredDefaultAllowedDescription
phasestringReady, Disabled or Invalid.
urlstringThe address clients connect to (Streamable HTTP).
credentialsintegerCredentials of the endpoint that are still valid.
usageobjectWhat the endpoint served, in all.
usage.toolCallsintegerTool calls served.
usage.refusedintegerTool calls refused.
usage.lastCallAtstringWhen the last call was made (RFC 3339).
conditionslist of objectDetailed state.
conditions[].typestringAspect.
conditions[].statusstringTrue or False.
conditions[].reasonstringMachine-readable reason.
conditions[].messagestringHuman-readable detail.

Columns in listings

ColumnFrom
Account.spec.serviceAccountRef.name
ReadOnly.spec.readOnly
Calls.status.usage.toolCalls
Phase.status.phase
URL.status.url

All resources