From 9e0b69707809d4180a68682b663b9a71f45de727 Mon Sep 17 00:00:00 2001 From: Art Berger Date: Tue, 28 Oct 2025 12:01:32 -0400 Subject: [PATCH 1/9] name Signed-off-by: Art Berger --- src/data/external-blog-posts.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/data/external-blog-posts.yaml b/src/data/external-blog-posts.yaml index 80c5c0b..64807dc 100644 --- a/src/data/external-blog-posts.yaml +++ b/src/data/external-blog-posts.yaml @@ -1,8 +1,8 @@ # External blog posts displayed on the blog index alongside internal posts # Fields: title, description, publishDate (YYYY-MM-DD), url, author externalPosts: - - title: "KAgent: Open-Source Agentic AI Framework for Autonomous Systems" - description: "KAgent is an open-source framework for building autonomous AI agents that can make decisions and perform tasks with minimal human oversight. Donated by Solo.io, it enables developers to create intelligent systems for virtual assistance, data processing, and workflow automation by leveraging generative AI and external API integrations." + - title: "Kagent: Open-Source Agentic AI Framework for Autonomous Systems" + description: "Kagent is an open-source framework for building autonomous AI agents that can make decisions and perform tasks with minimal human oversight. Donated by Solo.io, it enables developers to create intelligent systems for virtual assistance, data processing, and workflow automation by leveraging generative AI and external API integrations." publishDate: "2025-05-19" url: "https://medium.com/@godhanipayal/kagent-open-source-agentic-ai-framework-for-autonomous-systems-cfde34a80742" author: "Payal Godhani" From 407d1af3383d56da90d71a687fdb398bea168c4b Mon Sep 17 00:00:00 2001 From: Art Berger Date: Tue, 28 Oct 2025 12:01:37 -0400 Subject: [PATCH 2/9] add kagent CLI commands Signed-off-by: Art Berger --- public/sitemap.xml | 258 ++++++++++++------ .../docs/kagent/examples/crewai-byo/page.mdx | 2 +- .../kagent/examples/langchain-byo/page.mdx | 2 +- .../resources/cli/kagent-add-mcp/page.mdx | 59 ++++ .../resources/cli/kagent-bug-report/page.mdx | 38 +++ .../resources/cli/kagent-build/page.mdx | 55 ++++ .../resources/cli/kagent-dashboard/page.mdx | 29 ++ .../resources/cli/kagent-deploy/page.mdx | 72 +++++ .../kagent/resources/cli/kagent-get/page.mdx | 58 ++++ .../kagent/resources/cli/kagent-init/page.mdx | 64 +++++ ...320\272\320\276\320\262\320\276\320\264 x" | 1 + .../resources/cli/kagent-install/page.mdx | 44 +++ .../resources/cli/kagent-invoke/page.mdx | 49 ++++ .../kagent/resources/cli/kagent-mcp/page.mdx | 44 +++ .../kagent/resources/cli/kagent-run/page.mdx | 45 +++ .../resources/cli/kagent-uninstall/page.mdx | 29 ++ .../resources/cli/kagent-version/page.mdx | 33 +++ src/app/docs/kagent/resources/cli/page.mdx | 31 +++ src/app/docs/kagent/resources/page.mdx | 1 + .../kagent/resources/release-notes/page.mdx | 4 +- .../community-nginx-khook-kagent.mdx | 2 +- src/components/icons/kagent-logo-text.tsx | 2 +- src/components/navbar.tsx | 6 +- src/config/navigation.json | 25 +- 24 files changed, 854 insertions(+), 99 deletions(-) create mode 100644 src/app/docs/kagent/resources/cli/kagent-add-mcp/page.mdx create mode 100644 src/app/docs/kagent/resources/cli/kagent-bug-report/page.mdx create mode 100644 src/app/docs/kagent/resources/cli/kagent-build/page.mdx create mode 100644 src/app/docs/kagent/resources/cli/kagent-dashboard/page.mdx create mode 100644 src/app/docs/kagent/resources/cli/kagent-deploy/page.mdx create mode 100644 src/app/docs/kagent/resources/cli/kagent-get/page.mdx create mode 100644 src/app/docs/kagent/resources/cli/kagent-init/page.mdx create mode 100644 "src/app/docs/kagent/resources/cli/kagent-install/page.m \321\200\321\203\320\272\320\276\320\262\320\276\320\264 x" create mode 100644 src/app/docs/kagent/resources/cli/kagent-install/page.mdx create mode 100644 src/app/docs/kagent/resources/cli/kagent-invoke/page.mdx create mode 100644 src/app/docs/kagent/resources/cli/kagent-mcp/page.mdx create mode 100644 src/app/docs/kagent/resources/cli/kagent-run/page.mdx create mode 100644 src/app/docs/kagent/resources/cli/kagent-uninstall/page.mdx create mode 100644 src/app/docs/kagent/resources/cli/kagent-version/page.mdx create mode 100644 src/app/docs/kagent/resources/cli/page.mdx diff --git a/public/sitemap.xml b/public/sitemap.xml index 1c9fd2a..9fe9155 100644 --- a/public/sitemap.xml +++ b/public/sitemap.xml @@ -2,560 +2,658 @@ https://kagent.dev/agents - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/blog - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/community - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/concepts/agents - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/concepts/architecture - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/concepts - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/concepts/tools - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/examples/a2a-agents - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/examples/a2a-byo - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/examples/crewai-byo - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/examples/discord-a2a - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/examples/documentation - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/examples/langchain-byo - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/examples - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/examples/slack-a2a - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/getting-started/first-agent - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/getting-started/first-mcp-tool - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/getting-started - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/getting-started/quickstart - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/getting-started/system-prompts - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/getting-started/tracing - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/introduction/installation - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/introduction - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/introduction/what-is-kagent - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/resources/api-ref - 2025-10-21 + 2025-10-28 + weekly + 0.8 + + + + https://kagent.dev/docs/kagent/resources/cli/kagent-add-mcp + 2025-10-28 + weekly + 0.8 + + + + https://kagent.dev/docs/kagent/resources/cli/kagent-bug-report + 2025-10-28 + weekly + 0.8 + + + + https://kagent.dev/docs/kagent/resources/cli/kagent-build + 2025-10-28 + weekly + 0.8 + + + + https://kagent.dev/docs/kagent/resources/cli/kagent-dashboard + 2025-10-28 + weekly + 0.8 + + + + https://kagent.dev/docs/kagent/resources/cli/kagent-deploy + 2025-10-28 + weekly + 0.8 + + + + https://kagent.dev/docs/kagent/resources/cli/kagent-get + 2025-10-28 + weekly + 0.8 + + + + https://kagent.dev/docs/kagent/resources/cli/kagent-init + 2025-10-28 + weekly + 0.8 + + + + https://kagent.dev/docs/kagent/resources/cli/kagent-install + 2025-10-28 + weekly + 0.8 + + + + https://kagent.dev/docs/kagent/resources/cli/kagent-invoke + 2025-10-28 + weekly + 0.8 + + + + https://kagent.dev/docs/kagent/resources/cli/kagent-mcp + 2025-10-28 + weekly + 0.8 + + + + https://kagent.dev/docs/kagent/resources/cli/kagent-run + 2025-10-28 + weekly + 0.8 + + + + https://kagent.dev/docs/kagent/resources/cli/kagent-uninstall + 2025-10-28 + weekly + 0.8 + + + + https://kagent.dev/docs/kagent/resources/cli/kagent-version + 2025-10-28 + weekly + 0.8 + + + + https://kagent.dev/docs/kagent/resources/cli + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/resources/faq - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/resources/helm - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/resources - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/resources/release-notes - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/resources/troubleshooting - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/supported-providers/amazon-bedrock - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/supported-providers/anthropic - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/supported-providers/azure-openai - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/supported-providers/byo-openai - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/supported-providers/gemini - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/supported-providers/google-vertexai - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/supported-providers/ollama - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/supported-providers/openai - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kagent/supported-providers - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kmcp/deploy/install-controller - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kmcp/deploy - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kmcp/deploy/server - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kmcp/develop/fastmcp-python - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kmcp/develop/mcp-go - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kmcp/develop - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kmcp/introduction - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kmcp - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kmcp/quickstart - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kmcp/reference/api-ref - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kmcp/reference/kmcp-add-tool - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kmcp/reference/kmcp-build - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kmcp/reference/kmcp-deploy - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kmcp/reference/kmcp-init - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kmcp/reference/kmcp-install - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kmcp/reference/kmcp-run - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kmcp/reference/kmcp-secrets - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kmcp/reference - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs/kmcp/secrets - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/docs - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/enterprise - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/page.tsx - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/tools - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/agents/argo-rollouts-conversion-agent - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/agents/cilium-crd-agent - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/agents/helm-agent - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/agents/istio-agent - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/agents/k8s-agent - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/agents/kgateway-agent - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/agents/observability-agent - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/agents/promql-agent - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/tools/istio - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/tools/kubernetes - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/tools/prometheus - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/tools/documentation - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/tools/helm - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/tools/argo - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/tools/grafana - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/tools/other - 2025-10-21 + 2025-10-28 weekly 0.8 https://kagent.dev/tools/cilium - 2025-10-21 + 2025-10-28 weekly 0.8 diff --git a/src/app/docs/kagent/examples/crewai-byo/page.mdx b/src/app/docs/kagent/examples/crewai-byo/page.mdx index 0173350..abba26b 100644 --- a/src/app/docs/kagent/examples/crewai-byo/page.mdx +++ b/src/app/docs/kagent/examples/crewai-byo/page.mdx @@ -42,7 +42,7 @@ The following example builds a research crew agent from the [kagent code reposit ### Adapting your own CrewAI agent -A quickstart and detailed guide for adapting existing CrewAI crews and flows to work with KAgent is available in the [package's README](https://github.com/kagent-dev/kagent/tree/main/python/packages/kagent-crewai). +A quickstart and detailed guide for adapting existing CrewAI crews and flows to work with kagent is available in the [package's README](https://github.com/kagent-dev/kagent/tree/main/python/packages/kagent-crewai). This provides a simple way to setup A2A server, tracing, and session-aware memory and state persistence. Two complete examples are available in the `python/samples/crewai/` directory: diff --git a/src/app/docs/kagent/examples/langchain-byo/page.mdx b/src/app/docs/kagent/examples/langchain-byo/page.mdx index 9cad027..d5bc4a9 100644 --- a/src/app/docs/kagent/examples/langchain-byo/page.mdx +++ b/src/app/docs/kagent/examples/langchain-byo/page.mdx @@ -12,7 +12,7 @@ export const metadata = { # Bringing your own LangGraph agent to kagent -You can bring your own LangGraph agent to kagent by configuring the KAgentCheckpointer in your LangGraph agent code. The [KAgentCheckpointer](https://github.com/kagent-dev/kagent/blob/main/python/samples/langgraph/currency/currency/agent.py#L13) stores the LangGraph state in kagent and enables distributed execution and session recovery. +You can bring your own LangGraph agent to kagent by configuring the kagentCheckpointer in your LangGraph agent code. The [kagentCheckpointer](https://github.com/kagent-dev/kagent/blob/main/python/samples/langgraph/currency/currency/agent.py#L13) stores the LangGraph state in kagent and enables distributed execution and session recovery. ## Prerequisites diff --git a/src/app/docs/kagent/resources/cli/kagent-add-mcp/page.mdx b/src/app/docs/kagent/resources/cli/kagent-add-mcp/page.mdx new file mode 100644 index 0000000..b34350d --- /dev/null +++ b/src/app/docs/kagent/resources/cli/kagent-add-mcp/page.mdx @@ -0,0 +1,59 @@ +--- +title: "kagent add-mcp" +pageOrder: 10 +description: "kagent add-mcp command" +--- + +# `kagent add-mcp` + +Add an MCP server entry to `kagent.yaml`. + +```bash +kagent add-mcp [name] [args...] [flags] +``` + +**Arguments:** +- `name` - Name of the MCP server +- `args` - Command arguments (optional) + +**Flags:** +- `--arg` - Command argument (repeatable) +- `--build` - Construct image specification (e.g., `docker build`) +- `--command` - Command to run MCP server (e.g., `npx`, `uvx`, `kmcp`) +- `--env` - Environment variable in KEY=VALUE format (repeatable) +- `--header` - HTTP header for remote MCP in KEY=VALUE format (repeatable, supports `${VAR}` for env vars) +- `--image` - Container image (optional; mutually exclusive with `--build`) +- `--project-dir` - Project directory (default: current directory) +- `--remote` - Remote MCP server URL (`http://` or `https://`) + +**Global Flags:** +- `--kagent-url` - kagent URL (default: "http://localhost:8083") +- `--namespace, -n` - Namespace (default: "kagent") +- `--output-format, -o` - Output format (default: "table") +- `--timeout` - Timeout duration (default: 300s) +- `--verbose, -v` - Verbose output + +## About `kagent add-mcp` + +Adds an MCP server entry to your `kagent.yaml` file. Use flags for non-interactive setup or run without flags to open the wizard. + +## Example + +Add a remote MCP server: + +```bash +kagent add-mcp my-mcp-server --remote https://mcp.example.com +``` + +Add an MCP server with a command: + +```bash +kagent add-mcp my-mcp-server --command npx --arg @modelcontextprotocol/server-filesystem +``` + +Add an MCP server with custom environment variables: + +```bash +kagent add-mcp my-mcp-server --command my-server --env API_KEY=secret --env LOG_LEVEL=debug +``` + diff --git a/src/app/docs/kagent/resources/cli/kagent-bug-report/page.mdx b/src/app/docs/kagent/resources/cli/kagent-bug-report/page.mdx new file mode 100644 index 0000000..58ed466 --- /dev/null +++ b/src/app/docs/kagent/resources/cli/kagent-bug-report/page.mdx @@ -0,0 +1,38 @@ +--- +title: "kagent bug-report" +pageOrder: 10 +description: "kagent bug-report command" +--- + +# `kagent bug-report` + +Generate a bug report for troubleshooting. + +```bash +kagent bug-report [flags] +``` + +**Global Flags:** +- `--kagent-url` - kagent URL (default: "http://localhost:8083") +- `--namespace, -n` - Namespace (default: "kagent") +- `--output-format, -o` - Output format (default: "table") +- `--timeout` - Timeout duration (default: 300s) +- `--verbose, -v` - Verbose output + +## About `kagent bug-report` + +This command generates a comprehensive bug report that includes: +- kagent CLI version +- kagent server version +- Kubernetes cluster information +- Resource status and logs +- Configuration details + +## Example + +Generate a bug report: + +```bash +kagent bug-report +``` + diff --git a/src/app/docs/kagent/resources/cli/kagent-build/page.mdx b/src/app/docs/kagent/resources/cli/kagent-build/page.mdx new file mode 100644 index 0000000..bf82b19 --- /dev/null +++ b/src/app/docs/kagent/resources/cli/kagent-build/page.mdx @@ -0,0 +1,55 @@ +--- +title: "kagent build" +pageOrder: 10 +description: "kagent build command" +--- + +# `kagent build` + +Build a Docker image for an agent project. + +```bash +kagent build [project-directory] [flags] +``` + +**Arguments:** +- `project-directory` - The directory containing the agent project with `kagent.yaml` + +**Flags:** +- `--image` - Full image specification (e.g., ghcr.io/myorg/my-agent:v1.0.0) +- `--push` - Push the image to the registry + +**Global Flags:** +- `--kagent-url` - kagent URL (default: "http://localhost:8083") +- `--namespace, -n` - Namespace (default: "kagent") +- `--output-format, -o` - Output format (default: "table") +- `--timeout` - Timeout duration (default: 300s) +- `--verbose, -v` - Verbose output + +## About `kagent build` + +The `kagent build` command builds Docker images for an agent project created with the `init` command. It looks for a `kagent.yaml` file in the specified project directory and builds Docker images using `docker build`. + +**Image naming:** +- If `--image` is provided, it is used as the full image specification (e.g., `ghcr.io/myorg/my-agent:v1.0.0`) +- Otherwise, defaults to `localhost:5001/{agentName}:latest` where `agentName` is loaded from `kagent.yaml` + +## Example + +Build a Docker image: + +```bash +kagent build ./my-agent +``` + +Build and tag a Docker image: + +```bash +kagent build ./my-agent --image ghcr.io/myorg/my-agent:v1.0.0 +``` + +Build and push an image to a registry: + +```bash +kagent build ./my-agent --image ghcr.io/myorg/my-agent:v1.0.0 --push +``` diff --git a/src/app/docs/kagent/resources/cli/kagent-dashboard/page.mdx b/src/app/docs/kagent/resources/cli/kagent-dashboard/page.mdx new file mode 100644 index 0000000..837df41 --- /dev/null +++ b/src/app/docs/kagent/resources/cli/kagent-dashboard/page.mdx @@ -0,0 +1,29 @@ +--- +title: "kagent dashboard" +pageOrder: 10 +description: "kagent dashboard command" +--- + +# `kagent dashboard` + +Open the kagent dashboard in your default web browser. + +```bash +kagent dashboard [flags] +``` + +**Global Flags:** +- `--kagent-url` - kagent URL (default: "http://localhost:8083") +- `--namespace, -n` - Namespace (default: "kagent") +- `--output-format, -o` - Output format (default: "table") +- `--timeout` - Timeout duration (default: 300s) +- `--verbose, -v` - Verbose output + +## Example + +Open the dashboard: + +```bash +kagent dashboard +``` + diff --git a/src/app/docs/kagent/resources/cli/kagent-deploy/page.mdx b/src/app/docs/kagent/resources/cli/kagent-deploy/page.mdx new file mode 100644 index 0000000..bb227bd --- /dev/null +++ b/src/app/docs/kagent/resources/cli/kagent-deploy/page.mdx @@ -0,0 +1,72 @@ +--- +title: "kagent deploy" +pageOrder: 10 +description: "kagent deploy command" +--- + +# `kagent deploy` + +Deploy an agent to Kubernetes. + +```bash +kagent deploy [project-directory] [flags] +``` + +**Arguments:** +- `project-directory` - The directory containing the agent project with `kagent.yaml` + +**Flags:** +- `--api-key` - API key for the model provider (convenience option to create secret) +- `--api-key-secret` - Name of existing secret containing API key (recommended) +- `--dry-run` - Output YAML manifests without applying them to the cluster +- `--image, -i` - Image to use (defaults to `localhost:5001/{agentName}:latest`) +- `--namespace` - Kubernetes namespace to deploy to + +**Global Flags:** +- `--kagent-url` - kagent URL (default: "http://localhost:8083") +- `--output-format, -o` - Output format (default: "table") +- `--timeout` - Timeout duration (default: 300s) +- `--verbose, -v` - Verbose output + +## About `kagent deploy` + +The `kagent deploy` command deploys an agent to Kubernetes. It reads the `kagent.yaml` file from the specified project directory, creates or references a Kubernetes secret with the API key, and creates an Agent CRD. + +**What the command does:** +1. Loads the agent configuration from `kagent.yaml` +2. Either creates a new secret with the provided API key or verifies an existing secret +3. Creates an Agent CRD with the appropriate configuration + +**API Key Options:** +- `--api-key`: Convenience option to create a new secret with the provided API key +- `--api-key-secret`: Recommended way to reference an existing secret by name + +**Dry-Run Mode:** +Use the `--dry-run` flag to output YAML manifests without applying them to the cluster. This is useful for previewing changes or for use with GitOps workflows. + +## Example + +Deploy using an existing secret: + +```bash +kagent deploy ./my-agent --api-key-secret "my-existing-secret" +``` + +Deploy and create a new secret: + +```bash +kagent deploy ./my-agent --api-key "your-api-key-here" --image "myregistry/myagent:v1.0" +``` + +Deploy to a specific namespace: + +```bash +kagent deploy ./my-agent --api-key-secret "my-secret" --namespace "my-namespace" +``` + +Generate manifests without deploying: + +```bash +kagent deploy ./my-agent --api-key "your-api-key" --dry-run > manifests.yaml +``` + diff --git a/src/app/docs/kagent/resources/cli/kagent-get/page.mdx b/src/app/docs/kagent/resources/cli/kagent-get/page.mdx new file mode 100644 index 0000000..8695717 --- /dev/null +++ b/src/app/docs/kagent/resources/cli/kagent-get/page.mdx @@ -0,0 +1,58 @@ +--- +title: "kagent get" +pageOrder: 10 +description: "kagent get command" +--- + +# `kagent get` + +Get kagent resources. + +```bash +kagent get [resource-type] [resource-name] [flags] +``` + +**Subcommands:** +- `agent [agent_name]` - Get an agent by name or list all agents +- `session [session_id]` - Get a session by ID or list all sessions +- `tool` - List all available tools + +**Global Flags:** +- `--kagent-url` - kagent URL (default: "http://localhost:8083") +- `--namespace, -n` - Namespace (default: "kagent") +- `--output-format, -o` - Output format (default: "table") +- `--timeout` - Timeout duration (default: 300s) +- `--verbose, -v` - Verbose output + +## Example + +List all agents: + +```bash +kagent get agent +``` + +Get a specific agent: + +```bash +kagent get agent k8s-agent +``` + +List all sessions: + +```bash +kagent get session +``` + +Get a specific session: + +```bash +kagent get session abc123 +``` + +List all tools: + +```bash +kagent get tool +``` + diff --git a/src/app/docs/kagent/resources/cli/kagent-init/page.mdx b/src/app/docs/kagent/resources/cli/kagent-init/page.mdx new file mode 100644 index 0000000..b0fda6f --- /dev/null +++ b/src/app/docs/kagent/resources/cli/kagent-init/page.mdx @@ -0,0 +1,64 @@ +--- +title: "kagent init" +pageOrder: 10 +description: "kagent init command" +--- + +# `kagent init` + +Initialize a new agent project with the specified framework and language. + +```bash +kagent init [framework] [language] [agent-name] [flags] +``` + +**Arguments:** +- `framework` - The framework to use (currently supports `adk`) +- `language` - The programming language to use (supports `python`) +- `agent-name` - The name of the agent project + +**Flags:** +- `--description` - Description for the agent +- `--instruction-file` - Path to file containing custom instructions for the root agent +- `--model-name` - Model name (e.g., gpt-4, claude-3-5-sonnet, gemini-2.0-flash) (default: "gemini-2.0-flash") +- `--model-provider` - Model provider (OpenAI, Anthropic, Gemini) (default: "Gemini") + +**Global Flags:** +- `--kagent-url` - kagent URL (default: "http://localhost:8083") +- `--namespace, -n` - Namespace (default: "kagent") +- `--output-format, -o` - Output format (default: "table") +- `--timeout` - Timeout duration (default: 300s) +- `--verbose, -v` - Verbose output + +## About `kagent init` + +The `kagent init` command creates a bootstrap agent project. You can customize the root agent instructions using the `--instruction-file` flag and select a specific model using the `--model-provider` and `--model-name` flags. + +If no custom instruction file is provided, a default dice-rolling instruction is used. If no model is specified, the agent can be configured later. + +Currently supported model providers are the models that are supported in the models configuration: +- OpenAI +- Anthropic +- AzureOpenAI +- Gemini + +## Example + +Create a new agent project: + +```bash +kagent init adk python dice +``` + +Create a new agent project with custom instructions: + +```bash +kagent init adk python dice --instruction-file instructions.md +``` + +Create a new agent project with a specific model: + +```bash +kagent init adk python dice --model-provider Gemini --model-name gemini-2.0-flash +``` + diff --git "a/src/app/docs/kagent/resources/cli/kagent-install/page.m \321\200\321\203\320\272\320\276\320\262\320\276\320\264 x" "b/src/app/docs/kagent/resources/cli/kagent-install/page.m \321\200\321\203\320\272\320\276\320\262\320\276\320\264 x" new file mode 100644 index 0000000..0519ecb --- /dev/null +++ "b/src/app/docs/kagent/resources/cli/kagent-install/page.m \321\200\321\203\320\272\320\276\320\262\320\276\320\264 x" @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/src/app/docs/kagent/resources/cli/kagent-install/page.mdx b/src/app/docs/kagent/resources/cli/kagent-install/page.mdx new file mode 100644 index 0000000..fc75148 --- /dev/null +++ b/src/app/docs/kagent/resources/cli/kagent-install/page.mdx @@ -0,0 +1,44 @@ +--- +title: "kagent install" +pageOrder: 10 +description: "kagent install command" +--- + +# `kagent install` + +Install kagent on a Kubernetes cluster. + +```bash +kagent install [flags] +``` + +**Flags:** +- `--profile` - Installation profile (minimal|demo) + +**Global Flags:** +- `--kagent-url` - kagent URL (default: "http://localhost:8083") +- `--namespace, -n` - Namespace (default: "kagent") +- `--output-format, -o` - Output format (default: "table") +- `--timeout` - Timeout duration (default: 300s) +- `--verbose, -v` - Verbose output + +## Example + +Install kagent with the default profile: + +```bash +kagent install +``` + +Install kagent with the minimal profile: + +```bash +kagent install --profile minimal +``` + +Install kagent with the demo profile: + +```bash +kagent install --profile demo +``` + diff --git a/src/app/docs/kagent/resources/cli/kagent-invoke/page.mdx b/src/app/docs/kagent/resources/cli/kagent-invoke/page.mdx new file mode 100644 index 0000000..fff24b0 --- /dev/null +++ b/src/app/docs/kagent/resources/cli/kagent-invoke/page.mdx @@ -0,0 +1,49 @@ +--- +title: "kagent invoke" +pageOrder: 10 +description: "kagent invoke command" +--- + +# `kagent invoke` + +Invoke a kagent agent to perform a task. + +```bash +kagent invoke [flags] +``` + +**Flags:** +- `--agent, -a` - Agent to invoke +- `--file, -f` - File to read the task from +- `--session, -s` - Session +- `--stream, -S` - Stream the response +- `--task, -t` - Task to perform +- `--url-override, -u` - URL override + +**Global Flags:** +- `--kagent-url` - kagent URL (default: "http://localhost:8083") +- `--namespace, -n` - Namespace (default: "kagent") +- `--output-format, -o` - Output format (default: "table") +- `--timeout` - Timeout duration (default: 300s) +- `--verbose, -v` - Verbose output + +## Example + +Invoke an agent with a task: + +```bash +kagent invoke --agent "k8s-agent" --task "Get all the pods in the kagent namespace" +``` + +Invoke with streaming output: + +```bash +kagent invoke --agent "k8s-agent" --task "Get all the pods" --stream +``` + +Invoke from a task file: + +```bash +kagent invoke --agent "k8s-agent" --file task.txt +``` + diff --git a/src/app/docs/kagent/resources/cli/kagent-mcp/page.mdx b/src/app/docs/kagent/resources/cli/kagent-mcp/page.mdx new file mode 100644 index 0000000..e0ae47d --- /dev/null +++ b/src/app/docs/kagent/resources/cli/kagent-mcp/page.mdx @@ -0,0 +1,44 @@ +--- +title: "kagent mcp" +pageOrder: 10 +description: "kagent mcp command" +--- + +# `kagent mcp` + +MCP (Model Context Protocol) server management commands for creating and managing Model Context Protocol servers with dynamic tool loading. + +```bash +kagent mcp [subcommand] [flags] +``` + +**Subcommands:** +- `init` - Initialize a new MCP server project +- `build` - Build a Docker image for your MCP server +- `deploy` - Deploy your MCP server to a Kubernetes cluster +- `add-tool` - Generate an MCP tool boilerplate +- `run` - Run an MCP server locally +- `secrets` - Manage secrets for MCP server projects + +**Global Flags:** +- `--kagent-url` - kagent URL (default: "http://localhost:8083") +- `--namespace, -n` - Namespace (default: "kagent") +- `--output-format, -o` - Output format (default: "table") +- `--timeout` - Timeout duration (default: 300s) +- `--verbose, -v` - Verbose output + +## About `kagent mcp` + +The `kagent mcp` command provides a set of subcommands for managing MCP servers. This is useful for creating and managing tools that can be used by kagent agents. + +## Example + +See the kagent mcp documentation for detailed examples of each subcommand: + +- [kagent mcp init](/docs/kmcp/reference/kmcp-init) - Create a scaffold for your MCP server +- [kagent mcp build](/docs/kmcp/reference/kmcp-build) - Build a Docker image +- [kagent mcp deploy](/docs/kmcp/reference/kmcp-deploy) - Deploy to Kubernetes +- [kagent mcp add-tool](/docs/kmcp/reference/kmcp-add-tool) - Generate tool boilerplate +- [kagent mcp run](/docs/kmcp/reference/kmcp-run) - Run locally +- [kagent mcp secrets](/docs/kmcp/reference/kmcp-secrets) - Manage secrets + diff --git a/src/app/docs/kagent/resources/cli/kagent-run/page.mdx b/src/app/docs/kagent/resources/cli/kagent-run/page.mdx new file mode 100644 index 0000000..cb92bed --- /dev/null +++ b/src/app/docs/kagent/resources/cli/kagent-run/page.mdx @@ -0,0 +1,45 @@ +--- +title: "kagent run" +pageOrder: 10 +description: "kagent run command" +--- + +# `kagent run` + +Run an agent project locally with docker-compose and launch an interactive chat interface. + +```bash +kagent run [project-directory] [flags] +``` + +**Arguments:** +- `project-directory` - The directory containing the agent project (default: current directory) + +**Flags:** +- `--project-dir` - Project directory (default: current directory) + +**Global Flags:** +- `--kagent-url` - kagent URL (default: "http://localhost:8083") +- `--namespace, -n` - Namespace (default: "kagent") +- `--output-format, -o` - Output format (default: "table") +- `--timeout` - Timeout duration (default: 300s) +- `--verbose, -v` - Verbose output + +## About `kagent run` + +The `kagent run` command runs an agent project locally using docker-compose and launches an interactive chat session. This allows you to test and interact with your agent before deploying it to Kubernetes. + +## Example + +Run an agent project from the current directory: + +```bash +kagent run +``` + +Run an agent project from a specific directory: + +```bash +kagent run ./my-agent +``` + diff --git a/src/app/docs/kagent/resources/cli/kagent-uninstall/page.mdx b/src/app/docs/kagent/resources/cli/kagent-uninstall/page.mdx new file mode 100644 index 0000000..f242c5a --- /dev/null +++ b/src/app/docs/kagent/resources/cli/kagent-uninstall/page.mdx @@ -0,0 +1,29 @@ +--- +title: "kagent uninstall" +pageOrder: 10 +description: "kagent uninstall command" +--- + +# `kagent uninstall` + +Uninstall kagent from a Kubernetes cluster. + +```bash +kagent uninstall [flags] +``` + +**Global Flags:** +- `--kagent-url` - kagent URL (default: "http://localhost:8083") +- `--namespace, -n` - Namespace (default: "kagent") +- `--output-format, -o` - Output format (default: "table") +- `--timeout` - Timeout duration (default: 300s) +- `--verbose, -v` - Verbose output + +## Example + +Uninstall kagent: + +```bash +kagent uninstall +``` + diff --git a/src/app/docs/kagent/resources/cli/kagent-version/page.mdx b/src/app/docs/kagent/resources/cli/kagent-version/page.mdx new file mode 100644 index 0000000..b03c039 --- /dev/null +++ b/src/app/docs/kagent/resources/cli/kagent-version/page.mdx @@ -0,0 +1,33 @@ +--- +title: "kagent version" +pageOrder: 10 +description: "kagent version command" +--- + +# `kagent version` + +Print the kagent version information. + +```bash +kagent version [flags] +``` + +**Global Flags:** +- `--kagent-url` - kagent URL (default: "http://localhost:8083") +- `--namespace, -n` - Namespace (default: "kagent") +- `--output-format, -o` - Output format (default: "table") +- `--timeout` - Timeout duration (default: 300s) +- `--verbose, -v` - Verbose output + +## About `kagent version` + +This command prints the kagent CLI version. The CLI attempts to connect to the kagent server to retrieve server version information. Versions unable to be obtained from the remote kagent server are reported as "unknown". + +## Example + +Print version information: + +```bash +kagent version +``` + diff --git a/src/app/docs/kagent/resources/cli/page.mdx b/src/app/docs/kagent/resources/cli/page.mdx new file mode 100644 index 0000000..cdf820d --- /dev/null +++ b/src/app/docs/kagent/resources/cli/page.mdx @@ -0,0 +1,31 @@ +--- +title: "CLI docs" +pageOrder: 1 +description: "Complete reference docs for the kagent CLI commands" +--- + +import QuickLink from '@/components/quick-link'; + +
+
+

