Kagent

https://kagent.dev/docs
Admin
Kagent is an AI agent platform for Kubernetes that enables developers to create intelligent,...
Tokens:205,452
Snippets:1,601
Trust Score:8
Update:11 hours ago
Show doc for...
Tokens:
Raw
### Example output of kagent install

Source: https://kagent.dev/docs/kagent/0.x/getting-started/quickstart/

Example output shown after running 'kagent install --profile demo'.

```console
kagent installed successfully
```

--------------------------------

### Example output of kmcp install

Source: https://kagent.dev/docs/kmcp/deploy/install-controller/

Example output from running `kmcp install`. It shows the deployment process, including the version used (v0.4.0), the Helm release status, and hints for checking controller status and logs.

```sh
🚀 Deploying KMCP controller to cluster...
No version specified, using latest: v0.4.0
Release "kmcp" does not exist. Installing it now.
NAME: kmcp
LAST DEPLOYED: Wed Jul 30 18:41:01 2025
NAMESPACE: kmcp-system
STATUS: deployed
REVISION: 1
TEST SUITE: None
✅ KMCP controller deployed successfully
💡 Check controller status with: kubectl get pods -n kmcp-system
💡 View controller logs with: kubectl logs -l app.kubernetes.io/name=kmcp -n kmcp-system
```

--------------------------------

### Example output of kubectl get pods

Source: https://kagent.dev/docs/kagent/0.x/examples/skills/

Example output showing the httpbin pod running successfully.

```text
httpbin-b8b86ff46-rn7mf   1/1     Running   0   2m16s
```

--------------------------------

### Example output of kubectl get pods

Source: https://kagent.dev/docs/kagent/0.x/observability/audit-prompts/

Example output showing the collector pod running successfully.

```console
NAME                                            READY   STATUS    RESTARTS   AGE
opentelemetry-collector-audit-xxxxxxxxx-xxxxx   1/1     Running   0          30s
```

--------------------------------

### Copy example environment file

Source: https://kagent.dev/docs/kagent/0.x/examples/discord-a2a/

Copies the example environment file to .env for configuration.

```bash
cp .env.example .env
```

--------------------------------

### Create virtual environment and install dependencies

Source: https://kagent.dev/docs/kagent/0.x/examples/slack-a2a/

Creates a virtual environment, activates it, and installs dependencies using uv. If uv is not installed, it can be installed with pip install uv.

```shell
uv venv
source .venv/bin/activate
uv sync
```

--------------------------------

### Start kagent dashboard

Source: https://kagent.dev/docs/kagent/0.x/concepts/architecture/

Launches the kagent dashboard web interface. This is the simplest way to get started with kagent.

```shell
kagent dashboard
```

--------------------------------

### kagent install command usage

Source: https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-install/

Shows the basic syntax for the kagent install command. Use this to install kagent with optional flags.

```bash
kagent install [flags]
```

--------------------------------

### kagent build examples

Source: https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-build/

Examples of building an agent image with default settings, specifying a custom image, and pushing the image to a registry.

```bash
kagent build ./my-agent
kagent build ./my-agent --image ghcr.io/myorg/my-agent:v1.0.0
kagent build ./my-agent --image ghcr.io/myorg/my-agent:v1.0.0 --push
```

--------------------------------

### kagent help - List available commands

Source: https://kagent.dev/docs/kagent/0.x/getting-started/quickstart/

Run `kagent help` to see the available commands. The output lists commands such as bug-report, completion, dashboard, get, help, install, invoke, uninstall, and version.

```shell
kagent help

Available Commands:
  bug-report  Generate a bug report
  completion  Generate the autocompletion script for the specified shell
  dashboard   Open the kagent dashboard
  get         Get a kagent resource
  help        Help about any command
  install     Install kagent
  invoke      Invoke a kagent agent
  uninstall   Uninstall kagent
  version     Print the kagent version
```

--------------------------------

### kagent run example

Source: https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-run/

Example commands to run an agent project from the current directory or a specified directory.

```bash
kagent run ./my-agent
kagent run .
```

--------------------------------

### Install kmcp CLI

Source: https://kagent.dev/docs/kmcp/quickstart/

Downloads and runs the official installation script for the kmcp CLI.

```sh
curl -fsSL https://raw.githubusercontent.com/kagent-dev/kmcp/refs/heads/main/scripts/get-kmcp.sh | bash
```

--------------------------------

### Example output of kagent uninstall

Source: https://kagent.dev/docs/kagent/0.x/operations/uninstall/

Example output shown after running 'kagent uninstall'.

```console
kagent uninstalled successfully
```

--------------------------------

### Install dependencies with uv sync

Source: https://kagent.dev/docs/kagent/0.x/examples/discord-a2a/

