Skip to main content
GuideServerConfigure and deploy Tabsdata servers on your machine.TutorialsConfigure data integration workflows within a running Tabsdata server.Advanced TutorialsBuild end-to-end workflows between two specific systems.API ReferenceCLI ReferenceRelease Notes
Version: 2.1.0

Tabby

Tabby is the built-in Tabsdata agent, opened from the Tabby page of the User Interface. Tabby answers questions about the resources on a Tabsdata Server and, when the Server allows it, creates and changes them on request.

Tabby
Did any execution plans fail in customer_management?
No. The 10 most recent execution plans in customer_management all finished, and each one committed 5 function runs with no errors. The three latest:
Execution planTriggered byStatusDuration
ep20260924-14salesforce/ingest_opportunitiesFinished11s
ep20260924-13salesforce/ingest_leadsFinished12s
ep20260924-12salesforce/ingest_customersFinished12s
Each plan runs the Salesforce ingest for one entity, then its bronze, silver, and gold transformers and the Snowflake load.

The UI demo includes the Tabby page. Messages cannot be sent from the demo.

Open Tabby in the UI demo

Requirements​

Tabby runs in the Server's AI agent service, on port 2459 by default, and requires an Anthropic or OpenAI API key. When no key is configured, the Server starts without the AI agent service and Tabby is unavailable.

The key is set when the instance is created, with --anthropic-key or --openai-key:

tdkserver quickstart --anthropic-key "$ANTHROPIC_API_KEY"

To add or change the key on an existing instance, download the instance's config, set api_key under ai_providers.anthropic or ai_providers.openai in aiagent.yaml, and apply the change:

tdkserver config get --with-secrets
tdkserver config put --apply
note

The MCP Server and the conversational agent both run within the same AI Agent process. Although only the conversational agent requires a valid API key, an API key must still be provided during server initialization. Otherwise, the AI Agent process will not start on port 2459.

To use the MCP Server, ensure that an API key is passed to the server during initialization. If the conversational agent is not being used, this can be a placeholder or dummy key.

Starting a chat​

Open Tabby from the side navigation, or press ⌘K from any page to ask Tabby about the page you are viewing.

A new chat offers four starting prompts:

  • Set up a data flow
  • Connect to an external system
  • Check executions health
  • Show me what Tabsdata can do

Other pages suggest prompts for what they show. A Collection page, for example, suggests listing its Functions, listing its Tables, and creating a Publisher.

Commands​

Commands are typed into the message box.

CommandDescription
/helpShow available commands
/newStart a new conversation
/clearClear the current conversation
/exportExport the conversation as Markdown
/modelsList available providers and models
/provider <name>Switch AI provider
/model <name>Switch to a specific model, by full or partial name
/healthShow agent health and status
/pop [name]Open resources from the conversation in new tabs, or one resource by name

The provider and model can also be switched from the selector above the message box.

Managing chats​

Chats are stored on the Server and can be continued later.

From a chat, you can:

  • Search the chat's messages
  • Export the chat as Markdown
  • Stop a response while it is being generated
  • Retry a response that failed

Building custom connectors​

Tabby can write a custom connector for a system that Tabsdata does not support natively. Tabby's reference includes the connector interface in tabsdatak.spi, and every connector installed on the Server, including custom ones, is part of what Tabby knows. Installing the connector remains a manual step. See Custom Connectors.

Changes to resources​

Whether Tabby can create, change, or delete resources is set by allow_writes in the Server's aiagent.yaml config.