From d49eecd4a694926f41528fdeda3429b1f776130e Mon Sep 17 00:00:00 2001 From: Rachael-Graham <29711887+Rachael-Graham@users.noreply.github.com> Date: Fri, 16 Oct 2026 20:37:01 +0000 Subject: [PATCH] docs: Update kagent 1.x reference docs at v1.0.0-alpha14 Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- .../assets/kagent-docs/versions/kagent.md | 2 +- .../versions/runtime-image-claude.md | 2 +- .../versions/runtime-image-codex.md | 2 +- .../kagent-docs/versions/runtime-image.md | 2 +- .../content/kagent/1.x/reference/api-ref.md | 57 +++++++++++---- .../kagent/1.x/reference/cli/_index.md | 1 - .../1.x/reference/cli/kagent-agent-invoke.md | 1 - .../reference/cli/kagent-db-migrate-down.md | 6 +- .../reference/cli/kagent-db-migrate-goto.md | 6 +- .../reference/cli/kagent-db-migrate-status.md | 6 +- .../1.x/reference/cli/kagent-db-migrate-up.md | 6 +- .../cli/kagent-db-migrate-version.md | 6 +- .../1.x/reference/cli/kagent-db-migrate.md | 9 ++- .../1.x/reference/cli/kagent-mcp-add-tool.md | 45 ------------ .../1.x/reference/cli/kagent-mcp-build.md | 43 ----------- .../cli/kagent-mcp-deploy-package.md | 54 -------------- .../1.x/reference/cli/kagent-mcp-deploy.md | 73 ------------------- .../1.x/reference/cli/kagent-mcp-init-go.md | 39 ---------- .../1.x/reference/cli/kagent-mcp-init-java.md | 36 --------- .../reference/cli/kagent-mcp-init-python.md | 36 --------- .../cli/kagent-mcp-init-typescript.md | 36 --------- .../1.x/reference/cli/kagent-mcp-init.md | 43 ----------- .../1.x/reference/cli/kagent-mcp-run.md | 50 ------------- .../reference/cli/kagent-mcp-secrets-sync.md | 52 ------------- .../1.x/reference/cli/kagent-mcp-secrets.md | 30 -------- .../kagent/1.x/reference/cli/kagent-mcp.md | 36 --------- .../reference/cli/kagent-sandbox-create.md | 2 +- .../reference/cli/kagent-sandbox-delete.md | 2 +- .../reference/cli/kagent-sandbox-download.md | 2 +- .../1.x/reference/cli/kagent-sandbox-exec.md | 2 +- .../1.x/reference/cli/kagent-sandbox-get.md | 2 +- .../1.x/reference/cli/kagent-sandbox-kill.md | 2 +- .../1.x/reference/cli/kagent-sandbox-list.md | 2 +- .../reference/cli/kagent-sandbox-process.md | 2 +- .../reference/cli/kagent-sandbox-resume.md | 2 +- .../reference/cli/kagent-sandbox-suspend.md | 2 +- .../reference/cli/kagent-sandbox-templates.md | 2 +- .../reference/cli/kagent-sandbox-upload.md | 2 +- .../1.x/reference/cli/kagent-sandbox-wait.md | 2 +- .../1.x/reference/cli/kagent-sandbox.md | 2 +- .../1.x/reference/cli/kagent-uninstall.md | 2 +- .../1.x/reference/cli/kagent-version.md | 2 +- .../content/kagent/1.x/reference/helm.md | 26 ++++--- 43 files changed, 95 insertions(+), 642 deletions(-) delete mode 100644 docs-site/content/kagent/1.x/reference/cli/kagent-mcp-add-tool.md delete mode 100644 docs-site/content/kagent/1.x/reference/cli/kagent-mcp-build.md delete mode 100644 docs-site/content/kagent/1.x/reference/cli/kagent-mcp-deploy-package.md delete mode 100644 docs-site/content/kagent/1.x/reference/cli/kagent-mcp-deploy.md delete mode 100644 docs-site/content/kagent/1.x/reference/cli/kagent-mcp-init-go.md delete mode 100644 docs-site/content/kagent/1.x/reference/cli/kagent-mcp-init-java.md delete mode 100644 docs-site/content/kagent/1.x/reference/cli/kagent-mcp-init-python.md delete mode 100644 docs-site/content/kagent/1.x/reference/cli/kagent-mcp-init-typescript.md delete mode 100644 docs-site/content/kagent/1.x/reference/cli/kagent-mcp-init.md delete mode 100644 docs-site/content/kagent/1.x/reference/cli/kagent-mcp-run.md delete mode 100644 docs-site/content/kagent/1.x/reference/cli/kagent-mcp-secrets-sync.md delete mode 100644 docs-site/content/kagent/1.x/reference/cli/kagent-mcp-secrets.md delete mode 100644 docs-site/content/kagent/1.x/reference/cli/kagent-mcp.md diff --git a/docs-site/assets/kagent-docs/versions/kagent.md b/docs-site/assets/kagent-docs/versions/kagent.md index 70cb88cf..9ac70af4 100644 --- a/docs-site/assets/kagent-docs/versions/kagent.md +++ b/docs-site/assets/kagent-docs/versions/kagent.md @@ -1 +1 @@ -{{< version include-if="0.x" >}}0.10.3{{< /version >}}{{< version include-if="1.x" >}}1.0.0-alpha13{{< /version >}} \ No newline at end of file +{{< version include-if="0.x" >}}0.10.3{{< /version >}}{{< version include-if="1.x" >}}1.0.0-alpha14{{< /version >}} \ No newline at end of file diff --git a/docs-site/assets/kagent-docs/versions/runtime-image-claude.md b/docs-site/assets/kagent-docs/versions/runtime-image-claude.md index 99841bc8..7bf60767 100644 --- a/docs-site/assets/kagent-docs/versions/runtime-image-claude.md +++ b/docs-site/assets/kagent-docs/versions/runtime-image-claude.md @@ -1 +1 @@ -ghcr.io/kagent-dev/kagent/claude-harness@sha256:ceaf7caa7366b96c11cb85ad0bad435a35fcd2704c657b895ee3e73978045db8 \ No newline at end of file +ghcr.io/kagent-dev/kagent/claude-harness@sha256:b33b9e3ab90bcba19f0ec719a249b35321cf7508f90cfe7fe1af550f09c9310c \ No newline at end of file diff --git a/docs-site/assets/kagent-docs/versions/runtime-image-codex.md b/docs-site/assets/kagent-docs/versions/runtime-image-codex.md index 03c7ce2e..3cddc826 100644 --- a/docs-site/assets/kagent-docs/versions/runtime-image-codex.md +++ b/docs-site/assets/kagent-docs/versions/runtime-image-codex.md @@ -1 +1 @@ -ghcr.io/kagent-dev/kagent/codex-harness@sha256:04788e85c9e1ef98b3f568b9aa749a5e16d2250d115449332dba98baa26305fa \ No newline at end of file +ghcr.io/kagent-dev/kagent/codex-harness@sha256:69f02eff6f78a5f78724f6e5ec856119856ea4d479e0f06455115e45ad2de6fc \ No newline at end of file diff --git a/docs-site/assets/kagent-docs/versions/runtime-image.md b/docs-site/assets/kagent-docs/versions/runtime-image.md index a9281acd..2b4df44a 100644 --- a/docs-site/assets/kagent-docs/versions/runtime-image.md +++ b/docs-site/assets/kagent-docs/versions/runtime-image.md @@ -1 +1 @@ -ghcr.io/kagent-dev/kagent/golang-adk@sha256:ae01c3a6d7e0ed2e044253a26abbfb1a9426f3176363842ca9a954762c274d36 \ No newline at end of file +ghcr.io/kagent-dev/kagent/golang-adk@sha256:eb1b0c7f635f31d464cff7cf212275f2642057a629ed20b39661e9f644f71f21 \ No newline at end of file diff --git a/docs-site/content/kagent/1.x/reference/api-ref.md b/docs-site/content/kagent/1.x/reference/api-ref.md index 40f2c81f..c889f05c 100644 --- a/docs-site/content/kagent/1.x/reference/api-ref.md +++ b/docs-site/content/kagent/1.x/reference/api-ref.md @@ -46,7 +46,7 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | -| `template` _[AgentTemplateSource](#agenttemplatesource)_ | Template selects the portable behavior this Agent exposes. | | **Required**
| +| `template` _[AgentTemplateSource](#agenttemplatesource)_ | Template selects the portable behavior this Agent exposes. | | ExactlyOneOf: [inline ref]
**Required**
| | `harnessRef` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#localobjectreference-v1-core)_ | HarnessRef selects the platform-managed runtime configuration that executes
the behavior. | | **Required**
| #### AgentStatus @@ -61,6 +61,7 @@ _Appears in:_ | `observedGeneration` _integer_ | | | | | `desiredRevision` _string_ | | | MinLength: 1
| | `latestSuccessfulRevision` _string_ | | | MinLength: 1
| +| `workloadImage` _string_ | WorkloadImage is the digest-pinned image selected for the desired revision.
Existing Sessions may still use an older revision and image. | | Pattern: `^[^[:space:]@]+@sha256:[a-f0-9]\{64\}$`
| | `warnings` _string array_ | Warnings reports non-blocking compatibility decisions made while compiling
this Agent. | | MaxItems: 100
| | `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#condition-v1-meta) array_ | | | MaxItems: 4
| @@ -75,7 +76,7 @@ AgentTemplate defines portable agent behavior. | `kind` _string_ | 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 | | | | `apiVersion` _string_ | 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 | | | | `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | -| `spec` _[AgentTemplateSpec](#agenttemplatespec)_ | | | **Required**
| +| `spec` _[AgentTemplateSpec](#agenttemplatespec)_ | | | AtMostOneOf: [outputSchema outputSchemaFrom]
**Required**
| #### AgentTemplatePromptSource @@ -110,24 +111,30 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | | `name` _string_ | | | MinLength: 1
**Required**
| -| `source` _[ArtifactSource](#artifactsource)_ | | | **Required**
| +| `source` _[ArtifactSource](#artifactsource)_ | | | ExactlyOneOf: [oci git bucket]
**Required**
| #### AgentTemplateSource AgentTemplateSource selects portable behavior inline or by local reference. +_Validation:_ +- ExactlyOneOf: [inline ref] + _Appears in:_ - [AgentSpec](#agentspec) | Field | Description | Default | Validation | | --- | --- | --- | --- | -| `inline` _[AgentTemplateSpec](#agenttemplatespec)_ | Inline defines the Agent's portable behavior directly. It cannot be set
together with Ref. | | | +| `inline` _[AgentTemplateSpec](#agenttemplatespec)_ | Inline defines the Agent's portable behavior directly. It cannot be set
together with Ref. | | AtMostOneOf: [outputSchema outputSchemaFrom]
| | `ref` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#localobjectreference-v1-core)_ | Ref names an AgentTemplate in the Agent's namespace. It cannot be set
together with Inline. | | | #### AgentTemplateSpec AgentTemplateSpec defines portable agent behavior. +_Validation:_ +- AtMostOneOf: [outputSchema outputSchemaFrom] + _Appears in:_ - [AgentTemplate](#agenttemplate) - [AgentTemplateSource](#agenttemplatesource) @@ -141,7 +148,7 @@ _Appears in:_ | `outputSchema` _[JSON](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#json-v1-apiextensions-k8s-io)_ | OutputSchema constrains successful terminal output when this template is
compiled as the root agent. | | Type: object
| | `outputSchemaFrom` _[ConfigMapKeyReference](#configmapkeyreference)_ | OutputSchemaFrom references a JSON Schema stored as JSON in a
same-namespace ConfigMap key. | | | | `promptTemplate` _[AgentTemplatePromptTemplateSpec](#agenttemplateprompttemplatespec)_ | | | | -| `tools` _[ToolBinding](#toolbinding) array_ | | | MaxItems: 50
| +| `tools` _[ToolBinding](#toolbinding) array_ | | | ExactlyOneOf: [mcp subAgent]
MaxItems: 50
| | `skills` _[AgentTemplateSkill](#agenttemplateskill) array_ | | | MaxItems: 50
| | `plugins` _[PluginBundle](#pluginbundle) array_ | | | MaxItems: 20
| @@ -197,6 +204,9 @@ _Appears in:_ ArtifactSource selects exactly one immutable artifact. +_Validation:_ +- ExactlyOneOf: [oci git bucket] + _Appears in:_ - [AgentTemplateSkill](#agenttemplateskill) - [PluginBundle](#pluginbundle) @@ -222,7 +232,7 @@ _Appears in:_ | `azureDeployment` _string_ | Deployment name for the Azure OpenAI API | | | | `azureAdToken` _string_ | Azure AD token for authentication | | | | `temperature` _string_ | Temperature for sampling | | | -| `maxTokens` _integer_ | Maximum tokens to generate | | | +| `maxTokens` _integer_ | Maximum tokens to generate | | Minimum: 1
| | `topP` _string_ | Top-p sampling parameter | | | | `apiFormat` _[OpenAIAPIFormat](#openaiapiformat)_ | APIFormat selects chatCompletions (default, the dated deployments path) or
responses (the /openai/v1 surface, which needs no apiVersion and reads files by link). | chatCompletions | Enum: [chatCompletions responses]
| @@ -258,7 +268,7 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | | `region` _string_ | AWS region where the Bedrock model is available (e.g., us-east-1, us-west-2) | | **Required**
| -| `additionalModelRequestFields` _[JSON](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#json-v1-apiextensions-k8s-io)_ | AdditionalModelRequestFields passes model-specific parameters to Bedrock's
additionalModelRequestFields in the Converse API. Use this for provider-specific
options that are not part of the standard InferenceConfiguration block, such as
Claude extended thinking or top_k. Values are forwarded as-is to the API.
Example: \{"top_k": 5, "thinking": \{"type": "enabled", "budget_tokens": 16000\}\} | | | +| `additionalModelRequestFields` _[JSON](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#json-v1-apiextensions-k8s-io)_ | AdditionalModelRequestFields passes model-specific parameters to Bedrock's
additionalModelRequestFields in the Converse API. Use this for provider-specific
options that are not part of the standard InferenceConfiguration block, such as
Claude extended thinking or top_k. Values are forwarded as-is to the API.
Example: \{"top_k": 5, "thinking": \{"type": "enabled", "budget_tokens": 16000\}\} | | Type: object
| | `promptCaching` _boolean_ | PromptCaching enables Bedrock prompt caching by appending a CachePoint
block at the end of the Converse request's `system` content array and
the end of the `toolConfig.tools` array. Bedrock will cache the prefix up to and
including those cache points across requests in the same region for
roughly 5 minutes after first use, billing the cached portion at a
reduced rate on cache hits.
Recommended for tool-using agents that make many Converse calls per
task with a stable system prompt and tool set — the per-call input
token count can drop by 70-90% on hit. Has no effect on models that
don't support caching; the marker is ignored by Bedrock for those.
See https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-caching.html
for the current list of supported models and minimum prefix sizes. | false | | | `cacheTTL` _string_ | CacheTTL controls how long Bedrock retains a cached prefix when
PromptCaching is enabled. Only meaningful when PromptCaching is true.
- "5m" (default): Bedrock's standard 5-minute sliding cache. Each cache
hit refreshes the window. Supported by all prompt-caching models.
- "1h": extended-TTL caching, useful for tasks whose Converse calls are
spaced more than 5 minutes apart.
NOTE: "1h" is NOT strictly better than "5m". Extended-TTL cache writes are
billed at a higher per-token rate than 5-minute writes, and 1h is supported
on a narrower set of models. Only choose "1h" when calls are spaced far
enough apart that a 5-minute cache would expire between them; otherwise the
higher write cost is wasted. See the AWS prompt-caching docs above. | 5m | Enum: [5m 1h]
| | `guardrail` _[BedrockGuardrailConfig](#bedrockguardrailconfig)_ | | | | @@ -421,7 +431,7 @@ Harness defines a reusable agent runtime and infrastructure policy. | `kind` _string_ | 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 | | | | `apiVersion` _string_ | 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 | | | | `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | -| `spec` _[HarnessSpec](#harnessspec)_ | | | **Required**
| +| `spec` _[HarnessSpec](#harnessspec)_ | | | ExactlyOneOf: [kagent codex claude byo]
**Required**
| | `status` _[HarnessStatus](#harnessstatus)_ | | | | #### HarnessCapabilities @@ -453,6 +463,9 @@ _Appears in:_ HarnessSpec defines a reusable runtime and its infrastructure policy. +_Validation:_ +- ExactlyOneOf: [kagent codex claude byo] + _Appears in:_ - [Harness](#harness) @@ -462,7 +475,7 @@ _Appears in:_ | `codex` _[CodexHarness](#codexharness)_ | | | | | `claude` _[ClaudeHarness](#claudeharness)_ | | | | | `byo` _[BYOHarness](#byoharness)_ | | | | -| `workload` _[HarnessWorkload](#harnessworkload)_ | | | **Required**
| +| `workload` _[HarnessWorkload](#harnessworkload)_ | Workload overrides the built-in runtime image and its command. BYO requires it. | | | | `env` _[RuntimeEnvVar](#runtimeenvvar) array_ | | | MaxItems: 100
| | `substrate` _[RuntimeSubstratePolicy](#runtimesubstratepolicy)_ | | | **Required**
| @@ -488,7 +501,7 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | -| `image` _string_ | Image is an OCI image reference pinned by sha256 digest. | | Pattern: `^[^[:space:]@]+@sha256:[a-f0-9]\{64\}$`
**Required**
| +| `image` _string_ | Image overrides the release's built-in runtime image. BYO requires an image.
When set, it must be an OCI image reference pinned by sha256 digest. | | Pattern: `^[^[:space:]@]+@sha256:[a-f0-9]\{64\}$`
| | `command` _string array_ | Command overrides the image entrypoint when set. | | MaxItems: 32
| | `args` _string array_ | Args overrides the image command arguments when set. | | MaxItems: 64
| @@ -502,7 +515,7 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | | `memory` _[KagentHarnessMemory](#kagentharnessmemory)_ | Memory enables long-term memory for agents using this Harness. | | | -| `compaction` _[KagentHarnessCompaction](#kagentharnesscompaction)_ | Compaction summarizes older session events so the prompt stays small as
a conversation grows. Omitted leaves the history uncompacted. | | | +| `compaction` _[KagentHarnessCompaction](#kagentharnesscompaction)_ | Compaction summarizes older session events so the prompt stays small as
a conversation grows. Omitted leaves the history uncompacted. | | AtLeastOneOf: [compactionInterval tokenThreshold]
| #### KagentHarnessCompaction @@ -513,6 +526,9 @@ summarizes each group of completed invocations; tail retention everything but the most recent events once the prompt grows past a token count. At least one strategy must be configured. +_Validation:_ +- AtLeastOneOf: [compactionInterval tokenThreshold] + _Appears in:_ - [KagentHarness](#kagentharness) @@ -618,7 +634,7 @@ _Appears in:_ | `apiKeyPassthrough` _boolean_ | APIKeyPassthrough enables forwarding the Bearer token from incoming A2A requests
directly to the LLM provider as the API key. This is useful for organizations
with federated identity that want to avoid separate secret management.
Mutually exclusive with apiKeySecret. | | | | `defaultHeaders` _object (keys:string, values:string)_ | | | | | `provider` _[ModelProvider](#modelprovider)_ | The provider of the model | OpenAI | Enum: [Anthropic OpenAI AzureOpenAI Ollama Gemini GeminiVertexAI AnthropicVertexAI Bedrock SAPAICore Foundry Mistral]
| -| `openAI` _[OpenAIConfig](#openaiconfig)_ | OpenAI-specific configuration | | | +| `openAI` _[OpenAIConfig](#openaiconfig)_ | OpenAI-specific configuration | | AtMostOneOf: [maxTokens maxCompletionTokens]
| | `anthropic` _[AnthropicConfig](#anthropicconfig)_ | Anthropic-specific configuration | | | | `azureOpenAI` _[AzureOpenAIConfig](#azureopenaiconfig)_ | Azure OpenAI-specific configuration | | | | `ollama` _[OllamaConfig](#ollamaconfig)_ | Ollama-specific configuration | | | @@ -749,6 +765,9 @@ _Appears in:_ OpenAIConfig contains OpenAI-specific configuration options +_Validation:_ +- AtMostOneOf: [maxTokens maxCompletionTokens] + _Appears in:_ - [ModelConfigSpec](#modelconfigspec) @@ -763,8 +782,8 @@ _Appears in:_ | `frequencyPenalty` _string_ | Frequency penalty | | | | `presencePenalty` _string_ | Presence penalty | | | | `seed` _integer_ | Seed value | | | -| `n` _integer_ | N value | | | -| `timeout` _integer_ | Timeout | | | +| `n` _integer_ | N value | | Minimum: 1
| +| `timeout` _integer_ | Timeout | | Maximum: 9.223372036e+09
Minimum: 1
| | `reasoningEffort` _[OpenAIReasoningEffort](#openaireasoningeffort)_ | Reasoning effort | | Enum: [none minimal low medium high xhigh]
| | `apiFormat` _[OpenAIAPIFormat](#openaiapiformat)_ | APIFormat selects which OpenAI HTTP API the runtime uses for this model.
chatCompletions (default) posts to /v1/chat/completions.
responses posts to /v1/responses. Use responses for OpenAI-compatible
gateways or models that require the Responses API. | chatCompletions | Enum: [chatCompletions responses]
| @@ -791,7 +810,7 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | -| `source` _[ArtifactSource](#artifactsource)_ | | | **Required**
| +| `source` _[ArtifactSource](#artifactsource)_ | | | ExactlyOneOf: [oci git bucket]
**Required**
| | `skills` _string array_ | An empty selection enables nothing. | | MaxItems: 50
items:MinLength: 1
| #### RemoteMCPServer @@ -835,7 +854,7 @@ _Appears in:_ | `description` _string_ | | | **Required**
| | `protocol` _[RemoteMCPServerProtocol](#remotemcpserverprotocol)_ | | STREAMABLE_HTTP | Enum: [SSE STREAMABLE_HTTP]
| | `url` _string_ | | | MinLength: 1
**Required**
| -| `headersFrom` _[ValueRef](#valueref) array_ | | | | +| `headersFrom` _[ValueRef](#valueref) array_ | | | ExactlyOneOf: [value valueFrom]
| | `timeout` _[Duration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#duration-v1-meta)_ | | 30s | | | `sseReadTimeout` _[Duration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#duration-v1-meta)_ | | | | | `terminateOnClose` _boolean_ | | true | | @@ -1008,6 +1027,9 @@ _Appears in:_ ToolBinding selects exactly one MCP or subagent tool source. +_Validation:_ +- ExactlyOneOf: [mcp subAgent] + _Appears in:_ - [AgentTemplateSpec](#agenttemplatespec) @@ -1020,6 +1042,9 @@ _Appears in:_ ValueRef represents a configuration value +_Validation:_ +- ExactlyOneOf: [value valueFrom] + _Appears in:_ - [RemoteMCPServerSpec](#remotemcpserverspec) diff --git a/docs-site/content/kagent/1.x/reference/cli/_index.md b/docs-site/content/kagent/1.x/reference/cli/_index.md index 2c1c99a2..730a3be0 100644 --- a/docs-site/content/kagent/1.x/reference/cli/_index.md +++ b/docs-site/content/kagent/1.x/reference/cli/_index.md @@ -14,7 +14,6 @@ Review the kagent CLI commands and learn how to use them effectively. - [`kagent dashboard`]({{< link path="reference/cli/kagent-dashboard" >}}) - Open the kagent dashboard - [`kagent db`]({{< link path="reference/cli/kagent-db" >}}) - Database operations (migrations, inspection) - [`kagent install`]({{< link path="reference/cli/kagent-install" >}}) - Install kagent -- [`kagent mcp`]({{< link path="reference/cli/kagent-mcp" >}}) - MCP (Model Context Protocol) server management - [`kagent sandbox`]({{< link path="reference/cli/kagent-sandbox" >}}) - Run commands and transfer files in standalone sandboxes - [`kagent uninstall`]({{< link path="reference/cli/kagent-uninstall" >}}) - Uninstall kagent - [`kagent version`]({{< link path="reference/cli/kagent-version" >}}) - Print the kagent version diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-agent-invoke.md b/docs-site/content/kagent/1.x/reference/cli/kagent-agent-invoke.md index 3ad1498c..6507db6c 100644 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-agent-invoke.md +++ b/docs-site/content/kagent/1.x/reference/cli/kagent-agent-invoke.md @@ -18,7 +18,6 @@ kagent agent invoke [flags] - `--session string` - Session ID - `-S, --stream` - Stream the response - `-t, --task string` - Task text -- `--token string` - Model API key passed through as an A2A Bearer token **Global Flags:** - `--api-url string` - KAgent control-plane API URL (default "http://localhost:8083") diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-db-migrate-down.md b/docs-site/content/kagent/1.x/reference/cli/kagent-db-migrate-down.md index 8d3332d5..6e8413f7 100644 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-db-migrate-down.md +++ b/docs-site/content/kagent/1.x/reference/cli/kagent-db-migrate-down.md @@ -16,9 +16,9 @@ kagent db migrate down N [flags] **Global Flags:** - `--ca-file string` - CA certificate file for KAgent endpoints - `--config string` - Configuration file (default: user config directory/kagent/config.yaml) -- `--db-role string` - Stable PostgreSQL role to assume after authentication -- `--db-url string` - PostgreSQL connection URL -- `--db-url-file string` - File containing the PostgreSQL connection URL +- `--db-role string` - Owner role to assume after authentication (required) +- `--db-url string` - PostgreSQL connection URL for the owner login +- `--db-url-file string` - File containing the owner login's PostgreSQL connection URL - `--log-level string` - Log level: debug, info, warn, error (default "info") - `--server-name string` - TLS server name for KAgent endpoints - `--source string` - Migration source for down, goto, or version diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-db-migrate-goto.md b/docs-site/content/kagent/1.x/reference/cli/kagent-db-migrate-goto.md index 329252e5..00515ed7 100644 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-db-migrate-goto.md +++ b/docs-site/content/kagent/1.x/reference/cli/kagent-db-migrate-goto.md @@ -16,9 +16,9 @@ kagent db migrate goto V [flags] **Global Flags:** - `--ca-file string` - CA certificate file for KAgent endpoints - `--config string` - Configuration file (default: user config directory/kagent/config.yaml) -- `--db-role string` - Stable PostgreSQL role to assume after authentication -- `--db-url string` - PostgreSQL connection URL -- `--db-url-file string` - File containing the PostgreSQL connection URL +- `--db-role string` - Owner role to assume after authentication (required) +- `--db-url string` - PostgreSQL connection URL for the owner login +- `--db-url-file string` - File containing the owner login's PostgreSQL connection URL - `--log-level string` - Log level: debug, info, warn, error (default "info") - `--server-name string` - TLS server name for KAgent endpoints - `--source string` - Migration source for down, goto, or version diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-db-migrate-status.md b/docs-site/content/kagent/1.x/reference/cli/kagent-db-migrate-status.md index 236be502..3bc6977a 100644 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-db-migrate-status.md +++ b/docs-site/content/kagent/1.x/reference/cli/kagent-db-migrate-status.md @@ -17,9 +17,9 @@ kagent db migrate status [flags] **Global Flags:** - `--ca-file string` - CA certificate file for KAgent endpoints - `--config string` - Configuration file (default: user config directory/kagent/config.yaml) -- `--db-role string` - Stable PostgreSQL role to assume after authentication -- `--db-url string` - PostgreSQL connection URL -- `--db-url-file string` - File containing the PostgreSQL connection URL +- `--db-role string` - Owner role to assume after authentication (required) +- `--db-url string` - PostgreSQL connection URL for the owner login +- `--db-url-file string` - File containing the owner login's PostgreSQL connection URL - `--log-level string` - Log level: debug, info, warn, error (default "info") - `--server-name string` - TLS server name for KAgent endpoints - `--source string` - Migration source for down, goto, or version diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-db-migrate-up.md b/docs-site/content/kagent/1.x/reference/cli/kagent-db-migrate-up.md index 390d5e11..208dea69 100644 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-db-migrate-up.md +++ b/docs-site/content/kagent/1.x/reference/cli/kagent-db-migrate-up.md @@ -16,9 +16,9 @@ kagent db migrate up [flags] **Global Flags:** - `--ca-file string` - CA certificate file for KAgent endpoints - `--config string` - Configuration file (default: user config directory/kagent/config.yaml) -- `--db-role string` - Stable PostgreSQL role to assume after authentication -- `--db-url string` - PostgreSQL connection URL -- `--db-url-file string` - File containing the PostgreSQL connection URL +- `--db-role string` - Owner role to assume after authentication (required) +- `--db-url string` - PostgreSQL connection URL for the owner login +- `--db-url-file string` - File containing the owner login's PostgreSQL connection URL - `--log-level string` - Log level: debug, info, warn, error (default "info") - `--server-name string` - TLS server name for KAgent endpoints - `--source string` - Migration source for down, goto, or version diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-db-migrate-version.md b/docs-site/content/kagent/1.x/reference/cli/kagent-db-migrate-version.md index dd302939..feb4fb8a 100644 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-db-migrate-version.md +++ b/docs-site/content/kagent/1.x/reference/cli/kagent-db-migrate-version.md @@ -16,9 +16,9 @@ kagent db migrate version [flags] **Global Flags:** - `--ca-file string` - CA certificate file for KAgent endpoints - `--config string` - Configuration file (default: user config directory/kagent/config.yaml) -- `--db-role string` - Stable PostgreSQL role to assume after authentication -- `--db-url string` - PostgreSQL connection URL -- `--db-url-file string` - File containing the PostgreSQL connection URL +- `--db-role string` - Owner role to assume after authentication (required) +- `--db-url string` - PostgreSQL connection URL for the owner login +- `--db-url-file string` - File containing the owner login's PostgreSQL connection URL - `--log-level string` - Log level: debug, info, warn, error (default "info") - `--server-name string` - TLS server name for KAgent endpoints - `--source string` - Migration source for down, goto, or version diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-db-migrate.md b/docs-site/content/kagent/1.x/reference/cli/kagent-db-migrate.md index 45e095b4..539563fb 100644 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-db-migrate.md +++ b/docs-site/content/kagent/1.x/reference/cli/kagent-db-migrate.md @@ -5,7 +5,8 @@ weight: 310 --- Apply, roll back, and inspect database migrations. -Connection settings come from the CLI configuration or explicit database flags. +Migrations run as the owner login. Connection settings come from database.owner in +the CLI configuration or explicit database flags. ```bash kagent db migrate [command] @@ -19,9 +20,9 @@ kagent db migrate [command] - [`kagent db migrate version`]({{< link path="reference/cli/kagent-db-migrate-version" >}}) - Show the applied migration version **Flags:** -- `--db-role string` - Stable PostgreSQL role to assume after authentication -- `--db-url string` - PostgreSQL connection URL -- `--db-url-file string` - File containing the PostgreSQL connection URL +- `--db-role string` - Owner role to assume after authentication (required) +- `--db-url string` - PostgreSQL connection URL for the owner login +- `--db-url-file string` - File containing the owner login's PostgreSQL connection URL - `-h, --help` - help for migrate - `--source string` - Migration source for down, goto, or version diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-add-tool.md b/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-add-tool.md deleted file mode 100644 index e698db15..00000000 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-add-tool.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: kagent mcp add-tool -description: Add a new MCP tool to your project. -weight: 390 ---- - -Generate a new MCP tool that will be automatically loaded by the server. - -This command creates a new tool file in src/tools/ with a generic template. -The tool will be automatically discovered and loaded when the server starts. - -Each tool is a Python file containing a function decorated with @mcp.tool(). -The function should use the @mcp.tool() decorator from FastMCP. - -```bash -kagent mcp add-tool [tool-name] [flags] -``` - -**Flags:** -- `-d, --description string` - Tool description -- `-f, --force` - Overwrite existing tool file -- `-h, --help` - help for add-tool -- `-i, --interactive` - Interactive tool creation -- `--project-dir string` - Project directory (default: current directory) - -**Global Flags:** -- `--api-url string` - KAgent control-plane API URL (default "http://localhost:8083") -- `--ca-file string` - CA certificate file for KAgent endpoints -- `--config string` - Configuration file (default: user config directory/kagent/config.yaml) -- `--gateway-url string` - KAgent A2A and MCP gateway URL (default "http://localhost:8083") -- `--log-level string` - Log level: debug, info, warn, error (default "info") -- `-n, --namespace string` - Namespace (default "kagent") -- `-o, --output-format string` - Output format (default "table") -- `--server-name string` - TLS server name for KAgent endpoints -- `--timeout duration` - Timeout (default 5m0s) -- `--user-id string` - Caller identity used to select the server-side data partition (default "admin@kagent.dev") -- `-v, --verbose` - Verbose output - -## Example - -```bash -kagent mcp add-tool weather -kagent mcp add-tool database --description "Database operations tool" -kagent mcp add-tool weather --force # Overwrite existing tool -``` diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-build.md b/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-build.md deleted file mode 100644 index 174e65c7..00000000 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-build.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: kagent mcp build -description: Build MCP server as a Docker image. -weight: 400 ---- - -Build an MCP server from the current project. - -This command will detect the project type and build the appropriate -MCP server Docker image. - -```bash -kagent mcp build [flags] -``` - -**Flags:** -- `-h, --help` - help for build -- `--kind-load` - Load image into kind cluster (requires kind) -- `--kind-load-cluster string` - Name of the kind cluster to load image into (default: current cluster) -- `--platform string` - Target platform (e.g., linux/amd64,linux/arm64) -- `-d, --project-dir string` - Build directory (default: current directory) -- `--push` - Push Docker image to registry -- `-t, --tag string` - Docker image tag (alias for --output) - -**Global Flags:** -- `--api-url string` - KAgent control-plane API URL (default "http://localhost:8083") -- `--ca-file string` - CA certificate file for KAgent endpoints -- `--config string` - Configuration file (default: user config directory/kagent/config.yaml) -- `--gateway-url string` - KAgent A2A and MCP gateway URL (default "http://localhost:8083") -- `--log-level string` - Log level: debug, info, warn, error (default "info") -- `-n, --namespace string` - Namespace (default "kagent") -- `-o, --output-format string` - Output format (default "table") -- `--server-name string` - TLS server name for KAgent endpoints -- `--timeout duration` - Timeout (default 5m0s) -- `--user-id string` - Caller identity used to select the server-side data partition (default "admin@kagent.dev") -- `-v, --verbose` - Verbose output - -## Example - -```bash -kagent mcp build # Build Docker image from current directory -kagent mcp build --project-dir ./my-project # Build Docker image from specific directory -``` diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-deploy-package.md b/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-deploy-package.md deleted file mode 100644 index bd12f3b9..00000000 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-deploy-package.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: kagent mcp deploy package -description: Deploy an MCP server using a package manager (npx, uvx). -weight: 420 ---- - -Deploy an MCP server using a package manager to run Model Context Protocol servers. - -This subcommand creates an MCPServer Custom Resource Definition (CRD) that runs -an MCP server using npx (for npm packages) or uvx (for Python packages). - -The deployment name, manager, and args are required. The package manager must be either 'npx' or 'uvx'. - -```bash -kagent mcp deploy package [flags] -``` - -**Flags:** -- `--args strings` - Arguments to pass to the package manager (e.g., package names) (required) -- `--deployment-name string` - Name for the deployment (required) -- `--dry-run` - Generate manifest without applying to cluster -- `--env strings` - Environment variables (KEY=VALUE) -- `-h, --help` - help for package -- `--image string` - Docker image to deploy (overrides default) -- `--manager string` - Package manager to use (npx or uvx) (required) -- `-n, --namespace string` - Kubernetes namespace -- `--no-inspector` - Do not start the MCP inspector after deployment (default true) -- `--output string` - Output file for the generated YAML -- `--port int` - Container port (default: 3000) -- `--secrets strings` - List of Kubernetes secret names to mount -- `--transport string` - Transport type (stdio, http) - -**Global Flags:** -- `--api-url string` - KAgent control-plane API URL (default "http://localhost:8083") -- `--ca-file string` - CA certificate file for KAgent endpoints -- `--config string` - Configuration file (default: user config directory/kagent/config.yaml) -- `--gateway-url string` - KAgent A2A and MCP gateway URL (default "http://localhost:8083") -- `--log-level string` - Log level: debug, info, warn, error (default "info") -- `-o, --output-format string` - Output format (default "table") -- `--server-name string` - TLS server name for KAgent endpoints -- `--timeout duration` - Timeout (default 5m0s) -- `--user-id string` - Caller identity used to select the server-side data partition (default "admin@kagent.dev") -- `-v, --verbose` - Verbose output - -## Example - -```bash -kagent mcp deploy package --deployment-name github-server --manager npx --args @modelcontextprotocol/server-github # Deploy GitHub MCP server -kagent mcp deploy package --deployment-name github-server --manager npx --args @modelcontextprotocol/server-github --dry-run # Print YAML without deploying -kagent mcp deploy package --deployment-name my-server --manager npx --args my-package --env "KEY1=value1,KEY2=value2" # Set environment variables -kagent mcp deploy package --deployment-name github-server --manager npx --args @modelcontextprotocol/server-github --secrets secret1,secret2 # Mount Kubernetes secrets -kagent mcp deploy package --deployment-name my-server --manager npx --args my-package --no-inspector # Deploy without starting inspector -kagent mcp deploy package --deployment-name my-server --manager uvx --args mcp-server-git # Use UV and write managed tools and installables to /tmp directories -``` diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-deploy.md b/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-deploy.md deleted file mode 100644 index 1c4a1ce0..00000000 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-deploy.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: kagent mcp deploy -description: Deploy MCP server to Kubernetes. -weight: 410 ---- - -Deploy an MCP server to Kubernetes by generating MCPServer CRDs. - -This command generates MCPServer Custom Resource Definitions (CRDs) based on: -- Project configuration from manifest.yaml -- Docker image built with 'kagent mcp build --docker' -- Deployment configuration options - -The generated MCPServer will include: -- Docker image reference from the build -- Transport configuration (stdio/http) -- Port and command configuration -- Environment variables and secrets - -The command can also apply Kubernetes secret YAML files to the cluster before deploying the MCPServer. -The secrets will be referenced in the MCPServer CRD for mounting as volumes to the MCP server container. -Secret namespace will be overridden with the deployment namespace to avoid the need for reference grants -to enable cross-namespace references. - -```bash -kagent mcp deploy [flags] -kagent mcp deploy [command] -``` - -**Subcommands:** -- [`kagent mcp deploy package`]({{< link path="reference/cli/kagent-mcp-deploy-package" >}}) - Deploy an MCP server using a package manager (npx, uvx) - -**Flags:** -- `--args strings` - Command arguments -- `--command string` - Command to run (overrides project config) -- `--dry-run` - Generate manifest without applying to cluster -- `--env strings` - Environment variables (KEY=VALUE) -- `--environment string` - Target environment for deployment (e.g., staging, production) (default "staging") -- `-f, --file string` - Path to manifest.yaml file (default: current directory) -- `--force` - Force deployment even if validation fails -- `-h, --help` - help for deploy -- `--image string` - Docker image to deploy (overrides build image) -- `-n, --namespace string` - Kubernetes namespace (default "default") -- `--no-inspector` - Do not start the MCP inspector after deployment (default true) -- `--output string` - Output file for the generated YAML -- `--port int` - Container port (default: from project config) -- `--transport string` - Transport type (stdio, http) - -**Global Flags:** -- `--api-url string` - KAgent control-plane API URL (default "http://localhost:8083") -- `--ca-file string` - CA certificate file for KAgent endpoints -- `--config string` - Configuration file (default: user config directory/kagent/config.yaml) -- `--gateway-url string` - KAgent A2A and MCP gateway URL (default "http://localhost:8083") -- `--log-level string` - Log level: debug, info, warn, error (default "info") -- `-o, --output-format string` - Output format (default "table") -- `--server-name string` - TLS server name for KAgent endpoints -- `--timeout duration` - Timeout (default 5m0s) -- `--user-id string` - Caller identity used to select the server-side data partition (default "admin@kagent.dev") -- `-v, --verbose` - Verbose output - -## Example - -```bash -kagent mcp deploy # Deploy with project name to cluster -kagent mcp deploy my-server # Deploy with custom name -kagent mcp deploy --namespace staging # Deploy to staging namespace -kagent mcp deploy --dry-run # Generate manifest without applying to cluster -kagent mcp deploy --image custom:tag # Use custom image -kagent mcp deploy --transport http # Use HTTP transport -kagent mcp deploy --output deploy.yaml # Save to file -kagent mcp deploy --file /path/to/manifest.yaml # Use custom manifest.yaml file -kagent mcp deploy --environment staging # Target environment for deployment (e.g., staging, production) -``` diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-init-go.md b/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-init-go.md deleted file mode 100644 index b14b07b4..00000000 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-init-go.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: kagent mcp init go -description: Initialize a new Go MCP server project. -weight: 440 ---- - -Initialize a new MCP server project using the mcp-go framework. - -This command will create a new directory with a basic mcp-go project structure, -including a go.mod file, a main.go file, and an example tool. - -You must provide a valid Go module name for the project. - -```bash -kagent mcp init go [project-name] [flags] -``` - -**Flags:** -- `--go-module-name string` - The Go module name for the project (e.g., github.com/my-org/my-project) -- `-h, --help` - help for go - -**Global Flags:** -- `--api-url string` - KAgent control-plane API URL (default "http://localhost:8083") -- `--author string` - Author name for the project -- `--ca-file string` - CA certificate file for KAgent endpoints -- `--config string` - Configuration file (default: user config directory/kagent/config.yaml) -- `--description string` - Description for the project -- `--email string` - Author email for the project -- `--force` - Overwrite existing directory -- `--gateway-url string` - KAgent A2A and MCP gateway URL (default "http://localhost:8083") -- `--log-level string` - Log level: debug, info, warn, error (default "info") -- `--namespace string` - Default namespace for project resources (default "default") -- `--no-git` - Skip git initialization -- `--non-interactive` - Run in non-interactive mode -- `-o, --output-format string` - Output format (default "table") -- `--server-name string` - TLS server name for KAgent endpoints -- `--timeout duration` - Timeout (default 5m0s) -- `--user-id string` - Caller identity used to select the server-side data partition (default "admin@kagent.dev") -- `-v, --verbose` - Verbose output diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-init-java.md b/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-init-java.md deleted file mode 100644 index a1ffb3d8..00000000 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-init-java.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: kagent mcp init java -description: Initialize a new Java MCP server project. -weight: 450 ---- - -Initialize a new MCP server project using the Java MCP framework. - -This command will create a new directory with a basic Java MCP project structure, -including a pom.xml file, a Main.java file, and an example tool. - -```bash -kagent mcp init java [project-name] [flags] -``` - -**Flags:** -- `-h, --help` - help for java - -**Global Flags:** -- `--api-url string` - KAgent control-plane API URL (default "http://localhost:8083") -- `--author string` - Author name for the project -- `--ca-file string` - CA certificate file for KAgent endpoints -- `--config string` - Configuration file (default: user config directory/kagent/config.yaml) -- `--description string` - Description for the project -- `--email string` - Author email for the project -- `--force` - Overwrite existing directory -- `--gateway-url string` - KAgent A2A and MCP gateway URL (default "http://localhost:8083") -- `--log-level string` - Log level: debug, info, warn, error (default "info") -- `--namespace string` - Default namespace for project resources (default "default") -- `--no-git` - Skip git initialization -- `--non-interactive` - Run in non-interactive mode -- `-o, --output-format string` - Output format (default "table") -- `--server-name string` - TLS server name for KAgent endpoints -- `--timeout duration` - Timeout (default 5m0s) -- `--user-id string` - Caller identity used to select the server-side data partition (default "admin@kagent.dev") -- `-v, --verbose` - Verbose output diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-init-python.md b/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-init-python.md deleted file mode 100644 index 47ed8581..00000000 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-init-python.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: kagent mcp init python -description: Initialize a new Python MCP server project. -weight: 460 ---- - -Initialize a new MCP server project using the fastmcp-python framework. - -This command will create a new directory with a basic fastmcp-python project structure, -including a pyproject.toml file, a main.py file, and an example tool. - -```bash -kagent mcp init python [project-name] [flags] -``` - -**Flags:** -- `-h, --help` - help for python - -**Global Flags:** -- `--api-url string` - KAgent control-plane API URL (default "http://localhost:8083") -- `--author string` - Author name for the project -- `--ca-file string` - CA certificate file for KAgent endpoints -- `--config string` - Configuration file (default: user config directory/kagent/config.yaml) -- `--description string` - Description for the project -- `--email string` - Author email for the project -- `--force` - Overwrite existing directory -- `--gateway-url string` - KAgent A2A and MCP gateway URL (default "http://localhost:8083") -- `--log-level string` - Log level: debug, info, warn, error (default "info") -- `--namespace string` - Default namespace for project resources (default "default") -- `--no-git` - Skip git initialization -- `--non-interactive` - Run in non-interactive mode -- `-o, --output-format string` - Output format (default "table") -- `--server-name string` - TLS server name for KAgent endpoints -- `--timeout duration` - Timeout (default 5m0s) -- `--user-id string` - Caller identity used to select the server-side data partition (default "admin@kagent.dev") -- `-v, --verbose` - Verbose output diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-init-typescript.md b/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-init-typescript.md deleted file mode 100644 index cfe2ff36..00000000 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-init-typescript.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: kagent mcp init typescript -description: Initialize a new TypeScript MCP server project. -weight: 470 ---- - -Initialize a new MCP server project using the TypeScript MCP framework. - -This command will create a new directory with a basic TypeScript MCP project structure, -including a package.json file, a tsconfig.json file, and an example tool. - -```bash -kagent mcp init typescript [project-name] [flags] -``` - -**Flags:** -- `-h, --help` - help for typescript - -**Global Flags:** -- `--api-url string` - KAgent control-plane API URL (default "http://localhost:8083") -- `--author string` - Author name for the project -- `--ca-file string` - CA certificate file for KAgent endpoints -- `--config string` - Configuration file (default: user config directory/kagent/config.yaml) -- `--description string` - Description for the project -- `--email string` - Author email for the project -- `--force` - Overwrite existing directory -- `--gateway-url string` - KAgent A2A and MCP gateway URL (default "http://localhost:8083") -- `--log-level string` - Log level: debug, info, warn, error (default "info") -- `--namespace string` - Default namespace for project resources (default "default") -- `--no-git` - Skip git initialization -- `--non-interactive` - Run in non-interactive mode -- `-o, --output-format string` - Output format (default "table") -- `--server-name string` - TLS server name for KAgent endpoints -- `--timeout duration` - Timeout (default 5m0s) -- `--user-id string` - Caller identity used to select the server-side data partition (default "admin@kagent.dev") -- `-v, --verbose` - Verbose output diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-init.md b/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-init.md deleted file mode 100644 index 5b9e89d3..00000000 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-init.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: kagent mcp init -description: Initialize a new MCP server project. -weight: 430 ---- - -Initialize a new MCP server project with dynamic tool loading. - -This command provides subcommands to initialize a new MCP server project -using one of the supported frameworks. - -```bash -kagent mcp init [project-name] [flags] -kagent mcp init [command] -``` - -**Subcommands:** -- [`kagent mcp init go`]({{< link path="reference/cli/kagent-mcp-init-go" >}}) - Initialize a new Go MCP server project -- [`kagent mcp init java`]({{< link path="reference/cli/kagent-mcp-init-java" >}}) - Initialize a new Java MCP server project -- [`kagent mcp init python`]({{< link path="reference/cli/kagent-mcp-init-python" >}}) - Initialize a new Python MCP server project -- [`kagent mcp init typescript`]({{< link path="reference/cli/kagent-mcp-init-typescript" >}}) - Initialize a new TypeScript MCP server project - -**Flags:** -- `--author string` - Author name for the project -- `--description string` - Description for the project -- `--email string` - Author email for the project -- `--force` - Overwrite existing directory -- `-h, --help` - help for init -- `--namespace string` - Default namespace for project resources (default "default") -- `--no-git` - Skip git initialization -- `--non-interactive` - Run in non-interactive mode - -**Global Flags:** -- `--api-url string` - KAgent control-plane API URL (default "http://localhost:8083") -- `--ca-file string` - CA certificate file for KAgent endpoints -- `--config string` - Configuration file (default: user config directory/kagent/config.yaml) -- `--gateway-url string` - KAgent A2A and MCP gateway URL (default "http://localhost:8083") -- `--log-level string` - Log level: debug, info, warn, error (default "info") -- `-o, --output-format string` - Output format (default "table") -- `--server-name string` - TLS server name for KAgent endpoints -- `--timeout duration` - Timeout (default 5m0s) -- `--user-id string` - Caller identity used to select the server-side data partition (default "admin@kagent.dev") -- `-v, --verbose` - Verbose output diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-run.md b/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-run.md deleted file mode 100644 index c71419d9..00000000 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-run.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: kagent mcp run -description: Run MCP server locally. -weight: 480 ---- - -Run an MCP server locally using the Model Context Protocol inspector. - -By default, this command will: -1. Load the manifest.yaml configuration from the project directory -2. Determine the framework type and create the appropriate mcp inspector configuration -3. Launch the MCP inspector and select STDIO as the transport type, the server will start when you click "Connect" - -If you want to run the server directly without the inspector, use the --no-inspector flag. -This will execute the server directly using the appropriate framework command. - -Supported frameworks: -- fastmcp-python: Requires uv to be installed -- mcp-go: Requires Go to be installed - -```bash -kagent mcp run [flags] -``` - -**Flags:** -- `-h, --help` - help for run -- `--no-inspector` - Run the server directly without launching the MCP inspector -- `-d, --project-dir string` - Project directory to use (default: current directory) -- `--transport string` - Transport mode (stdio or http) (default "stdio") - -**Global Flags:** -- `--api-url string` - KAgent control-plane API URL (default "http://localhost:8083") -- `--ca-file string` - CA certificate file for KAgent endpoints -- `--config string` - Configuration file (default: user config directory/kagent/config.yaml) -- `--gateway-url string` - KAgent A2A and MCP gateway URL (default "http://localhost:8083") -- `--log-level string` - Log level: debug, info, warn, error (default "info") -- `-n, --namespace string` - Namespace (default "kagent") -- `-o, --output-format string` - Output format (default "table") -- `--server-name string` - TLS server name for KAgent endpoints -- `--timeout duration` - Timeout (default 5m0s) -- `--user-id string` - Caller identity used to select the server-side data partition (default "admin@kagent.dev") -- `-v, --verbose` - Verbose output - -## Example - -```bash -kagent run mcp --project-dir ./my-project # Run with inspector (default) -kagent run mcp --no-inspector # Run server directly without inspector -kagent run mcp --transport http # Run with HTTP transport -``` diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-secrets-sync.md b/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-secrets-sync.md deleted file mode 100644 index ede010b4..00000000 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-secrets-sync.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: kagent mcp secrets sync -description: Sync secrets to a Kubernetes environment from a local .env file. -weight: 500 ---- - -Sync secrets from a local .env file to a Kubernetes secret. - -This command reads a .env file and the project's manifest.yaml file to determine -the correct secret name and namespace for the specified environment. It then -creates or updates the Kubernetes secret directly in the cluster. - -The command will look for a ".env" file in the project root by default. - -```bash -kagent mcp secrets sync [environment] [flags] -``` - -**Flags:** -- `--dry-run` - Output the generated secret YAML instead of applying it -- `--from-file string` - Source .env file to sync from (default ".env") -- `-h, --help` - help for sync -- `-d, --project-dir string` - Project directory (default: current directory) - -**Global Flags:** -- `--api-url string` - KAgent control-plane API URL (default "http://localhost:8083") -- `--ca-file string` - CA certificate file for KAgent endpoints -- `--config string` - Configuration file (default: user config directory/kagent/config.yaml) -- `--gateway-url string` - KAgent A2A and MCP gateway URL (default "http://localhost:8083") -- `--log-level string` - Log level: debug, info, warn, error (default "info") -- `-n, --namespace string` - Namespace (default "kagent") -- `-o, --output-format string` - Output format (default "table") -- `--server-name string` - TLS server name for KAgent endpoints -- `--timeout duration` - Timeout (default 5m0s) -- `--user-id string` - Caller identity used to select the server-side data partition (default "admin@kagent.dev") -- `-v, --verbose` - Verbose output - -## Example - -```bash -# Sync secrets to the "staging" environment defined in manifest.yaml -kagent mcp secrets sync staging - -# Sync secrets from a custom .env file -kagent mcp secrets sync staging --from-file .env.staging - -# Sync secrets from a specific project directory -kagent mcp secrets sync staging --project-dir ./my-project - -# Perform a dry run to see the generated secret without applying it -kagent mcp secrets sync production --dry-run -``` diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-secrets.md b/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-secrets.md deleted file mode 100644 index a5f7b3c1..00000000 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-mcp-secrets.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: kagent mcp secrets -description: Manage project secrets. -weight: 490 ---- - -Manage secrets for MCP server projects. - -```bash -kagent mcp secrets [command] -``` - -**Subcommands:** -- [`kagent mcp secrets sync`]({{< link path="reference/cli/kagent-mcp-secrets-sync" >}}) - Sync secrets to a Kubernetes environment from a local .env file - -**Flags:** -- `-h, --help` - help for secrets - -**Global Flags:** -- `--api-url string` - KAgent control-plane API URL (default "http://localhost:8083") -- `--ca-file string` - CA certificate file for KAgent endpoints -- `--config string` - Configuration file (default: user config directory/kagent/config.yaml) -- `--gateway-url string` - KAgent A2A and MCP gateway URL (default "http://localhost:8083") -- `--log-level string` - Log level: debug, info, warn, error (default "info") -- `-n, --namespace string` - Namespace (default "kagent") -- `-o, --output-format string` - Output format (default "table") -- `--server-name string` - TLS server name for KAgent endpoints -- `--timeout duration` - Timeout (default 5m0s) -- `--user-id string` - Caller identity used to select the server-side data partition (default "admin@kagent.dev") -- `-v, --verbose` - Verbose output diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-mcp.md b/docs-site/content/kagent/1.x/reference/cli/kagent-mcp.md deleted file mode 100644 index ff18372c..00000000 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-mcp.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: kagent mcp -description: MCP (Model Context Protocol) server management. -weight: 380 ---- - -MCP server management commands for creating and managing -Model Context Protocol servers with dynamic tool loading. - -```bash -kagent mcp [command] -``` - -**Subcommands:** -- [`kagent mcp add-tool`]({{< link path="reference/cli/kagent-mcp-add-tool" >}}) - Add a new MCP tool to your project -- [`kagent mcp build`]({{< link path="reference/cli/kagent-mcp-build" >}}) - Build MCP server as a Docker image -- [`kagent mcp deploy`]({{< link path="reference/cli/kagent-mcp-deploy" >}}) - Deploy MCP server to Kubernetes -- [`kagent mcp init`]({{< link path="reference/cli/kagent-mcp-init" >}}) - Initialize a new MCP server project -- [`kagent mcp run`]({{< link path="reference/cli/kagent-mcp-run" >}}) - Run MCP server locally -- [`kagent mcp secrets`]({{< link path="reference/cli/kagent-mcp-secrets" >}}) - Manage project secrets - -**Flags:** -- `-h, --help` - help for mcp - -**Global Flags:** -- `--api-url string` - KAgent control-plane API URL (default "http://localhost:8083") -- `--ca-file string` - CA certificate file for KAgent endpoints -- `--config string` - Configuration file (default: user config directory/kagent/config.yaml) -- `--gateway-url string` - KAgent A2A and MCP gateway URL (default "http://localhost:8083") -- `--log-level string` - Log level: debug, info, warn, error (default "info") -- `-n, --namespace string` - Namespace (default "kagent") -- `-o, --output-format string` - Output format (default "table") -- `--server-name string` - TLS server name for KAgent endpoints -- `--timeout duration` - Timeout (default 5m0s) -- `--user-id string` - Caller identity used to select the server-side data partition (default "admin@kagent.dev") -- `-v, --verbose` - Verbose output diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-create.md b/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-create.md index 43d46449..6f4723ee 100644 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-create.md +++ b/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-create.md @@ -1,7 +1,7 @@ --- title: kagent sandbox create description: Create a sandbox from a prepared template. -weight: 520 +weight: 390 --- Create a sandbox. Retain --request-id and all inputs for retries; each call makes one lifecycle attempt. Activity does not extend the TTL. diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-delete.md b/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-delete.md index 983aadc8..7c04d610 100644 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-delete.md +++ b/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-delete.md @@ -1,7 +1,7 @@ --- title: kagent sandbox delete description: delete a sandbox. -weight: 530 +weight: 400 --- Inspect or change sandbox lifecycle. Mutations make one attempt; retry the same mutation on transient errors. Get only observes. Suspend can interrupt work; delete removes files. diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-download.md b/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-download.md index ca34c5d1..8a19a6c2 100644 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-download.md +++ b/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-download.md @@ -1,7 +1,7 @@ --- title: kagent sandbox download description: Download a file, replacing the local destination only after success. -weight: 540 +weight: 410 --- Download a file, replacing the local destination only after success diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-exec.md b/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-exec.md index 9354d249..056c38e4 100644 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-exec.md +++ b/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-exec.md @@ -1,7 +1,7 @@ --- title: kagent sandbox exec description: Start a command once and wait for its result. -weight: 550 +weight: 420 --- Start a process once. By default, stream available output while waiting. A timeout stops waiting, not the remote process. Retain its process ID and use sandbox wait to reconnect. An uncertain start is never retried. JSON output is a stream of started/output/finished/interrupted records. diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-get.md b/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-get.md index 5833a870..6e5f174c 100644 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-get.md +++ b/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-get.md @@ -1,7 +1,7 @@ --- title: kagent sandbox get description: get a sandbox. -weight: 560 +weight: 430 --- Inspect or change sandbox lifecycle. Mutations make one attempt; retry the same mutation on transient errors. Get only observes. Suspend can interrupt work; delete removes files. diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-kill.md b/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-kill.md index d8ff55d6..32f16c76 100644 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-kill.md +++ b/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-kill.md @@ -1,7 +1,7 @@ --- title: kagent sandbox kill description: Terminate a process and its children. -weight: 570 +weight: 440 --- Terminate a process and its children diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-list.md b/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-list.md index 2aadc243..3d2843bb 100644 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-list.md +++ b/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-list.md @@ -1,7 +1,7 @@ --- title: kagent sandbox list description: List your sandboxes. -weight: 580 +weight: 450 --- List your sandboxes diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-process.md b/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-process.md index 18bcca64..b226c2c1 100644 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-process.md +++ b/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-process.md @@ -1,7 +1,7 @@ --- title: kagent sandbox process description: Inspect process status without waiting. -weight: 590 +weight: 460 --- Inspect process status without waiting diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-resume.md b/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-resume.md index ea39f58e..f94ba4b6 100644 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-resume.md +++ b/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-resume.md @@ -1,7 +1,7 @@ --- title: kagent sandbox resume description: resume a sandbox. -weight: 600 +weight: 470 --- Inspect or change sandbox lifecycle. Mutations make one attempt; retry the same mutation on transient errors. Get only observes. Suspend can interrupt work; delete removes files. diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-suspend.md b/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-suspend.md index 5054870a..0ff02329 100644 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-suspend.md +++ b/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-suspend.md @@ -1,7 +1,7 @@ --- title: kagent sandbox suspend description: suspend a sandbox. -weight: 610 +weight: 480 --- Inspect or change sandbox lifecycle. Mutations make one attempt; retry the same mutation on transient errors. Get only observes. Suspend can interrupt work; delete removes files. diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-templates.md b/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-templates.md index e20b58f8..110264ee 100644 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-templates.md +++ b/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-templates.md @@ -1,7 +1,7 @@ --- title: kagent sandbox templates description: List SandboxTemplates in the selected namespace. -weight: 620 +weight: 490 --- List SandboxTemplates in the selected namespace diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-upload.md b/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-upload.md index c76a99bd..530045f4 100644 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-upload.md +++ b/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-upload.md @@ -1,7 +1,7 @@ --- title: kagent sandbox upload description: Stream a local file into a sandbox (replaces the remote file). -weight: 630 +weight: 500 --- Stream a local file into a sandbox (replaces the remote file) diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-wait.md b/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-wait.md index 61b1fbf7..3cc2ae82 100644 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-wait.md +++ b/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox-wait.md @@ -1,7 +1,7 @@ --- title: kagent sandbox wait description: Collect output and wait for an existing process without restarting it. -weight: 640 +weight: 510 --- Collect output and wait for an existing process without restarting it diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox.md b/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox.md index 0d36b25f..0ddb7796 100644 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox.md +++ b/docs-site/content/kagent/1.x/reference/cli/kagent-sandbox.md @@ -1,7 +1,7 @@ --- title: kagent sandbox description: Run commands and transfer files in standalone sandboxes. -weight: 510 +weight: 380 --- Run commands and transfer files in standalone sandboxes diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-uninstall.md b/docs-site/content/kagent/1.x/reference/cli/kagent-uninstall.md index 3fa969d5..69f0e2b0 100644 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-uninstall.md +++ b/docs-site/content/kagent/1.x/reference/cli/kagent-uninstall.md @@ -1,7 +1,7 @@ --- title: kagent uninstall description: Uninstall kagent. -weight: 650 +weight: 520 --- Uninstall kagent diff --git a/docs-site/content/kagent/1.x/reference/cli/kagent-version.md b/docs-site/content/kagent/1.x/reference/cli/kagent-version.md index 0dbf55d3..dc645c8b 100644 --- a/docs-site/content/kagent/1.x/reference/cli/kagent-version.md +++ b/docs-site/content/kagent/1.x/reference/cli/kagent-version.md @@ -1,7 +1,7 @@ --- title: kagent version description: Print the kagent version. -weight: 660 +weight: 530 --- Print the kagent version diff --git a/docs-site/content/kagent/1.x/reference/helm.md b/docs-site/content/kagent/1.x/reference/helm.md index 7fbb945c..c95ba1e1 100644 --- a/docs-site/content/kagent/1.x/reference/helm.md +++ b/docs-site/content/kagent/1.x/reference/helm.md @@ -11,9 +11,8 @@ A Helm chart for kagent, built with Google ADK | Repository | Name | Version | |------------|------|---------| -| file://../tools/grafana-mcp | grafana-mcp | 1.0.0-alpha13 | +| file://../tools/grafana-mcp | grafana-mcp | 1.0.0-alpha14 | | https://oauth2-proxy.github.io/manifests | oauth2-proxy | ~10.7.0 | -| oci://ghcr.io/kagent-dev/kmcp/helm | kmcp | `${KMCP_VERSION}` | | oci://ghcr.io/kagent-dev/tools/helm | kagent-tools | 0.3.0 | ## Values @@ -21,18 +20,24 @@ A Helm chart for kagent, built with Google ADK | Key | Type | Default | Description | |-----|------|---------|-------------| | annotations | object | `{}` | Additional annotations to add to all Kubernetes deployment resources | -| config.database.role | string | `"kagent_owner"` | | +| config.database.owner.role | string | `"kagent_owner"` | | +| config.database.readWrite.role | string | `"kagent_readwrite"` | | | config.database.schema | string | `"kagent"` | | | config.database.skipMigrations | bool | `false` | | | config.database.vectorEnabled | bool | `false` | | | config.database.vectorSchema | string | `"extensions"` | | -| config.gateway.push.allowHttp | bool | `false` | | -| config.gateway.push.allowPrivateNetworks | bool | `false` | | +| config.harnessImages | object | `{}` | | | config.kubernetes | object | `{}` | | | config.logging.level | string | `"info"` | | | config.metrics.bindAddress | string | `":8443"` | | | config.metrics.secure | bool | `true` | | +| config.push.allowHttp | bool | `false` | | +| config.push.allowPrivateNetworks | bool | `false` | | +| config.push.recoveryInterval | string | `"60s"` | | | config.runtimeDefaults.logging.level | string | `"info"` | | +| config.runtimeDefaults.skillTools.bashVenvPath | string | `""` | | +| config.runtimeDefaults.skillTools.disableBash | bool | `false` | | +| config.runtimeDefaults.skillTools.fileSearchTools | bool | `false` | | | config.runtimeDefaults.telemetry | object | `{}` | | | config.sandboxes.cpu | string | `"1"` | | | config.sandboxes.defaultTtl | string | `"3600s"` | | @@ -101,13 +106,14 @@ A Helm chart for kagent, built with Google ADK | controller.topologySpreadConstraints | list | `[]` | [Topology spread constraints](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#pod-topology-spread-constraints) for the controller pod. | | controller.volumeMounts | list | `[]` | | | controller.volumes | list | `[]` | | -| database.postgres.clientCertificate | object | `{"enabled":false}` | Project the bundled PostgreSQL client certificate. The connection string must reference the files under /run/postgres.podcert.ate.dev. | -| database.postgres.connectionStringSecretRef | object | `{"key":"connectionString","name":"kagent-postgres"}` | Source the PostgreSQL connection string from a pre-created Secret. Secret changes require restarting the controller. | +| database.postgres.clientCertificate | object | `{"enabled":false}` | Project the bundled PostgreSQL client certificates for kagent_readwrite_user and, unless config.database.skipMigrations is true, kagent_owner_user. The connection strings must reference the files under /run/postgres.podcert.ate.dev. | +| database.postgres.ownerConnectionStringSecretRef | object | `{"key":"ownerConnectionString","name":"kagent-postgres-owner"}` | Secret holding the owner login's connection string. The owner creates the schema and runs migrations; it is not used when config.database.skipMigrations is true. Secret changes require restarting the controller. | +| database.postgres.readWriteConnectionStringSecretRef | object | `{"key":"readWriteConnectionString","name":"kagent-postgres-readwrite"}` | Secret holding the read/write login's connection string, used for every runtime query. Required. Secret changes require restarting the controller. | | extraObjects | list | [] | Additional arbitrary Kubernetes manifests to deploy alongside the chart. Each list entry is rendered through `tpl`, so values may reference the release context (e.g. `{{ include "kagent.fullname" . }}`, `{{ .Release.Namespace }}`). Both map and multi-line string entries are supported. Use this to manage resources such as ExternalSecret, HTTPRoute, or NetworkPolicy within the same chart lifecycle without maintaining a separate chart. To use, replace the empty list below with your manifests, e.g.: extraObjects: - apiVersion: external-secrets.io/v1 kind: ExternalSecret metadata: name: '`{{ include "kagent.fullname" . }}`-openai' namespace: '`{{ .Release.Namespace }}`' spec: secretStoreRef: name: aws-secretsmanager kind: ClusterSecretStore target: name: kagent-openai data: - secretKey: OPENAI_API_KEY remoteRef: key: prod/kagent/openai property: api_key | | fullnameOverride | string | `""` | | | global.imagePullPolicy | string | `""` | Fallback imagePullPolicy where neither a component nor the top-level imagePullPolicy sets one. | | global.imagePullSecrets | list | `[]` | Pull secrets for every pod. The chart merges this list (union) into each pod's own imagePullSecrets, so a local secret is never removed. Coverage matches imageRegistry above. | -| global.imageRegistry | string | `""` | Registry that overrides every per-image registry when set. This is the air-gap mirror knob: one value redirects all images. Repository and tag stay per-image. For per-image control, leave this unset and set the per-image registry keys. Covers this chart's own images: controller, sandbox guest, ui, grafana-mcp, and substrateWorkerPool.workerImage. The vendored subcharts (kagent-tools, kmcp) adopt it when their pinned versions bump. | +| global.imageRegistry | string | `""` | Registry that overrides every per-image registry when set. This is the air-gap mirror knob: one value redirects all images. Repository and tag stay per-image. For per-image control, leave this unset and set the per-image registry keys. Covers this chart's own images: controller, sandbox guest, ui, grafana-mcp, substrateWorkerPool.workerImage, and built-in Harness images (both packaged defaults and config.harnessImages overrides). The vendored subcharts kagent-tools adopts it when its pinned version bumps. | | global.watchNamespaces | list | `[]` | Namespace scope for the whole install. A non-empty list replaces ClusterRoles with Roles and scopes the controller's watch. Both derive from this one value, so they cannot disagree. Prefer this value over the per-surface keys. rbac.namespaces overrides it when the key is present. An explicit empty rbac.namespaces restores cluster-scoped RBAC. Mixing in config.kubernetes.watchNamespaces is validated: the watch must stay inside the RBAC scope. A watched namespace without a Role is a permanent Forbidden loop at runtime. | | grafana-mcp.enabled | bool | `true` | | | grafana-mcp.grafana.serviceAccountToken | string | `""` | | @@ -135,10 +141,6 @@ A Helm chart for kagent, built with Google ADK | kagent-tools.tolerations | list | `[]` | Node taints which will be tolerated for `Pod` [scheduling](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). | | kagent-tools.tools.loglevel | string | `"debug"` | | | kagent-tools.tools.metrics.port | int | `8085` | | -| kmcp.enabled | bool | `true` | | -| kmcp.fullnameOverride | string | `""` | | -| kmcp.nameOverride | string | `"kmcp"` | | -| kmcp.namespaceOverride | string | `""` | | | labels | object | `{}` | Additional labels to add to all Kubernetes resources | | nameOverride | string | `""` | | | namespaceOverride | string | `.Release.Namespace` | Override the namespace |