OpenAgent
Basic

Stores

Complete field reference for the Store — the central unit of AI orchestration in OpenAgent.

Stores

A Store is the primary object in OpenAgent. It defines a complete, independent AI agent: its model, its knowledge base (Files), and its capabilities (Tools).

Every conversation in OpenAgent is scoped to a Store. By configuring different Stores, you can create multiple specialized assistants — like a "Legal Advisor" and a "Coding Helper" — on the same platform.


Basic Information

FieldDescription
NameUnique internal ID (e.g., support-bot). No spaces.
Display NameThe name users see in the Chat UI.
AvatarURL to the agent's icon.
TitleA short tagline shown under the agent's name.
Is DefaultIf true, new chats will use this Store by default.

Intelligence & Reasoning

Model Provider
The primary LLM that powers the agent's reasoning. You must select a provider configured under Providers → Model.

Child Model Providers
A list of fallback models. If the primary model fails (e.g., rate limits or downtime), OpenAgent will automatically try these models in order.

System Prompt
The most critical field. It defines the agent's persona, instructions, and constraints.
Example: "You are a customer support agent. Answer questions only based on the provided documents."


Knowledge Base (RAG)

These settings control how the agent retrieves information from your documents.

Embedding Provider
The model used to turn text into searchable vectors. All files in this Store must be embedded using the same provider.

Knowledge Count
The number of document "chunks" retrieved per user query. A higher number provides more context but can exceed the model's window. Recommended: 5.

Split Provider
Professional chunking strategies to optimize retrieval accuracy:

  • Default: Paragraph-based, ideal for general documentation.
  • Markdown: Heading-aware, preserves the structural context of technical docs.
  • QA: (Professional Choice) Specifically optimized for FAQ-style files, ensuring questions and answers stay together in a single vector.

Search Provider

  • Default: Standard vector similarity search.
  • Hierarchy: Advanced recursive retrieval; performs a high-level scan of document sections before drilling down into specific chunks. Best for massive libraries.

Tools & Automation

MCP Server
Connect an external MCP (Model Context Protocol) server to this Store. The agent will have access to all allowed tools from that server. Configure servers under Servers → Add Server.

Builtin Tools
A list of built-in tool types to enable for this Store. Options include web_search, web_browser, shell, local_file, office, web_fetch, gui, video_download, browser_use, and time. See Built-in Tools for the full reference.


Voice & Multimodal

Text-to-Speech Provider
When set, the assistant's replies are read aloud using this provider. Enable TTS Streaming to stream audio as it is generated rather than waiting for the full reply.

Speech-to-Text Provider
When set, users can send voice messages. The audio is transcribed before being passed to the model.


Memory & Context

Memory Limit
Maximum number of previous messages kept in the prompt context window. Setting this prevents context overflow on long conversations.

Hide Thinking
When enabled, chain-of-thought reasoning (from models like DeepSeek-R1 or Claude 3.7 in extended thinking mode) is hidden from users — only the final answer is shown.


Chat UI

Welcome Title / Welcome Text
Greeting shown on the empty-state chat screen before the user's first message.

Example Questions
Suggested prompts shown in the chat UI. Each entry has a Title (short label) and Text (the full question sent when clicked). Useful for onboarding users to the agent's capabilities.

Suggestion Count
Number of follow-up question suggestions to generate after each assistant reply.

Show Auto Read
Exposes an auto-read toggle in the chat UI so users can enable hands-free TTS playback.

Disable File Upload
Hides the file upload button in the chat UI, preventing users from attaching files mid-conversation.


Storage

Storage Provider
Which storage backend is used for file uploads to this Store. Defaults to the system-level storage provider. Override here if this Store needs a specific bucket or path.


Content Safety & Compliance

OpenAgent includes built-in safeguards to ensure agent responses remain within corporate or community guidelines.

Forbidden Words
A configurable list of blocked terms. If a user's query or the model's potential response contains these words, OpenAgent will intercept the request and return a standardized refusal.


Knowledge Modularity (Composition)

One of OpenAgent's most powerful architectural features is its support for Knowledge Composition.

Child Stores
Instead of creating one massive, unmanageable Store, you can link multiple specialized Stores together. When a user queries a "Master Store," OpenAgent performs a unified search across its own knowledge base and all associated Child Stores.

Example: A "Company Handbook" Store can link to a "Legal Store," an "HR Store," and a "Technical Specs Store" to provide a unified corporate brain while keeping data management decentralized.


Pro Tip: If you change the Embedding Provider for an existing Store, you must re-upload its files. Existing vectors are not compatible with different embedding models.

On this page