Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
265 changes: 178 additions & 87 deletions public/sitemap.xml

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion src/app/docs/kagent/examples/crewai-byo/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion src/app/docs/kagent/examples/langchain-byo/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
30 changes: 5 additions & 25 deletions src/app/docs/kagent/introduction/installation/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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](/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)

1. Set the OpenAI API key as an environment variable.
Expand Down Expand Up @@ -138,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

Expand Down
Original file line number Diff line number Diff line change
@@ -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:

Expand All @@ -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!

27 changes: 27 additions & 0 deletions src/app/docs/kagent/operations/page.mdx
Original file line number Diff line number Diff line change
@@ -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';

<div className="max-w-3xl mx-auto">
<div className="text-center mb-12">
<h1 className="text-4xl font-bold mb-4">Operations</h1>
<p className="text-xl text-gray-400 mb-8">Manage your kagent installation across its lifecycle.</p>
</div>

<div className="grid grid-cols-1 md:grid-cols-2 gap-6 mb-12">
<QuickLink title="Debug kagent" description="Troubleshoot and debug issues with your kagent installation." href="/docs/kagent/operations/debug" />
<QuickLink title="Upgrade kagent" description="Keep your kagent installation up to date with the latest features and bug fixes." href="/docs/kagent/operations/upgrade" />
<QuickLink title="Uninstall kagent" description="Remove kagent from your cluster when you no longer need it." href="/docs/kagent/operations/uninstall" />
</div>
</div>

51 changes: 51 additions & 0 deletions src/app/docs/kagent/operations/uninstall/page.mdx
Original file line number Diff line number Diff line change
@@ -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
```
78 changes: 78 additions & 0 deletions src/app/docs/kagent/operations/upgrade/page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
---
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=<version-number>
```

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.

> **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
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
```
59 changes: 59 additions & 0 deletions src/app/docs/kagent/resources/cli/kagent-add-mcp/page.mdx
Original file line number Diff line number Diff line change
@@ -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
```

38 changes: 38 additions & 0 deletions src/app/docs/kagent/resources/cli/kagent-bug-report/page.mdx
Original file line number Diff line number Diff line change
@@ -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
```

Loading