Skip to content
ctxmesh

API group

Every ctxmesh custom resource lives in the agents.ctxmesh.ai API group, served at v1beta1 (the storage version). Most resources graduated from v1alpha1, which is still served during the deprecation window with a direct (field-identical) conversion; a few newer kinds are born directly in v1beta1 as single-version CRDs. Always author resources at agents.ctxmesh.ai/v1beta1.

Kinds served

Section titled “Kinds served”
Kind Plural shortName Scope Page
AgentDeployment agentdeployments — Namespaced AgentDeployment
AgentVersion agentversions — Namespaced AgentVersion
AgentRegistry agentregistries ar Namespaced AgentRegistry
ModelRoute modelroutes mr Namespaced ModelRoute
SecretBinding secretbindings sb Namespaced SecretBinding
CredentialStore credentialstores credstore Namespaced CredentialStore
ClusterCredentialStore clustercredentialstores clustercredstore Cluster CredentialStore
MCPToolBinding mcptoolbindings mtb Namespaced MCPToolBinding
AgentScalingPolicy agentscalingpolicies asp Namespaced AgentScalingPolicy
EvalSuite evalsuites es Namespaced EvalSuite
GuardrailPolicy guardrailpolicies gp Namespaced GuardrailPolicy
ApprovalPolicy approvalpolicies apr Namespaced ApprovalPolicy
FeedbackStore feedbackstores fs Namespaced FeedbackStore
AlertPolicy alertpolicies ap Namespaced AlertPolicy
AgentTeam agentteams at Namespaced AgentTeam
Workflow workflows wf Namespaced Workflow
KnowledgeBase knowledgebases kb Namespaced KnowledgeBase
Tenant tenants tnt Cluster Tenant

All kinds are in the agents category, so kubectl get agents lists them together (within a namespace, and the cluster-scoped ones alongside).

Retired / folded resources (not served here) are documented at Retired resources.

Versions

Section titled “Versions”

v1beta1 is the storage version for every kind. These kinds are also served at v1alpha1 during the deprecation window: AgentDeployment, AgentVersion, AgentRegistry, ModelRoute, SecretBinding, CredentialStore, ClusterCredentialStore, MCPToolBinding, AgentScalingPolicy, EvalSuite, Tenant. The remaining kinds — GuardrailPolicy, ApprovalPolicy, FeedbackStore, AlertPolicy, AgentTeam, Workflow, KnowledgeBase — are single-version, born directly in v1beta1. Author everything at v1beta1.

kubectl usage

Section titled “kubectl usage”

List and inspect resources (by full name, plural, or shortName):

Terminal window
# Everything in the agents category, in a namespace
kubectl get agents -n my-team


# A specific kind, by shortName
kubectl get mr -n my-team                 # ModelRoutes
kubectl get gp -n my-team                 # GuardrailPolicies
kubectl get agentdeployments -n my-team   # no shortName


# Cluster-scoped kinds
kubectl get tenants
kubectl get clustercredentialstores


# Describe / inspect
kubectl describe agentdeployment support-agent -n my-team
kubectl get agentdeployment support-agent -n my-team -o yaml

Apply and delete manifests:

Terminal window
kubectl apply -f agent.yaml
kubectl delete agentdeployment support-agent -n my-team

Watch reconciliation via the printed status columns (each kind surfaces its own — e.g. AgentDeployment prints Ready, URL, Version, Gate):

Terminal window
kubectl get agentdeployments -n my-team -w

Discover the served group/versions and per-kind schema on your cluster:

Terminal window
kubectl api-resources --api-group=agents.ctxmesh.ai
kubectl explain agentdeployment.spec --api-version=agents.ctxmesh.ai/v1beta1

See also

Section titled “See also”