CLI docs

+

Review the kagent CLI commands and learn how to use them effectively.

+
+ +
+ + + + + + + + + + + + + +
+
+ diff --git a/src/app/docs/kagent/resources/page.mdx b/src/app/docs/kagent/resources/page.mdx index b31fb14..c4adf90 100644 --- a/src/app/docs/kagent/resources/page.mdx +++ b/src/app/docs/kagent/resources/page.mdx @@ -19,6 +19,7 @@ import QuickLink from '@/components/quick-link';
+ diff --git a/src/app/docs/kagent/resources/release-notes/page.mdx b/src/app/docs/kagent/resources/release-notes/page.mdx index 2562f31..7072bcb 100644 --- a/src/app/docs/kagent/resources/release-notes/page.mdx +++ b/src/app/docs/kagent/resources/release-notes/page.mdx @@ -164,7 +164,7 @@ ToolServer resources that used `type: streamableHttp` are now configured as Remo url: "http://kagent-tools.kagent:8084/mcp" timeout: 30s sseReadTimeout: 5m0s - description: "Official KAgent tool server" + description: "Official kagent tool server" ```
@@ -179,7 +179,7 @@ ToolServer resources that used `type: streamableHttp` are now configured as Remo url: "http://kagent-tools.kagent:8084/mcp" timeout: 30s sseReadTimeout: 5m0s - description: "Official KAgent tool server" + description: "Official kagent tool server" ``` diff --git a/src/blogContent/community-nginx-khook-kagent.mdx b/src/blogContent/community-nginx-khook-kagent.mdx index 3ecef5a..b8fb963 100644 --- a/src/blogContent/community-nginx-khook-kagent.mdx +++ b/src/blogContent/community-nginx-khook-kagent.mdx @@ -70,7 +70,7 @@ I highly encourage you to read Maryam's comprehensive article where she walks th