Installs project dependencies using uv sync.

```bash
uv sync
```

--------------------------------

### kmcp build examples

Source: https://kagent.dev/docs/kmcp/reference/cli/kmcp-build/

Two example invocations: one to build from the current directory and one to build from a specific directory using the --project-dir flag.

```bash
kmcp build                              # Build Docker image from current directory
kmcp build --project-dir ./my-project   # Build Docker image from specific directory
```

--------------------------------

### Create a k8s-a2a-agent with a2aConfig

Source: https://kagent.dev/docs/kagent/0.x/examples/a2a-agents/

Applies a Kubernetes Agent CRD that defines a declarative agent named k8s-a2a-agent. The spec includes a system message, MCP server tools, and an a2aConfig section with a skill that lists example prompts. Requires kagent installed via the quick start guide.

```yaml
kubectl apply -f - <<EOF
apiVersion: kagent.dev/v1alpha2
kind: Agent
metadata:
  name: k8s-a2a-agent
  namespace: kagent
spec:
  description: An example A2A agent that knows how to use Kubernetes tools.
  type: Declarative
  declarative:
    modelConfig: default-model-config
    systemMessage: |-
        You are an expert Kubernetes agent that uses tools to help users.
    tools:
      - type: McpServer
        mcpServer:
          name: kagent-tool-server
          kind: RemoteMCPServer
          toolNames:
          - k8s_get_resources
          - k8s_get_available_api_resources
    a2aConfig:
      skills:
      - id: get-resources-skill
        name: Get Resources
        description: Get resources in the Kubernetes cluster
        inputModes:
        - text
        outputModes:
        - text
        tags:
        - k8s
        - resources
        examples:
        - "Get all resources in the Kubernetes cluster"
        - "Get the pods in the default namespace"
        - "Get the services in the istio-system namespace"
        - "Get the deployments in the istio-system namespace"
        - "Get the jobs in the istio-system namespace"
        - "Get the cronjobs in the istio-system namespace"
        - "Get the statefulsets in the istio-system namespace"
EOF
```

--------------------------------

### kagent init examples

Source: https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-init/

Provides three example invocations of `kagent init`: a basic initialization, one with a custom instruction file, and one with a specific model provider and name.

```bash
kagent init adk python dice
kagent init adk python dice --instruction-file instructions.md
kagent init adk python dice --model-provider Gemini --model-name gemini-2.0-flash
```

--------------------------------

### Install zsh completions for new sessions on macOS

Source: https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-completion-zsh/

Execute once to install the completion script for every new session on macOS. You will need to start a new shell for the setup to take effect.

```bash
kagent completion zsh > $(brew --prefix)/share/zsh/site-functions/_kagent
```

--------------------------------

### Initialize Go MCP server with kmcp init

Source: https://kagent.dev/docs/kmcp/develop/mcp-go/

Creates a scaffold for a Go MCP server in the 'my-mcp-server' directory with a sample echo tool. Follow interactive prompts to add description and author.

```sh
kmcp init go my-mcp-server --go-module-name my-mcp-server
```

--------------------------------

### Install zsh completions for new sessions on Linux

Source: https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-completion-zsh/

Execute once to install the completion script for every new session on Linux. You will need to start a new shell for the setup to take effect.

```bash
kagent completion zsh > "${fpath[1]}/_kagent"
```

--------------------------------

### Install completions for every new session on macOS

Source: https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-completion-bash/

Execute this command once to install bash completions for all new sessions on macOS. You will need to start a new shell for the setup to take effect.

```bash
kagent completion bash > $(brew --prefix)/etc/bash_completion.d/kagent
```

--------------------------------

### kmcp deploy examples

Source: https://kagent.dev/docs/kmcp/reference/cli/kmcp-deploy/

Multiple example invocations of kmcp deploy, demonstrating common options such as custom names, namespaces, dry-run, custom images, transport types, output files, and environment targeting.

```bash
kmcp deploy                          # Deploy with project name to cluster
kmcp deploy my-server                # Deploy with custom name
kmcp deploy --namespace staging      # Deploy to staging namespace
kmcp deploy --dry-run                # Generate manifest without applying to cluster
kmcp deploy --image custom:tag       # Use custom image
kmcp deploy --transport http         # Use HTTP transport
kmcp deploy --output deploy.yaml     # Save to file
kmcp deploy --file /path/to/kmcp.yaml # Use custom kmcp.yaml file
kmcp deploy --environment staging    # Target environment for deployment (e.g., staging, production)
```

--------------------------------

### Install completions for every new session on Linux

Source: https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-completion-bash/

Execute this command once to install bash completions for all new sessions on Linux. You will need to start a new shell for the setup to take effect.

```bash
kagent completion bash > /etc/bash_completion.d/kagent
```

