# kagent

> Concepts, guides, and reference docs for running declarative AI agents on Kubernetes, from install through day-two operations.

For the full site index, see [llms.txt](https://kagent.dev/docs/llms.txt).

## Introduction

- [Installing kagent](https://kagent.dev/docs/kagent/0.x/introduction/installation.md): Learn how to install kagent
- [Introducing kagent](https://kagent.dev/docs/kagent/0.x/introduction/what-is-kagent.md): Understand what kagent is and its core purpose.
- [Features](https://kagent.dev/docs/kagent/0.x/introduction/features.md): A complete overview of kagent platform capabilities.

## Getting Started

- [Quick Start](https://kagent.dev/docs/kagent/0.x/getting-started/quickstart.md): A quick guide to get kagent installed and running with your first AI agent.
- [Creating your first agent](https://kagent.dev/docs/kagent/0.x/getting-started/first-agent.md): Create an agent in the kagent dashboard, attach tools to it, then test it from the chat interface.
- [Adding MCP Tools to Your First kagent Agent](https://kagent.dev/docs/kagent/0.x/getting-started/first-mcp-tool.md): Learn how to add an MCP (Model Context Protocol) tool to your kagent agent.
- [Local development with kagent CLI](https://kagent.dev/docs/kagent/0.x/getting-started/local-development.md): Build, test and run agents locally.
- [System Prompts](https://kagent.dev/docs/kagent/0.x/getting-started/system-prompts.md): Learn the art and science of writing effective system prompts for your kagent agents.

## Core Concepts

- [kagent Architecture](https://kagent.dev/docs/kagent/0.x/concepts/architecture.md): Explore the high-level architecture of kagent, including its core components like the Controller, App/Engine, CLI, and Dashboard.
- [Agents](https://kagent.dev/docs/kagent/0.x/concepts/agents.md): Dive into the concept of AI agents in kagent, their components (instructions, tools, skills), and how they can even use other agents as tools.
- [Tools](https://kagent.dev/docs/kagent/0.x/concepts/tools.md): Understand the different types of tools kagent can use, including built-in, MCP, and HTTP tools, and how tool discovery works.
- [Agent Harness](https://kagent.dev/docs/kagent/0.x/concepts/agent-harness.md): Understand AgentHarness resources, Substrate-backed execution environments, and how kagent talks to them over the Agent Client Protocol (ACP).
- [Agent Substrate](https://kagent.dev/docs/kagent/0.x/concepts/agent-substrate.md): Run declarative agents on Agent Substrate — a Kubernetes-native runtime that delivers fast startup, efficient resource usage, and secure sandboxed execution.
- [Agent Memory](https://kagent.dev/docs/kagent/0.x/concepts/agent-memory.md): Enable vector-backed long-term memory for agents to learn from past interactions.
- [MCP Apps](https://kagent.dev/docs/kagent/0.x/concepts/mcp-apps.md): Render interactive MCP UI widgets (MCP Apps) inline in the kagent chat and test them from the dashboard.

## Supported Providers

- [Amazon Bedrock](https://kagent.dev/docs/kagent/0.x/supported-providers/amazon-bedrock.md): ModelConfig examples for both Bedrock access paths, including the IAM credentials each one needs and when to prefer the native provider.
- [Anthropic](https://kagent.dev/docs/kagent/0.x/supported-providers/anthropic.md): Learn how to configure Anthropic models for kagent.
- [Azure AI Foundry](https://kagent.dev/docs/kagent/0.x/supported-providers/azure-ai-foundry.md): Learn how to configure Azure AI Foundry models in kagent.
- [Azure OpenAI](https://kagent.dev/docs/kagent/0.x/supported-providers/azure-openai.md): Learn how to configure Azure OpenAI models in kagent.
- [Gemini](https://kagent.dev/docs/kagent/0.x/supported-providers/gemini.md): Learn how to configure Gemini models in kagent.
- [Google Vertex AI](https://kagent.dev/docs/kagent/0.x/supported-providers/google-vertexai.md): Learn how to configure Google Vertex AI models in kagent.
- [Ollama](https://kagent.dev/docs/kagent/0.x/supported-providers/ollama.md): Learn how to configure Ollama models in kagent.
- [OpenAI](https://kagent.dev/docs/kagent/0.x/supported-providers/openai.md): Learn how to configure OpenAI models in kagent.
- [BYO OpenAI-compatible model](https://kagent.dev/docs/kagent/0.x/supported-providers/byo-openai.md): Bring your own OpenAI-compatible model to kagent.
- [Agentgateway](https://kagent.dev/docs/kagent/0.x/supported-providers/byo-agentgateway.md): Configure an agentgateway deployment as a model endpoint for kagent.
- [xAI (Grok)](https://kagent.dev/docs/kagent/0.x/supported-providers/xai.md): Learn how to configure xAI Grok models for kagent.
- [SAP AI Core](https://kagent.dev/docs/kagent/0.x/supported-providers/sap-ai-core.md): Learn how to configure SAP AI Core models for kagent.

## Examples

- [Exposing agents through A2A protocol](https://kagent.dev/docs/kagent/0.x/examples/a2a-agents.md): Discover how to implement Agent-to-Agent (A2A) communication and collaboration with kagent.
- [Using agentgateway with kagent](https://kagent.dev/docs/kagent/0.x/examples/agentgateway.md): Add governance to your kagent deployment with agentgateway
- [Bringing your own ADK agent to kagent](https://kagent.dev/docs/kagent/0.x/examples/a2a-byo.md): Bring your own ADK agent to kagent
- [Bringing your own CrewAI agent to kagent](https://kagent.dev/docs/kagent/0.x/examples/crewai-byo.md): Bring your own CrewAI agent to kagent
- [Bringing your own LangGraph agent to kagent](https://kagent.dev/docs/kagent/0.x/examples/langchain-byo.md): Wire a LangGraph agent into kagent with the kagentCheckpointer, register it as a BYO Agent resource, and invoke it over A2A.
- [Using kagent agents via MCP](https://kagent.dev/docs/kagent/0.x/examples/agents-mcp.md): Connect external clients like Cursor and Claude to interact with kagent agents using the Model Context Protocol.
- [Creating an agent leveraging documentation](https://kagent.dev/docs/kagent/0.x/examples/documentation.md): See an example of a kagent agent built to help with documentation-related tasks.
- [Integrating kagent with Slack](https://kagent.dev/docs/kagent/0.x/examples/slack-a2a.md): Learn how to create a Slack bot that interacts with kagent via A2A
- [Integrating kagent with Discord](https://kagent.dev/docs/kagent/0.x/examples/discord-a2a.md): Learn how to create a Discord bot that interacts with kagent via A2A
- [Talk to Your Kubernetes Cluster from Telegram](https://kagent.dev/docs/kagent/0.x/examples/telegram-bot.md): Build a Telegram bot that talks to your Kubernetes cluster through kagent and A2A
- [Add skills to agents](https://kagent.dev/docs/kagent/0.x/examples/skills.md): Learn how to add skills to your agents to guide their behavior and tool usage.
- [Human-in-the-Loop with kagent](https://kagent.dev/docs/kagent/0.x/examples/human-in-the-loop.md): Build a Kubernetes-native AI agent that pauses and asks for your approval before taking destructive actions.
- [Agent Harness](https://kagent.dev/docs/kagent/0.x/examples/agent-harness.md): Provision OpenClaw and Hermes sandboxes on Agent Substrate with the AgentHarness API.
- [Agent Substrate](https://kagent.dev/docs/kagent/0.x/examples/agent-substrate.md): Run a declarative agent on Agent Substrate — a Kubernetes-native runtime that snapshots idle agents and rehydrates them inside gVisor sandboxes.

## Observability

- [Audit kagent prompts](https://kagent.dev/docs/kagent/0.x/observability/audit-prompts.md): Review and audit prompts used by kagent agents.
- [Tracing](https://kagent.dev/docs/kagent/0.x/observability/tracing.md): Install Jaeger, turn on OpenTelemetry tracing in the kagent Helm release, then inspect a trace for a single agent request.
- [Launch the UI](https://kagent.dev/docs/kagent/0.x/observability/launch-ui.md): Open the kagent dashboard using the CLI or port-forwarding.

## Operations

- [Operational considerations](https://kagent.dev/docs/kagent/0.x/operations/operational-considerations.md): Important operational considerations when running kagent in production.
- [Upgrade kagent](https://kagent.dev/docs/kagent/0.x/operations/upgrade.md): Upgrade a kagent release with Helm, verify the new version is running, and roll back if the upgrade goes wrong.
- [Uninstall kagent](https://kagent.dev/docs/kagent/0.x/operations/uninstall.md): Uninstall kagent and, as a separate step, remove the kagent CRDs. Both actions delete agent resources across every namespace and cannot be undone.
- [Debug kagent](https://kagent.dev/docs/kagent/0.x/operations/debug.md): Find solutions to common issues and troubleshooting tips for kagent.

## Resources

- [API Reference](https://kagent.dev/docs/kagent/0.x/resources/api-ref.md): kagent API reference documentation
- [kagent](https://kagent.dev/docs/kagent/0.x/resources/helm.md): kagent Helm chart configuration reference
- [Tools Ecosystem](https://kagent.dev/docs/kagent/0.x/resources/tools-ecosystem.md): Explore the built-in MCP tools for Kubernetes, Helm, Istio, Prometheus, Grafana, Cilium, and Argo Rollouts.
- [Version Support](https://kagent.dev/docs/kagent/0.x/resources/versions.md): Which Kubernetes version kagent is tested against.
- [Frequently Asked Questions](https://kagent.dev/docs/kagent/0.x/resources/faq.md): Find answers to frequently asked questions about kagent.
- [Release Notes](https://kagent.dev/docs/kagent/0.x/resources/release-notes.md): Review the release notes for kagent.
- [Community and Contributing](https://kagent.dev/docs/kagent/0.x/resources/community.md): Connect with the kagent community, browse the source, and find out how to contribute.

### CLI docs

- [kagent add-mcp](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-add-mcp.md): Add an MCP server entry to kagent.yaml.
- [kagent bug-report](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-bug-report.md): Generate a bug report.
- [kagent build](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-build.md): Build a Docker images for an agent project.
- [kagent completion](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-completion.md): Generate the autocompletion script for the specified shell.
- [kagent completion bash](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-completion-bash.md): Generate the autocompletion script for bash.
- [kagent completion fish](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-completion-fish.md): Generate the autocompletion script for fish.
- [kagent completion powershell](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-completion-powershell.md): Generate the autocompletion script for powershell.
- [kagent completion zsh](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-completion-zsh.md): Generate the autocompletion script for zsh.
- [kagent dashboard](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-dashboard.md): Open the kagent dashboard.
- [kagent db](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-db.md): Database operations (migrations, inspection).
- [kagent db migrate](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-db-migrate.md): Apply, roll back, and inspect database migrations.
- [kagent db migrate down](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-db-migrate-down.md): Roll back the N most-recent applied migrations for the selected source.
- [kagent db migrate force](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-db-migrate-force.md): Mark version V as applied without running its SQL.
- [kagent db migrate goto](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-db-migrate-goto.md): Move the selected source's schema to version V.
- [kagent db migrate status](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-db-migrate-status.md): Show how many migrations are applied vs pending across all sources.
- [kagent db migrate up](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-db-migrate-up.md): Apply all pending migrations across every registered source.
- [kagent db migrate version](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-db-migrate-version.md): Print the highest applied migration version.
- [kagent deploy](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-deploy.md): Deploy an agent to Kubernetes.
- [kagent get](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-get.md): Get a kagent resource.
- [kagent get agent](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-get-agent.md): Get an agent or list all agents.
- [kagent get session](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-get-session.md): Get a session or list all sessions.
- [kagent get tool](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-get-tool.md): Get tools.
- [kagent init](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-init.md): Initialize a new agent project.
- [kagent install](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-install.md): Install kagent.
- [kagent invoke](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-invoke.md): Invoke a kagent agent.
- [kagent mcp](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-mcp.md): MCP (Model Context Protocol) server management.
- [kagent mcp add-tool](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-mcp-add-tool.md): Add a new MCP tool to your project.
- [kagent mcp build](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-mcp-build.md): Build MCP server as a Docker image.
- [kagent mcp deploy](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-mcp-deploy.md): Deploy MCP server to Kubernetes.
- [kagent mcp deploy package](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-mcp-deploy-package.md): Deploy an MCP server using a package manager (npx, uvx).
- [kagent mcp init](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-mcp-init.md): Initialize a new MCP server project.
- [kagent mcp init go](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-mcp-init-go.md): Initialize a new Go MCP server project.
- [kagent mcp init java](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-mcp-init-java.md): Initialize a new Java MCP server project.
- [kagent mcp init python](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-mcp-init-python.md): Initialize a new Python MCP server project.
- [kagent mcp init typescript](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-mcp-init-typescript.md): Initialize a new TypeScript MCP server project.
- [kagent mcp run](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-mcp-run.md): Run MCP server locally.
- [kagent mcp secrets](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-mcp-secrets.md): Manage project secrets.
- [kagent mcp secrets sync](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-mcp-secrets-sync.md): Sync secrets to a Kubernetes environment from a local .env file.
- [kagent run](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-run.md): Run agent project locally with docker-compose and launch chat interface.
- [kagent uninstall](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-uninstall.md): Uninstall kagent.
- [kagent version](https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-version.md): Print the kagent version.