> ## Documentation Index
> Fetch the complete documentation index at: https://docs.conduktor.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Ask Conduktor about your Kafka platform

> Turn on Ask Conduktor, the assistant in Console that answers questions about your Kafka platform, finds pages and fills in forms for you to review.

> [!NOTE]
>
> Ask Conduktor is a preview feature, available from Console 1.49.0. It's turned off by default and, in this release, only Console administrators can use it.

Ask Conduktor is an assistant that sits beside the page you have open in Conduktor Console. Ask it a question in plain language and it looks up the answer in your own Kafka platform, in the Conduktor documentation or on the page in front of you. It can also take you to the right page and fill in a form for you to review.

![Ask open beside the home page of a cluster, with the answer to which consumer groups are lagging and two next steps](https://mintcdn.com/conduktor/j6HRTGEcs5NZ8lJ_/images/ask-panel-answer.png?fit=max\&auto=format\&n=j6HRTGEcs5NZ8lJ_\&q=85\&s=82b298d13d72784c2a3c12a03d0a48e3)

Ask uses the same model connections as [Conduktor Agents](https://docs.conduktor.io/guide/conduktor-in-production/automate/agents.md). Where an agent runs on its own, on a schedule or when something changes, Ask answers you directly, as you, while you work.

## What you can do with Ask

| To... | Ask something like | What Ask does |
| - | - | - |
| **Understand your platform** | Which consumer groups are lagging? Who consumes this topic? | Reads your clusters, topics, consumer groups, schemas, connectors and audit log with your permissions. |
| **Understand the page you're on** | What does this error mean? What changed on this topic recently? | Reads the page you have open, so "this topic" or "here" means what you're looking at. |
| **Learn how Conduktor works** | How do I reset offsets safely? What does this setting do? | Searches the Conduktor documentation and links the page it used. |
| **Get something done** | Create a topic for order events. Take me to the SSO settings. | Opens the right page, fills in the form and points at the button for you to press. |
| **Run a skill now** | Pick **Cluster summary** from the skills list. | Runs a task from the agent catalog straight away and shows the result in the chat. |

> [!WARNING]
>
> Ask's answers are produced by the AI model you connect, and are open to interpretation by that model. Check what matters before you act on it.

## Prerequisites

| Requirement | Details |
| - | - |
| **Console 1.49.0 or later** | Ask ships with Console 1.49.0. |
| **Agents set up** | Ask needs agents enabled and at least one model connection. See [Set up Conduktor Agents](https://docs.conduktor.io/guide/conduktor-in-production/automate/agents/configure.md). |
| **Ask turned on** | Set `interactive_agents.enabled` to `true`, as shown below. |
| **A Console administrator** | Only administrators can use Ask in this release. |
| **Network access to the documentation** | Optional. To answer from the Conduktor documentation, the Console server needs outbound HTTPS access to `https://docs.conduktor.io`. Without it, Ask still answers from your platform and the page. See [Ask doesn't answer from the documentation](#troubleshoot-ask). |

## Turn on Ask

Ask is a deployment setting. Set it in the Console YAML configuration file or as environment variables, then restart Console.

> [tab] YAML
>
> ```yaml theme={null}
> interactive_agents:
>   enabled: true
> ```

> [tab] Environment variable
>
> ```bash theme={null}
> CDK_INTERACTIVEAGENTS_ENABLED=true
> ```

| Property | Description | Default |
| - | - | - |
| `enabled` | Turns Ask on. It only takes effect when agents are enabled too. | `false` |
| `max_concurrent_chats` | How many questions Ask answers at the same time on each Console node. | `4` |
| `max_concurrent_chats_per_user` | How many questions one user can have in progress at the same time on each Console node. | `1` |
| `max_tool_calls_per_turn` | How many lookups and page actions Ask can make to answer one question. | `80` |
| `docs_url` | The address Console reads the Conduktor documentation from. Set it to an empty value to stop Ask using the documentation. | `https://docs.conduktor.io/mcp` |

These settings are also listed in the [Ask properties](https://docs.conduktor.io/guide/conduktor-in-production/deploy-artifacts/deploy-console/environment-variables.md#ask-properties) of the Console configuration reference.

To check the setup, sign in as an administrator. The **Ask** button appears in the top bar. If agents are disabled or Console has no model connection, Ask shows the steps that are still missing instead of a question box.

## Ask a question

**1. Open Ask**

Click **Ask** in the top bar, or press Cmd+J on macOS or Ctrl+J on Windows and Linux. Ask opens in a panel beside the page, which stays usable. The same shortcut closes it.

![The Ask panel open beside the Topics page, with suggested questions and the question box](https://mintcdn.com/conduktor/j6HRTGEcs5NZ8lJ_/images/ask-panel-empty.png?fit=max\&auto=format\&n=j6HRTGEcs5NZ8lJ_\&q=85\&s=273c83b01f2c812b1fd0fb266cf250ce)

**2. Type your question**

Ask suggests a few questions that fit the page you're on. Pick one or type your own, then press Enter or click the send button. To start a new line, press Shift+Enter.

Ask shows each step as it works: the lookups it runs in your platform, the documentation it searches and what it does on the page. Click **Stop** to end an answer early.

**3. Follow up**

Keep asking in the same chat: Ask remembers what came before. Under its newest answer, Ask may offer up to three next steps, such as a page to open, a documentation page to read or a follow-up question.

From the top of the panel you can also:

* **Open in full view** to carry on the same chat on its own page. See how to [use Ask in full view](#use-ask-in-full-view).
* Start a **New chat**.
* Open **History** to reopen one of your recent chats or to delete one.

### Check how Ask reached an answer

When Ask looks something up or works on the page, a line above the answer shows where it looked, how many steps it took and how long the answer took:

| The line says | Ask |
| - | - |
| **Looked at your cluster** | Read your Kafka platform through Console, such as your topics, consumer groups, schemas, connectors or audit log. |
| **Read the docs** | Searched the Conduktor documentation or read one of its pages. |
| **Worked on the page** | Read the page you have open, or did something on it for you. |

Click the line to see each step and how long it took, with the number of tokens the answer used. Click a step to see what Ask asked for and what came back.

![An answer from the documentation with its two steps open, the tokens it used and two next steps under the answer](https://mintcdn.com/conduktor/j6HRTGEcs5NZ8lJ_/images/ask-answer-steps.png?fit=max\&auto=format\&n=j6HRTGEcs5NZ8lJ_\&q=85\&s=129f47566e14e1fad2da7a8695ab620e)

### Add screenshots to a question

Attach, paste or drop up to four images on a question, such as a screenshot of an error or a dashboard. Ask accepts PNG, JPEG, GIF and WebP images.

### Choose the model that answers

When Console has more than one model connection, the question box shows the one that answers. Click it to pick another. Ask uses your choice from your next question and remembers it in your browser.

### Run a skill from the catalog

Skills are the tasks from the agent catalog, such as **Cluster summary**. To list them, type `/` in the question box, then keep typing to filter the list by name. In full view, you can also click **Skills**.

![The skills list above the question box after typing a slash, starting with Cluster summary](https://mintcdn.com/conduktor/j6HRTGEcs5NZ8lJ_/images/ask-skills-list.png?fit=max\&auto=format\&n=j6HRTGEcs5NZ8lJ_\&q=85\&s=b64d176fa2848a1ab70d15088093ecec)

Click a skill under **Run a skill now**, or select it with the arrow keys and press Enter. Ask runs it straight away with your permissions and shows the result in the chat. It covers the cluster of the page you're on or, when the page isn't about one cluster, every cluster you can see.

![A Cluster summary report in full view, with the Expand and Schedule it buttons under the report](https://mintcdn.com/conduktor/j6HRTGEcs5NZ8lJ_/images/ask-skill-result.png?fit=max\&auto=format\&n=j6HRTGEcs5NZ8lJ_\&q=85\&s=7227b1ef5df7bb162bf44282aeb43798)

Under the result you can click:

* **Expand** to read the result in a wider pane, with more room for its tables.
* **Schedule it** to run the same task regularly. Ask opens the form to [create an agent](https://docs.conduktor.io/guide/conduktor-in-production/automate/agents/get-started.md) with the task selected.

Ask doesn't save the result of a skill you run this way to the **Output** page of your agents.

## Use Ask in full view

Full view gives the chat the whole page, with more room for long answers and reports. To open it, click **Open in full view** at the top of the panel. The chat you have open carries on there.

![Ask in full view before a question, with the question box, three examples and the most recent chats](https://mintcdn.com/conduktor/j6HRTGEcs5NZ8lJ_/images/ask-full-view.png?fit=max\&auto=format\&n=j6HRTGEcs5NZ8lJ_\&q=85\&s=e0163f15a93e57cbb0958b1c39d982e0)

Before you ask a question, full view shows:

* Examples to start from, such as **Check cluster health**. Click one to ask it. To remove the examples, click **Hide examples**. They stay hidden in that browser.
* Your three most recent chats. Click one to reopen it.

In the top bar, use:

* **History** to reopen one of your recent chats or to delete one.
* **New chat** to start again, once you've asked a question.
* **Minimize** to go back to the page you came from, with the chat in the panel.

If an answer takes you to another page, for example when Ask opens a form for you, the chat carries on in the panel beside that page.

## Let Ask work the page for you

Ask can operate Console the way you would: go to a page, open a dialog, fill in fields and pick options. Ask it to create or change something and it prepares the form, then stops.

Ask never makes a change on its own. It has no tool that writes to Kafka or to Console, so the only way it can change anything is through the page. Every change on the page needs you to press the button:

* **Ask doesn't press buttons that apply a change**, such as **Create**, **Save**, **Delete** or **Reset**. It fills in the form, highlights the button and asks you to press it. Nothing is created, changed or deleted until you do.
* **Ask doesn't type in password fields**, or in fields that ask you to type a name to confirm. It points at them for you to fill in.

Ask marks the button with a note that says what pressing it does. Check what Ask filled in before you press the button. To hide the note, click **Dismiss**.

![The Create topic form filled in by Ask, with a note from Ask on the Create topic button](https://mintcdn.com/conduktor/j6HRTGEcs5NZ8lJ_/images/ask-fills-form.png?fit=max\&auto=format\&n=j6HRTGEcs5NZ8lJ_\&q=85\&s=8d9f46ece1632ed0bbe490190303b73d)

When you've done your part, tell Ask to continue and it picks up where it stopped.

## What Ask can see and where your data goes

Ask acts as you. Every lookup it makes is checked against your own Console permissions, and Ask can only read: it has no tools that change your Kafka resources.

To answer a question, Console sends your model provider:

* your question and the earlier messages of the chat
* the images you attached
* a description of the page you have open, including its text
* the results of the lookups Ask ran, such as topic configurations, consumer group lag or records from a topic

Console sends this to the model connection you chose, on your own account with that provider. Review what your provider does with it before you turn on Ask.

Your chats are kept in your browser, not on the Console server. Console keeps your 50 most recent chats in that browser and removes them when you sign out.

## Limits

Ask is built for short answers, so its limits are tighter than an agent run's:

* An answer is limited in how long it can take and how many lookups it can make. If Ask stops before it finishes, ask a narrower question.
* Each user can have one question in progress at a time, and each Console node answers four at once. Change both with the [settings above](#turn-on-ask).
* Each question spends from the token budget of its model connection (`max_tokens`).

## Troubleshoot Ask

**The Ask button isn't in the top bar**: `interactive_agents.enabled` isn't set on the running Console, or you aren't signed in as an administrator.

**Ask shows setup steps instead of a question box**: agents are disabled, or Console has no model connection. [Set up Conduktor Agents](https://docs.conduktor.io/guide/conduktor-in-production/automate/agents/configure.md), then restart Console.

**Ask doesn't answer from the documentation**: Ask reads the Conduktor documentation over the internet, from `https://docs.conduktor.io/mcp`. The request comes from the Console server, not from your browser. Console checks that address once, when it starts. If the check fails, Ask runs without the documentation until the next restart. It still answers from your platform and the page.

The usual causes are:

* **The Console server has no route to the internet**, for example in an air-gapped environment. Ask can't use the documentation there.
* **A firewall or an outbound proxy blocks the request.** Allow outbound HTTPS (port 443) from the Console server to `docs.conduktor.io`.
* **The documentation is turned off.** Check that `interactive_agents.docs_url` isn't set to an empty value in the Console configuration.

Once the Console server can reach the address, restart Console.

**Ask won't take a new question**: Ask answers one question at a time for each user, so you may have one in progress in another tab. The Console node may also be answering as many questions as it allows. Wait for the answer to finish or click **Stop**, then ask again.

**Ask reports a problem with the model**: check the model connection's API key and model name in your Console configuration. If they're right, your provider may be unavailable: try again later, or switch to another model connection.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.