--------------------------------

### Example output of kubectl get pods

Source: https://kagent.dev/docs/kmcp/deploy/install-controller/

Example output from `kubectl get pods -n kmcp-system`, showing the controller manager pod in Running state.

```sh
NAME                                       READY   STATUS    RESTARTS   AGE
kmcp-controller-manager-66c8764c66-8h5sl   1/1     Running   0          27h
```

--------------------------------

### Example docker-compose.yaml entry for server-everything

Source: https://kagent.dev/docs/kagent/0.x/getting-started/local-development/

Example output showing the docker-compose.yaml entry for the server-everything MCP server, including the image, build context, and exposed port.

```yaml
  server-everything:
    image: localhost:5001/myagent-server-everything:latest
    build:
      context: ./server-everything
      dockerfile: Dockerfile
    expose:
      - "3000"
```

--------------------------------

### kagent mcp build examples

Source: https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-mcp-build/

Examples of building a Docker image from the current directory and from a specific project directory using the `--project-dir` flag.

```bash
kagent mcp build                    # Build Docker image from current directory
kagent mcp build --project-dir ./my-project  # Build Docker image from specific directory
```

--------------------------------

### Initialize FastMCP project with kmcp init

Source: https://kagent.dev/docs/kmcp/develop/fastmcp-python/

Creates a scaffold for a FastMCP server in the `my-mcp-server` directory with a sample echo tool. Follow interactive prompts to optionally add a description and author.

```sh
kmcp init python my-mcp-server
```

--------------------------------

### kagent invoke example with agent and task

Source: https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-invoke/

Example of invoking the k8s-agent with a task to get all pods in the kagent namespace. This demonstrates the use of the --agent and --task flags.

```bash
kagent invoke --agent "k8s-agent" --task "Get all the pods in the kagent namespace"
```

--------------------------------

### Example project structure

Source: https://kagent.dev/docs/kmcp/develop/mcp-go/

Shows the expected directory layout of the generated MCP Go project.

```sh
my-mcp-server/
├── main.go              # Server entry point
├── go.mod               # Go module definition
├── go.sum               # Dependency checksums
├── tools/               # Tool implementations
│   ├── all_tools.go     # Tool registration
│   ├── echo.go          # Example tool
│   └── tool.go          # Tool template
├── Dockerfile           # Container definition
├── .gitignore           # Git ignore rules
├── kmcp.yaml            # Project configuration
└── README.md            # Project documentation
```

--------------------------------

### Example output: Task result JSON

Source: https://kagent.dev/docs/kagent/0.x/examples/a2a-agents/

Example JSON response from the agent after sending the task 'Get the pods in the kagent namespace'. Shows the result and artifacts sections with the pod details.

```json
{
  "jsonrpc": "2.0",
  "id": "0df6761ed3394b43a2dee2bd6572bc94",
  "result": {
    "id": "89bae00376e44ed094a2174e163da9f6",
    "sessionId": "d966626d06ab42b19bd3999e65333311",
    "status": {
      "state": "completed",
      "message": {
        "role": "agent",
        "parts": [
          {
            "type": "text",
            "text": "Processed result: There is one pod running in the \"kagent\" namespace:\n\n- Pod Name: kagent-748fb675c6-9ddsz\n- Status: Running\n- Ready Containers: 3 out of 3\n- Restarts: 0\n- Age: 31 minutes\n- Pod IP: 10.244.0.11\n- Node: kagent-control-plane\n\nLet me know if you need more details or want to perform any actions on this pod."
          }
        ]
      },
      "timestamp": "2025-05-06T22:27:31+00:00"
    },
    "artifacts": [
      {
        "name": "Task Result",
        "description": "The result of the task processing",
        "parts": [
          {
            "type": "text",
            "text": "There is one pod running in the \"kagent\" namespace:\n\n- Pod Name: kagent-748fb675c6-9ddsz\n- Status: Running\n- Ready Containers: 3 out of 3\n- Restarts: 0\n- Age: 31 minutes\n- Pod IP: 10.244.0.11\n- Node: kagent-control-plane\n\nLet me know if you need more details or want to perform any actions on this pod."
          }
        ],
        "index": 0,
        "lastChunk": true
      }
    ]
  }
}
```

--------------------------------

### Helm values for rbac.namespaces

Source: https://kagent.dev/docs/kagent/0.x/resources/release-notes/

Example Helm values showing how to set rbac.namespaces to include the install namespace and additional namespaces when upgrading from rbac.clusterScoped: false.

```yaml
rbac:
  namespaces:
    - kagent
    - team-a
    - team-b
```

--------------------------------

### Persist completions for every new fish session

Source: https://kagent.dev/docs/kagent/0.x/resources/cli/kagent-completion-fish/

