Skip to content

Update kagent and kmcp API reference docs #399

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

Open
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −1
Open

Update kagent and kmcp API reference docs #399

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
2 changes: 1 addition & 1 deletion 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 @@ -752,7 +752,7 @@ _Appears in:_

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `runtime` _[DeclarativeRuntime](#declarativeruntime)_ | Runtime specifies which ADK implementation to use for this agent.<br />- "python": Uses the Python ADK (default, slower startup, full feature set)<br />- "go": Uses the Go ADK (faster startup, most features supported)<br />The runtime determines both the container image and readiness probe configuration. | python | Enum: [python go] <br /> |
| `runtime` _[DeclarativeRuntime](#declarativeruntime)_ | Runtime specifies which ADK implementation to use for this agent.<br />- "go": Uses the Go ADK (default, faster startup, most features supported)<br />- "python": Uses the Python ADK (slower startup, full feature set)<br />The runtime determines both the container image and readiness probe configuration. | go | Enum: [python go] <br /> |
| `systemMessage` _string_ | SystemMessage is a string specifying the system message for the agent.<br />When PromptTemplate is set, this field is treated as a Go text/template<br />with access to an include("source/key") function and agent context variables<br />such as .AgentName, .AgentNamespace, .Description, .ToolNames, and .SkillNames. | | |
| `systemMessageFrom` _[ValueSource](#valuesource)_ | SystemMessageFrom is a reference to a ConfigMap or Secret containing the system message.<br />When PromptTemplate is set, the resolved value is treated as a Go text/template. | | |
| `promptTemplate` _[PromptTemplateSpec](#prompttemplatespec)_ | PromptTemplate enables Go text/template processing on the systemMessage field.<br />When set, systemMessage is treated as a Go template with access to the include function<br />and agent context variables. | | |
Expand Down
5 changes: 5 additions & 0 deletions 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 @@ -313,7 +313,11 @@ A Helm chart for kagent, built with Google ADK
| ui.image.registry | string | `""` | |
| ui.image.repository | string | `"kagent-dev/kagent/ui"` | |
| ui.image.tag | string | `""` | |
| ui.nginx | object | `{"proxyReadTimeout":"1800s","proxySendTimeout":"1800s"}` | Nginx proxy timeout configuration for the UI sidecar (values are passed directly to the corresponding nginx directives, e.g. "1800s"). |
| ui.nginx.proxyReadTimeout | string | `"1800s"` | proxy_read_timeout: max time between two successive reads from the upstream. |
| ui.nginx.proxySendTimeout | string | `"1800s"` | proxy_send_timeout: max time between two successive writes to the upstream. |
| ui.nodeSelector | object | `{}` | Node labels to match for `Pod` [scheduling](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). |
| ui.openshiftRoute.annotations."haproxy.router.openshift.io/timeout" | string | `"120m"` | |
| ui.podAnnotations | object | `{}` | |
| ui.podSecurityContext | object | (uses global podSecurityContext) | Pod-level security context for the UI pod. Overrides the global podSecurityContext. |
| ui.publicBackendUrl | string | `"/api"` | |
Expand All @@ -330,6 +334,7 @@ A Helm chart for kagent, built with Google ADK
| ui.service.ports.targetPort | int | `8080` | |
| ui.service.type | string | `"ClusterIP"` | |
| ui.startupProbe | object | httpGet /health on port http, periodSeconds=1, initialDelaySeconds=1 | Custom startup probe for the UI container. Override to adjust thresholds, use exec-based probes, or change the health path. |
| ui.streamTimeoutSeconds | int | `1800` | Client-side chat stream inactivity timeout (seconds). The browser aborts a streaming response if no event is received within this window. Should be >= ui.nginx.proxyReadTimeout so nginx isn't the silent limit. Default 1800 (30m). |
| ui.tolerations | list | `[]` | Node taints which will be tolerated for `Pod` [scheduling](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). |
| ui.volumes | object | `{"nextjsCache":"100Mi","tmp":"50Mi"}` | EmptyDir volume sizes for Next.js UI workload (typically used when enabling readOnlyRootFilesystem) |
| ui.volumes.nextjsCache | string | `"100Mi"` | Size limit for Next.js build cache (.next/cache). Default 100Mi is sufficient for typical Next.js apps with moderate caching needs. |
Expand Down