- Revolutionizing Kubernetes Configuration Management with KHook and KAgent: A Comprehensive Solution for Automated Nginx Troubleshooting and Remediation + Revolutionizing Kubernetes Configuration Management with KHook and kagent: A Comprehensive Solution for Automated Nginx Troubleshooting and Remediation

diff --git a/src/components/icons/kagent-logo-text.tsx b/src/components/icons/kagent-logo-text.tsx index 94c5042..3028d78 100644 --- a/src/components/icons/kagent-logo-text.tsx +++ b/src/components/icons/kagent-logo-text.tsx @@ -2,7 +2,7 @@ import { useTheme } from "next-themes"; import { useState, useEffect } from "react"; -export default function KAgentLogoWithText({ className } : { className?: string }) { +export default function kagentLogoWithText({ className } : { className?: string }) { const { resolvedTheme } = useTheme(); const [mounted, setMounted] = useState(false); diff --git a/src/components/navbar.tsx b/src/components/navbar.tsx index 4bfe70d..e513f05 100644 --- a/src/components/navbar.tsx +++ b/src/components/navbar.tsx @@ -3,7 +3,7 @@ import Link from "next/link"; import { GITHUB_LINK } from "@/data/links"; import { useState } from "react"; import { usePathname } from "next/navigation"; -import KAgentLogoWithText from "./icons/kagent-logo-text"; +import kagentLogoWithText from "./icons/kagent-logo-text"; import KagentLogo from "./icons/kagent-logo"; import KMCPIcon from "./icons/kmcpicon"; import { ThemeToggle } from "./theme-toggle"; @@ -31,7 +31,7 @@ export default function Navbar() {
- + {/* Desktop Navigation */} @@ -222,7 +222,7 @@ export default function Navbar() { }`} > - KAgent + kagent (window.location.href = "/docs/kmcp")} diff --git a/src/config/navigation.json b/src/config/navigation.json index 341a58e..58166b6 100644 --- a/src/config/navigation.json +++ b/src/config/navigation.json @@ -91,6 +91,11 @@ "href": "/docs/kagent/supported-providers", "description": "Learn how to configure various LLM providers like OpenAI, Azure OpenAI, Anthropic, and Ollama for kagent.", "items": [ + { + "title": "Amazon Bedrock", + "href": "/docs/kagent/supported-providers/amazon-bedrock", + "description": "Use Amazon Bedrock models with kagent via the OpenAI Chat Completions API." + }, { "title": "Anthropic", "href": "/docs/kagent/supported-providers/anthropic", @@ -101,16 +106,16 @@ "href": "/docs/kagent/supported-providers/azure-openai", "description": "Learn how to configure Azure OpenAI models in kagent." }, - { - "title": "Google Vertex AI", - "href": "/docs/kagent/supported-providers/google-vertexai", - "description": "Learn how to configure Google Vertex AI models in kagent." - }, { "title": "Gemini", "href": "/docs/kagent/supported-providers/gemini", "description": "Learn how to configure Gemini models in kagent." }, + { + "title": "Google Vertex AI", + "href": "/docs/kagent/supported-providers/google-vertexai", + "description": "Learn how to configure Google Vertex AI models in kagent." + }, { "title": "Ollama", "href": "/docs/kagent/supported-providers/ollama", @@ -121,11 +126,6 @@ "href": "/docs/kagent/supported-providers/openai", "description": "Learn how to configure OpenAI models in kagent." }, - { - "title": "Amazon Bedrock", - "href": "/docs/kagent/supported-providers/amazon-bedrock", - "description": "Use Amazon Bedrock models with kagent via the OpenAI Chat Completions API." - }, { "title": "BYO OpenAI-compatible model", "href": "/docs/kagent/supported-providers/byo-openai", @@ -185,6 +185,11 @@ "href": "/docs/kagent/resources/api-ref", "description": "kagent API reference documentation" }, + { + "title": "CLI docs", + "href": "/docs/kagent/resources/cli", + "description": "Complete reference for the kagent CLI commands" + }, { "title": "Helm Chart Configuration", "href": "/docs/kagent/resources/helm", From 8afc19ea7d1ce0fee2ac2892e27ae07b0d2eff0a Mon Sep 17 00:00:00 2001 From: Art Berger Date: Tue, 28 Oct 2025 12:08:03 -0400 Subject: [PATCH 3/9] desc Signed-off-by: Art Berger --- src/config/navigation.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/config/navigation.json b/src/config/navigation.json index 58166b6..446584e 100644 --- a/src/config/navigation.json +++ b/src/config/navigation.json @@ -188,7 +188,7 @@ { "title": "CLI docs", "href": "/docs/kagent/resources/cli", - "description": "Complete reference for the kagent CLI commands" + "description": "Complete reference docs for the kagent CLI commands" }, { "title": "Helm Chart Configuration", From dcf64f9594289e4fe671c2638185e4b0c4e35793 Mon Sep 17 00:00:00 2001 From: Art Berger Date: Tue, 28 Oct 2025 12:22:12 -0400 Subject: [PATCH 4/9] revise Signed-off-by: Art Berger --- src/app/docs/kagent/resources/cli/kagent-deploy/page.mdx | 5 ++--- src/app/docs/kagent/resources/cli/kagent-init/page.mdx | 2 +- ...21\200\321\203\320\272\320\276\320\262\320\276\320\264 x" | 1 - src/app/docs/kagent/resources/cli/kagent-install/page.mdx | 2 +- src/app/docs/kagent/resources/cli/kagent-mcp/page.mdx | 2 +- src/app/docs/kagent/resources/cli/kagent-run/page.mdx | 2 +- 6 files changed, 6 insertions(+), 8 deletions(-) delete mode 100644 "src/app/docs/kagent/resources/cli/kagent-install/page.m \321\200\321\203\320\272\320\276\320\262\320\276\320\264 x" diff --git a/src/app/docs/kagent/resources/cli/kagent-deploy/page.mdx b/src/app/docs/kagent/resources/cli/kagent-deploy/page.mdx index bb227bd..9e19e13 100644 --- a/src/app/docs/kagent/resources/cli/kagent-deploy/page.mdx +++ b/src/app/docs/kagent/resources/cli/kagent-deploy/page.mdx @@ -30,12 +30,11 @@ kagent deploy [project-directory] [flags] ## About `kagent deploy` -The `kagent deploy` command deploys an agent to Kubernetes. It reads the `kagent.yaml` file from the specified project directory, creates or references a Kubernetes secret with the API key, and creates an Agent CRD. +The `kagent deploy` command deploys an agent to Kubernetes by performing the following steps: -**What the command does:** 1. Loads the agent configuration from `kagent.yaml` 2. Either creates a new secret with the provided API key or verifies an existing secret -3. Creates an Agent CRD with the appropriate configuration +3. Creates an `Agent` Custom Resource Definition (CRD) with the appropriate configuration **API Key Options:** - `--api-key`: Convenience option to create a new secret with the provided API key diff --git a/src/app/docs/kagent/resources/cli/kagent-init/page.mdx b/src/app/docs/kagent/resources/cli/kagent-init/page.mdx index b0fda6f..746f23a 100644 --- a/src/app/docs/kagent/resources/cli/kagent-init/page.mdx +++ b/src/app/docs/kagent/resources/cli/kagent-init/page.mdx @@ -32,7 +32,7 @@ kagent init [framework] [language] [agent-name] [flags] ## About `kagent init` -The `kagent init` command creates a bootstrap agent project. You can customize the root agent instructions using the `--instruction-file` flag and select a specific model using the `--model-provider` and `--model-name` flags. +The `kagent init` command creates a bootstrap agent project. Select a specific model using the `--model-provider` and `--model-name` flags. You can also customize the root agent instructions by using the `--instruction-file` flag. If no custom instruction file is provided, a default dice-rolling instruction is used. If no model is specified, the agent can be configured later. diff --git "a/src/app/docs/kagent/resources/cli/kagent-install/page.m \321\200\321\203\320\272\320\276\320\262\320\276\320\264 x" "b/src/app/docs/kagent/resources/cli/kagent-install/page.m \321\200\321\203\320\272\320\276\320\262\320\276\320\264 x" deleted file mode 100644 index 0519ecb..0000000 --- "a/src/app/docs/kagent/resources/cli/kagent-install/page.m \321\200\321\203\320\272\320\276\320\262\320\276\320\264 x" +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/src/app/docs/kagent/resources/cli/kagent-install/page.mdx b/src/app/docs/kagent/resources/cli/kagent-install/page.mdx index fc75148..6ea966e 100644 --- a/src/app/docs/kagent/resources/cli/kagent-install/page.mdx +++ b/src/app/docs/kagent/resources/cli/kagent-install/page.mdx @@ -6,7 +6,7 @@ description: "kagent install command" # `kagent install` -Install kagent on a Kubernetes cluster. +Install kagent in a Kubernetes cluster. ```bash kagent install [flags] diff --git a/src/app/docs/kagent/resources/cli/kagent-mcp/page.mdx b/src/app/docs/kagent/resources/cli/kagent-mcp/page.mdx index e0ae47d..eaf2115 100644 --- a/src/app/docs/kagent/resources/cli/kagent-mcp/page.mdx +++ b/src/app/docs/kagent/resources/cli/kagent-mcp/page.mdx @@ -6,7 +6,7 @@ description: "kagent mcp command" # `kagent mcp` -MCP (Model Context Protocol) server management commands for creating and managing Model Context Protocol servers with dynamic tool loading. +Model Context Protocol (MCP) server management commands for creating and managing MCP servers with dynamic tool loading. ```bash kagent mcp [subcommand] [flags] diff --git a/src/app/docs/kagent/resources/cli/kagent-run/page.mdx b/src/app/docs/kagent/resources/cli/kagent-run/page.mdx index cb92bed..0955155 100644 --- a/src/app/docs/kagent/resources/cli/kagent-run/page.mdx +++ b/src/app/docs/kagent/resources/cli/kagent-run/page.mdx @@ -27,7 +27,7 @@ kagent run [project-directory] [flags] ## About `kagent run` -The `kagent run` command runs an agent project locally using docker-compose and launches an interactive chat session. This allows you to test and interact with your agent before deploying it to Kubernetes. +The `kagent run` command runs an agent project locally using `docker-compose` and launches an interactive chat session. This way, you can test and interact with your agent before deploying it to a Kubernetes cluster. ## Example From 1c19ad4e36cb7bc59e1d10a79992ab23808e4094 Mon Sep 17 00:00:00 2001 From: Art Berger Date: Tue, 28 Oct 2025 12:46:27 -0400 Subject: [PATCH 5/9] relnotes page Signed-off-by: Art Berger --- .../kagent/resources/release-notes/page.mdx | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/src/app/docs/kagent/resources/release-notes/page.mdx b/src/app/docs/kagent/resources/release-notes/page.mdx index 7072bcb..a5c7957 100644 --- a/src/app/docs/kagent/resources/release-notes/page.mdx +++ b/src/app/docs/kagent/resources/release-notes/page.mdx @@ -16,6 +16,34 @@ export const metadata = { The kagent documentation shows information only for the latest release. If you run an older version, review the release notes to understand the main changes from version to version. +# v0.7 + +Review the main changes from kagent version 0.6 to v0.7, then continue reading for more detailed information. + +* kmcp is installed by default when you install kagent +* New! Develop agents locally without a Kubernetes cluster + +## kmcp is installed by default + +Now, kmcp is installed automatically with kagent, so you can use kmcp functionality out of the box. + +This change is enabled by the new default values of `kmcp.enabled=true` in both the `kagent` and `kagent-crds` Helm charts. + +### Existing kmcp installations + +If you already have kmcp installed separately, disable the kmcp installation to avoid conflicts. Set `kmcp.enabled=false` in your Helm values for both the `kagent` and `kagent-crds` charts. + +```yaml +kmcp: + enabled: false +``` + +## New! Local agent development + +Develop and test agents locally on your machine without needing a Kubernetes cluster. As part of this feature, the `kagent` CLI includes new commands to scaffold, build, run, and deploy agents. + +For more information, see the [local development](/docs/kagent/getting-started/local-development) guide. + # v0.6 Review the main changes from kagent version 0.5 to v0.6, then continue reading for more detailed information. From f3ba0fcce9fe6a7f8f52925d38520ff18ac65e54 Mon Sep 17 00:00:00 2001 From: Art Berger Date: Tue, 28 Oct 2025 16:02:52 -0400 Subject: [PATCH 6/9] add kmcp note to installation Signed-off-by: Art Berger --- src/app/docs/kagent/introduction/installation/page.mdx | 4 ++++ src/app/docs/kagent/resources/release-notes/page.mdx | 4 ++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/src/app/docs/kagent/introduction/installation/page.mdx b/src/app/docs/kagent/introduction/installation/page.mdx index 74a91e3..8dad53e 100644 --- a/src/app/docs/kagent/introduction/installation/page.mdx +++ b/src/app/docs/kagent/introduction/installation/page.mdx @@ -16,6 +16,10 @@ This guide covers ways to install and configure kagent in your Kubernetes enviro ## Installation Methods +Install kagent by using the kagent CLI or Helm. + +> Note: As of version 0.7, the [kmcp](/docs/kmcp/introduction) subproject is included by default with kagent. To use an existing kmcp installation that you already set up separately, install kagent with the `kmcp.enabled=false` flag set for both the `kagent` and `kagent-crds` charts. + ### Using kagent CLI (Recommended) 1. Set the OpenAI API key as an environment variable. diff --git a/src/app/docs/kagent/resources/release-notes/page.mdx b/src/app/docs/kagent/resources/release-notes/page.mdx index a5c7957..d8a34e9 100644 --- a/src/app/docs/kagent/resources/release-notes/page.mdx +++ b/src/app/docs/kagent/resources/release-notes/page.mdx @@ -23,7 +23,7 @@ Review the main changes from kagent version 0.6 to v0.7, then continue reading f * kmcp is installed by default when you install kagent * New! Develop agents locally without a Kubernetes cluster -## kmcp is installed by default +## kmcp installed by default Now, kmcp is installed automatically with kagent, so you can use kmcp functionality out of the box. @@ -38,7 +38,7 @@ kmcp: enabled: false ``` -## New! Local agent development +## Local agent development Develop and test agents locally on your machine without needing a Kubernetes cluster. As part of this feature, the `kagent` CLI includes new commands to scaffold, build, run, and deploy agents. From c268902421cac48e1114ca2e5be36e6b10a8b989 Mon Sep 17 00:00:00 2001 From: Art Berger Date: Tue, 28 Oct 2025 16:08:00 -0400 Subject: [PATCH 7/9] change to sample commands Signed-off-by: Art Berger --- .../kagent/resources/release-notes/page.mdx | 21 +++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/src/app/docs/kagent/resources/release-notes/page.mdx b/src/app/docs/kagent/resources/release-notes/page.mdx index d8a34e9..9a8cbbb 100644 --- a/src/app/docs/kagent/resources/release-notes/page.mdx +++ b/src/app/docs/kagent/resources/release-notes/page.mdx @@ -31,11 +31,24 @@ This change is enabled by the new default values of `kmcp.enabled=true` in both ### Existing kmcp installations -If you already have kmcp installed separately, disable the kmcp installation to avoid conflicts. Set `kmcp.enabled=false` in your Helm values for both the `kagent` and `kagent-crds` charts. +If you already have kmcp installed separately, upgrade your existing Helm releases with the `kmcp.enabled=false` flag set for both the kagent and kagent-crds charts. -```yaml -kmcp: - enabled: false +Example commands: + +`kagent-crds` Helm release: + +```bash +helm upgrade --install kagent-crds oci://ghcr.io/kagent-dev/kagent/helm/kagent-crds \ + --namespace kagent \ + --set kmcp.enabled=false +``` + +`kagent` Helm release: + +```bash +helm upgrade --install kagent oci://ghcr.io/kagent-dev/kagent/helm/kagent \ + --namespace kagent \ + --set kmcp.enabled=false ``` ## Local agent development From 435ceb1302337498785c7f214ef5a8148bfd99b1 Mon Sep 17 00:00:00 2001 From: Art Berger Date: Tue, 28 Oct 2025 16:43:09 -0400 Subject: [PATCH 8/9] add operations section uninstall, upgrade, and debug guides Signed-off-by: Art Berger --- .../kagent/introduction/installation/page.mdx | 26 +------ .../debug}/page.mdx | 15 ++-- src/app/docs/kagent/operations/page.mdx | 27 +++++++ .../docs/kagent/operations/uninstall/page.mdx | 51 +++++++++++++ .../docs/kagent/operations/upgrade/page.mdx | 76 +++++++++++++++++++ src/app/docs/kagent/resources/page.mdx | 11 ++- src/config/navigation.json | 29 +++++-- 7 files changed, 192 insertions(+), 43 deletions(-) rename src/app/docs/kagent/{resources/troubleshooting => operations/debug}/page.mdx (64%) create mode 100644 src/app/docs/kagent/operations/page.mdx create mode 100644 src/app/docs/kagent/operations/uninstall/page.mdx create mode 100644 src/app/docs/kagent/operations/upgrade/page.mdx diff --git a/src/app/docs/kagent/introduction/installation/page.mdx b/src/app/docs/kagent/introduction/installation/page.mdx index 8dad53e..6f72a9f 100644 --- a/src/app/docs/kagent/introduction/installation/page.mdx +++ b/src/app/docs/kagent/introduction/installation/page.mdx @@ -142,31 +142,7 @@ Another way to install kagent is using Helm. ## Uninstallation -To remove kagent from your cluster: - -```bash -$ kagent uninstall -``` - -```console -kagent uninstalled successfully -``` - -Or, if you used Helm: - -1. Uninstall kagent chart: - -```bash -helm uninstall kagent -n kagent -``` - -2. Optionally, remove all kagent CRDs and resources: - -```bash -helm uninstall kagent-crds -n kagent -``` - ->Note that uninstalling the `kagent-crds` chart deletes all kagent resources across all namespaces. +Refer to the [Uninstall](/docs/kagent/operations/uninstall) guide. ## Next Steps diff --git a/src/app/docs/kagent/resources/troubleshooting/page.mdx b/src/app/docs/kagent/operations/debug/page.mdx similarity index 64% rename from src/app/docs/kagent/resources/troubleshooting/page.mdx rename to src/app/docs/kagent/operations/debug/page.mdx index b511d9b..21e51b3 100644 --- a/src/app/docs/kagent/resources/troubleshooting/page.mdx +++ b/src/app/docs/kagent/operations/debug/page.mdx @@ -1,20 +1,22 @@ --- -title: "Troubleshooting" -pageOrder: 5 +title: "Debug kagent" +pageOrder: 0 description: "Find solutions to common issues and troubleshooting tips for kagent." --- export const metadata = { - title: "Troubleshooting", + title: "Debug kagent", description: "Find solutions to common issues and troubleshooting tips for kagent.", author: "kagent.dev" }; -# Troubleshooting +# Debug kagent + +Troubleshoot and debug issues with your kagent installation. ## My agent doesn't seem to be working -If your agent is not showing up even though you applied the manifest, it's likely because the agent has been rejected by the engine, this error should be reported on the status of the agent. +If your agent is not showing up even though you applied the manifest, it's likely because the agent has been rejected by the engine. This error should be reported on the status of the agent. Run the following command to get the status of the agent: @@ -31,4 +33,5 @@ kubectl logs -n kagent deployment/kagent -c controller kubectl logs -n kagent deployment/kagent -c app ``` -You can also ask for help in the [community](https://discord.gg/Fu3k65f2k3) or log an issue on [Github](https://github.com/kagent-dev/kagent). You can create a bug report using kagent CLI by running `bug-report`. Before attaching files to your bug report, make sure they don't contain any sensitive information! +You can also ask for help in the [community](https://discord.gg/Fu3k65f2k3) or log an issue on [GitHub](https://github.com/kagent-dev/kagent). You can create a bug report using the kagent CLI by running `kagent bug-report`. Before attaching files to your bug report, make sure they don't contain any sensitive information! + diff --git a/src/app/docs/kagent/operations/page.mdx b/src/app/docs/kagent/operations/page.mdx new file mode 100644 index 0000000..d5241bf --- /dev/null +++ b/src/app/docs/kagent/operations/page.mdx @@ -0,0 +1,27 @@ +--- +title: "Operations" +sectionOrder: 6 +description: "Manage your kagent installation with upgrade, uninstall, and operational tasks." +--- + +export const metadata = { + title: "Operations", + description: "Manage your kagent installation with upgrade, uninstall, and operational tasks.", + author: "kagent.dev" +}; + +import QuickLink from '@/components/quick-link'; + +
+
+

Operations

+

Manage your kagent installation across its lifecycle.

+
+ +
+ + + +
+
+ diff --git a/src/app/docs/kagent/operations/uninstall/page.mdx b/src/app/docs/kagent/operations/uninstall/page.mdx new file mode 100644 index 0000000..530c3ac --- /dev/null +++ b/src/app/docs/kagent/operations/uninstall/page.mdx @@ -0,0 +1,51 @@ +--- +title: "Uninstall kagent" +pageOrder: 2 +description: "Learn how to uninstall kagent from your Kubernetes cluster." +--- + +export const metadata = { + title: "Uninstall kagent", + description: "Learn how to uninstall kagent from your Kubernetes cluster.", + author: "kagent.dev" +}; + +Remove kagent from your Kubernetes cluster using the kagent CLI or Helm. + +> **Warning**: Uninstalling kagent deletes all kagent resources across all namespaces in your cluster, including agents, tools, and configurations. This action cannot be undone. + +## Before you begin + +- Ensure that you have administrative access to your cluster. +- Back up any agent configurations or data that you want to preserve. +- Review any agents or tools that depend on kagent before uninstalling. + +## Uninstall with the kagent CLI + +Remove kagent by using the CLI. For more options, see the [`kagent uninstall` command reference](/docs/kagent/resources/cli/kagent-uninstall). + +```bash +kagent uninstall +``` + +Example output: + +```console +kagent uninstalled successfully +``` + +## Uninstall with Helm + +To uninstall kagent using Helm, remove the Helm releases in the correct order. + +1. Uninstall the kagent chart. + + ```bash + helm uninstall kagent -n kagent + ``` + +2. Remove all kagent CRDs and resources across your cluster. + + ```bash + helm uninstall kagent-crds -n kagent + ``` \ No newline at end of file diff --git a/src/app/docs/kagent/operations/upgrade/page.mdx b/src/app/docs/kagent/operations/upgrade/page.mdx new file mode 100644 index 0000000..1978a17 --- /dev/null +++ b/src/app/docs/kagent/operations/upgrade/page.mdx @@ -0,0 +1,76 @@ +--- +title: "Upgrade kagent" +pageOrder: 1 +description: "Learn how to upgrade kagent to the latest version." +--- + +export const metadata = { + title: "Upgrade kagent", + description: "Learn how to upgrade kagent to the latest version.", + author: "kagent.dev" +}; + +Follow these steps to upgrade kagent to the latest version and keep your cluster up to date with new features and bug fixes. + +## Before you begin + +1. Save the version that you want to upgrade to in an environment variable. For available versions, refer to the [kagent releases](https://github.com/kagent-dev/kagent/releases). + + ```bash + export NEW_VERSION= + ``` + +2. Read the [release notes](/docs/kagent/resources/release-notes) for the version you are upgrading to. Pay attention to any breaking changes or deprecations that might affect your configuration. + +3. Back up your current configuration, including agent definitions and custom settings. + +## Upgrade kagent + +1. Get the Helm values file for your current kagent release. + + ```bash + helm get values kagent -n kagent -o yaml > values.yaml + ``` + +2. Compare your current Helm chart values with the version that you want to upgrade to. + + * **Show all values**: + + ```bash + helm show values oci://ghcr.io/kagent-dev/kagent/helm/kagent --version $NEW_VERSION + ``` + + * **Get a file with all values** + + ```bash + helm pull oci://ghcr.io/kagent-dev/kagent/helm/kagent --version $NEW_VERSION + tar -xvf kagent-$NEW_VERSION.tgz + open kagent/values.yaml + ``` + +3. Make any changes that you want by editing your `values.yaml` Helm values file or preparing `--set` flags for the upgrade commands. + +4. Upgrade the kagent-crds chart. + + ```bash + helm upgrade kagent-crds oci://ghcr.io/kagent-dev/kagent/helm/kagent-crds \ + --namespace kagent \ + --version $NEW_VERSION + ``` + +5. Upgrade the kagent chart. If you made changes to your values, add them with `--set` flags or `-f values.yaml`. + + ```bash + helm upgrade kagent oci://ghcr.io/kagent-dev/kagent/helm/kagent \ + --namespace kagent \ + -f values.yaml \ + --version $NEW_VERSION + ``` + +## Verify the upgrade + +After upgrading, verify that kagent is running. + +```bash +kubectl get pods -n kagent +``` diff --git a/src/app/docs/kagent/resources/page.mdx b/src/app/docs/kagent/resources/page.mdx index c4adf90..2665949 100644 --- a/src/app/docs/kagent/resources/page.mdx +++ b/src/app/docs/kagent/resources/page.mdx @@ -1,12 +1,12 @@ --- title: "Resources" -sectionOrder: 6 -description: "Find helpful resources, troubleshooting tips, and FAQs for kagent. Access guides, community links, and more." +sectionOrder: 7 +description: "Find helpful resources and FAQs for kagent. Access guides, community links, and more." --- export const metadata = { title: "Resources", - description: "Find helpful resources, troubleshooting tips, and FAQs for kagent. Access guides, community links, and more.", + description: "Find helpful resources and FAQs for kagent. Access guides, community links, and more.", author: "kagent.dev" }; @@ -15,7 +15,7 @@ import QuickLink from '@/components/quick-link';

Resources

-

Find helpful resources, troubleshooting tips, and FAQs for kagent. Access guides, community links, and more.

+

Find helpful resources and FAQs for kagent. Access guides, community links, and more.

@@ -24,10 +24,9 @@ import QuickLink from '@/components/quick-link'; -
-
\ No newline at end of file +
\ No newline at end of file diff --git a/src/config/navigation.json b/src/config/navigation.json index 446584e..0032d4a 100644 --- a/src/config/navigation.json +++ b/src/config/navigation.json @@ -175,10 +175,32 @@ } ] }, + { + "title": "Operations", + "href": "/docs/kagent/operations", + "description": "Manage your kagent installation with upgrade, uninstall, and operational tasks.", + "items": [ + { + "title": "Debug kagent", + "href": "/docs/kagent/operations/debug", + "description": "Find solutions to common issues and troubleshooting tips for kagent." + }, + { + "title": "Upgrade kagent", + "href": "/docs/kagent/operations/upgrade", + "description": "Learn how to upgrade kagent to the latest version." + }, + { + "title": "Uninstall kagent", + "href": "/docs/kagent/operations/uninstall", + "description": "Learn how to uninstall kagent from your Kubernetes cluster." + } + ] + }, { "title": "Resources", "href": "/docs/kagent/resources", - "description": "Find helpful resources, troubleshooting tips, and FAQs for kagent. Access guides, community links, and more.", + "description": "Find helpful resources and FAQs for kagent. Access guides, community links, and more.", "items": [ { "title": "API docs", @@ -204,11 +226,6 @@ "title": "Release Notes", "href": "/docs/kagent/resources/release-notes", "description": "Review the release notes for kagent." - }, - { - "title": "Troubleshooting", - "href": "/docs/kagent/resources/troubleshooting", - "description": "Find solutions to common issues and troubleshooting tips for kagent." } ] } From a4bd3b3fb0a89e5b08a9cca17725f026899e6c0a Mon Sep 17 00:00:00 2001 From: Art Berger Date: Tue, 28 Oct 2025 16:53:00 -0400 Subject: [PATCH 9/9] add note to upgrade page Signed-off-by: Art Berger --- src/app/docs/kagent/introduction/installation/page.mdx | 2 +- src/app/docs/kagent/operations/upgrade/page.mdx | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/src/app/docs/kagent/introduction/installation/page.mdx b/src/app/docs/kagent/introduction/installation/page.mdx index 6f72a9f..162c3d9 100644 --- a/src/app/docs/kagent/introduction/installation/page.mdx +++ b/src/app/docs/kagent/introduction/installation/page.mdx @@ -18,7 +18,7 @@ This guide covers ways to install and configure kagent in your Kubernetes enviro Install kagent by using the kagent CLI or Helm. -> Note: As of version 0.7, the [kmcp](/docs/kmcp/introduction) subproject is included by default with kagent. To use an existing kmcp installation that you already set up separately, install kagent with the `kmcp.enabled=false` flag set for both the `kagent` and `kagent-crds` charts. +> **Note**: As of [version 0.7](/docs/kagent/resources/release-notes#kmcp-installed-by-default), the kmcp subproject is included by default with kagent. To use an existing kmcp installation that you already set up separately, set `kmcp.enabled=false` in your `values.yaml` file or `--set` commands for both the `kagent` and `kagent-crds` charts. ### Using kagent CLI (Recommended) diff --git a/src/app/docs/kagent/operations/upgrade/page.mdx b/src/app/docs/kagent/operations/upgrade/page.mdx index 1978a17..7151b65 100644 --- a/src/app/docs/kagent/operations/upgrade/page.mdx +++ b/src/app/docs/kagent/operations/upgrade/page.mdx @@ -50,6 +50,8 @@ Follow these steps to upgrade kagent to the latest version and keep your cluster 3. Make any changes that you want by editing your `values.yaml` Helm values file or preparing `--set` flags for the upgrade commands. + > **Note**: As of [version 0.7](/docs/kagent/resources/release-notes#kmcp-installed-by-default), the kmcp subproject is included by default with kagent. To use an existing kmcp installation that you already set up separately, set `kmcp.enabled=false` in your `values.yaml` file or `--set` commands for both the `kagent` and `kagent-crds` charts. + 4. Upgrade the kagent-crds chart. ```bash