Run this command once to save completions to the fish completions directory. You will need to start a new shell for this setup to take effect.

```fish
kagent completion fish > ~/.config/fish/completions/kagent.fish
```

--------------------------------

### kmcp init command syntax

Source: https://kagent.dev/docs/kmcp/reference/cli/kmcp-init/

Shows the basic usage of the kmcp init command with an optional project name and flags.

```bash
kmcp init [project-name] [flags]
```

--------------------------------

### kmcp init go [project-name] [flags]

Source: https://kagent.dev/docs/kmcp/reference/cli/kmcp-init-go/

Initializes a new Go MCP server project using the mcp-go framework. This command creates a new directory with a basic mcp-go project structure, including a go.mod file, a main.go file, and an example tool.

```APIDOC
## kmcp init go [project-name] [flags]

### Description
Initializes a new Go MCP server project using the mcp-go framework. This command creates a new directory with a basic mcp-go project structure, including a go.mod file, a main.go file, and an example tool.

### Method
CLI Command

### Endpoint
kmcp init go [project-name] [flags]

### Parameters
#### Flags
- `--go-module-name string` - The Go module name for the project (e.g., github.com/my-org/my-project)
- `-h, --help` - help for go

#### Global Flags
- `--author string` - Author name for the project
- `--description string` - Description for the project
- `--email string` - Author email for the project
- `--force` - Overwrite existing directory
- `--namespace string` - Default namespace for project resources (default "default")
- `--no-git` - Skip git initialization
- `--non-interactive` - Run in non-interactive mode
- `-v, --verbose` - verbose output

### Request Example
```bash
kmcp init go [project-name] [flags]
```

### Response
#### Success Response
Command executes successfully and creates a new directory with the project structure.

```

--------------------------------

### Launch the doc2vec process

Source: https://kagent.dev/docs/kagent/0.x/examples/documentation/

Starts the doc2vec process to crawl the documentation and populate the vector database. This may take several minutes to complete.

```bash
npm start
```

--------------------------------

### Install kagent-crewai package

Source: https://kagent.dev/docs/kagent/0.x/examples/crewai-byo/

Installs the kagent-crewai package from PyPI into your CrewAI project.

```bash
pip install kagent-crewai
```

--------------------------------

### Install kmcp controller components

Source: https://kagent.dev/docs/kmcp/deploy/install-controller/

Installs the MCPServer CRD, ClusterRole and ClusterRoleBinding for RBAC, and the kmcp controller deployment. The command `kmcp install` deploys the controller and manages the lifecycle of MCPServer resources.

```sh
kmcp install
```

--------------------------------

### Example agent response showing tool access

Source: https://kagent.dev/docs/kagent/0.x/getting-started/local-development/

Example console output showing the agent's response to a user query, demonstrating that it has access to the 'add' tool.

```console
You: what can you do?                                                                                                                   
                                                                                                                                        
Agent:                                                                                                                                  
As myagent_agent, I have several capabilities. Here are some of the things I can do:                                                    
                                                                                                                                        
1. Roll dice of different sizes: You specify the number of sides, and I can roll a die with that many sides.                            
                                                                                                                                        
2. Check if numbers are prime: After rolling a die or dice, I can check if the outcomes of the rolls are prime numbers.                 
                                                                                                                                        
3. Add numbers: I can perform addition operations as well.                                                                              
                                                                                                                                        
In order to achieve these, I employ tools to perform specific functions like roll_die, check_prime, or add. I'm here to help, so feel   
free to ask me to perform any of these tasks!                                                                                           
```

--------------------------------

### Example output: Agent card and prompt

Source: https://kagent.dev/docs/kagent/0.x/examples/a2a-agents/

Example console output showing the agent card and the prompt for user input after the CLI connects to the kagent.

```console
======= Agent Card ========
{"name":"my-a2a-agent","description":"An example A2A agent that knows how to use Kubernetes tools.","url":"http://127.0.0.1:8083/api/a2a/kagent/my-a2a-agent","version":"1","capabilities":{"streaming":false,"pushNotifications":false,"stateTransitionHistory":false},"defaultInputModes":["text"],"defaultOutputModes":["text"],"skills":[{"id":"kagent-k8s-agent","name":"Get Resources","description":"Get resources in the Kubernetes cluster","examples":["Get all resources in the Kubernetes cluster","Get the pods in the default namespace","Get the services in the istio-system namespace","Get the deployments in the istio-system namespace","Get the jobs in the istio-system namespace","Get the cronjobs in the istio-system namespace","Get the statefulsets in the istio-system namespace"],"inputModes":["text"],"outputModes":["text"]}]}
=========  starting a new task ======== 

What do you want to send to the agent? (:q or quit to exit):
```
Tokens:
Raw