Skip to content

Update kagent and kmcp API reference docs #385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
artberger merged 1 commit into from
Jun 12, 2026
+75 −4
Merged

Update kagent and kmcp API reference docs #385

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 71 additions & 3 deletions src/app/docs/kagent/resources/api-ref/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,6 +369,7 @@ Substrate currently expects a gs:// location (see Agent Substrate SnapshotsConfi

_Appears in:_
- [AgentHarnessSubstrateSpec](#agentharnesssubstratespec)
- [SandboxSubstrateSpec](#sandboxsubstratespec)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
Expand Down Expand Up @@ -452,7 +453,7 @@ AgentSpec defines the desired state of Agent.

_Appears in:_
- [Agent](#agent)
- [SandboxAgent](#sandboxagent)
- [SandboxAgentSpec](#sandboxagentspec)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
Expand Down Expand Up @@ -494,6 +495,7 @@ _Validation:_

_Appears in:_
- [AgentSpec](#agentspec)
- [SandboxAgentSpec](#sandboxagentspec)

| Field | Description |
| --- | --- |
Expand All @@ -517,6 +519,7 @@ By default (when not specified), only references from the same namespace are all
_Appears in:_
- [AgentSpec](#agentspec)
- [RemoteMCPServerSpec](#remotemcpserverspec)
- [SandboxAgentSpec](#sandboxagentspec)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
Expand Down Expand Up @@ -598,6 +601,7 @@ _Appears in:_

_Appears in:_
- [AgentSpec](#agentspec)
- [SandboxAgentSpec](#sandboxagentspec)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
Expand Down Expand Up @@ -742,6 +746,7 @@ _Appears in:_

_Appears in:_
- [AgentSpec](#agentspec)
- [SandboxAgentSpec](#sandboxagentspec)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
Expand Down Expand Up @@ -1331,7 +1336,7 @@ _Appears in:_



SandboxAgent declares an agent that runs in an isolated sandbox (agent-sandbox Sandbox CR).
SandboxAgent declares an agent that runs in an isolated sandbox (agent-sandbox or Agent Substrate).



Expand All @@ -1344,10 +1349,34 @@ SandboxAgent declares an agent that runs in an isolated sandbox (agent-sandbox S
| `kind` _string_ | Kind is a string value representing the REST resource this object represents.<br />Servers may infer this from the endpoint the client submits requests to.<br />Cannot be updated.<br />In CamelCase.<br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | |
| `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.<br />Servers should convert recognized schemas to the latest internal value, and<br />may reject unrecognized values.<br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | |
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | |
| `spec` _[AgentSpec](#agentspec)_ | | | |
| `spec` _[SandboxAgentSpec](#sandboxagentspec)_ | | | |
| `status` _[AgentStatus](#agentstatus)_ | | | |


#### SandboxAgentSpec







_Appears in:_
- [SandboxAgent](#sandboxagent)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `type` _[AgentType](#agenttype)_ | | Declarative | Enum: [Declarative BYO] <br /> |
| `byo` _[BYOAgentSpec](#byoagentspec)_ | BYO configures a "bring your own" agent backed by a user-provided<br />container image. Kagent deploys the image and expects it to serve the<br />agent over the A2A protocol on port 8080.<br />Required if type is BYO. | | |
| `declarative` _[DeclarativeAgentSpec](#declarativeagentspec)_ | Declarative configures an agent that is fully described by this resource<br />(model, instructions, tools) and runs on one of kagent's built-in runtimes.<br />Required if type is Declarative. | | |
| `description` _string_ | | | |
| `skills` _[SkillForAgent](#skillforagent)_ | Skills to load into the agent. They will be pulled from the specified container images.<br />and made available to the agent under the `/skills` folder. | | |
| `sandbox` _[SandboxConfig](#sandboxconfig)_ | Sandbox configures sandboxed execution behavior shared across runtimes.<br />This is intended for sandboxed declarative execution today, and can also<br />be consumed by BYO agents. | | |
| `allowedNamespaces` _[AllowedNamespaces](#allowednamespaces)_ | AllowedNamespaces defines which namespaces are allowed to reference this Agent as a tool.<br />This follows the Gateway API pattern for cross-namespace route attachments.<br />If not specified, only Agents in the same namespace can reference this Agent as a tool.<br />This field only applies when this Agent is used as a tool by another Agent.<br />See: https://gateway-api.sigs.k8s.io/guides/multiple-ns/#cross-namespace-route-attachment | | |
| `platform` _[SandboxPlatform](#sandboxplatform)_ | Platform selects the sandbox control plane. Defaults to agent-sandbox. | agent-sandbox | Enum: [agent-sandbox substrate] <br /> |
| `substrate` _[SandboxSubstrateSpec](#sandboxsubstratespec)_ | Substrate is optional substrate-specific settings when platform is substrate. | | |


#### SandboxConfig


Expand All @@ -1358,12 +1387,49 @@ SandboxConfig configures sandboxed execution behavior.

_Appears in:_
- [AgentSpec](#agentspec)
- [SandboxAgentSpec](#sandboxagentspec)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `network` _[NetworkConfig](#networkconfig)_ | Network configures outbound network access for sandboxed execution paths.<br />When unset or when allowedDomains is empty, outbound access is denied by default. | | |


#### SandboxPlatform

_Underlying type:_ _string_

SandboxPlatform selects the control plane for sandboxed agents.

_Validation:_
- Enum: [agent-sandbox substrate]

_Appears in:_
- [SandboxAgentSpec](#sandboxagentspec)

| Field | Description |
| --- | --- |
| `agent-sandbox` | |
| `substrate` | |


#### SandboxSubstrateSpec



SandboxSubstrateSpec configures Agent Substrate for a SandboxAgent.
WorkerPool capacity is referenced from workerPoolRef or the controller default.



_Appears in:_
- [SandboxAgentSpec](#sandboxagentspec)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `workerPoolRef` _[TypedLocalReference](#typedlocalreference)_ | WorkerPoolRef references an existing ate.dev WorkerPool. | | |
| `snapshotsConfig` _[AgentHarnessSubstrateSnapshotsConfig](#agentharnesssubstratesnapshotsconfig)_ | SnapshotsConfig configures actor memory snapshots.<br />Defaults to gs://ate-snapshots/&lt;namespace&gt;/&lt;agentname&gt; when unset. | | |


#### SecretReference


Expand Down Expand Up @@ -1443,6 +1509,7 @@ _Appears in:_

_Appears in:_
- [AgentSpec](#agentspec)
- [SandboxAgentSpec](#sandboxagentspec)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
Expand Down Expand Up @@ -1576,6 +1643,7 @@ _Appears in:_
_Appears in:_
- [AgentHarnessSubstrateSpec](#agentharnesssubstratespec)
- [PromptSource](#promptsource)
- [SandboxSubstrateSpec](#sandboxsubstratespec)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
Expand Down
5 changes: 4 additions & 1 deletion src/app/docs/kagent/resources/helm/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ A Helm chart for kagent, built with Google ADK
| file://../tools/querydoc | querydoc | |
| https://oauth2-proxy.github.io/manifests | oauth2-proxy | ~7.0.0 |
| oci://ghcr.io/kagent-dev/kmcp/helm | kmcp | `${KMCP_VERSION}` |
| oci://ghcr.io/kagent-dev/tools/helm | kagent-tools | 0.1.3 |
| oci://ghcr.io/kagent-dev/tools/helm | kagent-tools | 0.2.1 |

## Values

Expand Down Expand Up @@ -92,6 +92,9 @@ A Helm chart for kagent, built with Google ADK
| controller.substrate.ateApiInsecure | bool | `false` | |
| controller.substrate.ateApiServer.namespace | string | `"ate-system"` | |
| controller.substrate.ateApiServer.serviceAccount | string | `"ate-api-server"` | |
| controller.substrate.ateApiTokenAudience | string | `"api.ate-system.svc"` | |
| controller.substrate.ateApiTokenExpirationSeconds | int | `3600` | |
| controller.substrate.ateApiTokenFile | string | `"/var/run/secrets/tokens/ate-api/token"` | |
| controller.substrate.atenetRouterURL | string | `""` | |
| controller.substrate.defaultWorkerPool.name | string | `""` | |
| controller.substrate.defaultWorkerPool.namespace | string | `""` | |
Expand Down
Loading