Skip to content

Revise README for improved clarity and organization #12436

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
torrmal merged 3 commits into from
May 15, 2026
+34 −151
Merged

Revise README for improved clarity and organization #12436

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f6020f
Revise README for improved clarity and organization
torrmal May 15, 2026
60a2398
Update description of Minds Anton AI agent
torrmal May 15, 2026
3b383ff
Update README.md
torrmal May 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
185 changes: 34 additions & 151 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
<a name="readme-top"></a>

<p align="center">
<a href="https://github.com/mindsdb/mindsdb">
<img src="/assets/mindsdb-header-github.png" alt="Query engine for AI analytics, powering agents to answer questions across all your live data" width="100%" />
</a>
</p>


<div align="center">
<a href="https://pypi.org/project/MindsDB/" target="_blank">
Expand All @@ -18,11 +14,7 @@
</a>

<p align="center">
<a href="https://github.com/mindsdb/anton">AI-coworker</a>
·
<a href="https://mindsdb.com?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">Website</a>
·
<a href="https://docs.mindsdb.com?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">Docs</a>
<a href="https://mindshub.ai">Try it</a>
·
<a href="https://mindsdb.com/contact?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">Contact us for a demo</a>
·
Expand All @@ -32,151 +24,46 @@

---

[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/mindsdb/mindsdb)
## MINDS PLATFORM

MindsDB develops the following products:
Minds Platform is dedicated to building an open foundation for frontier Artificial Intelligence, designed for developers, businesses, and individuals seeking AI systems they can truly control, extend and deploy anywhere (VPC, on-prem or Cloud).

* [ANTON](https://github.com/mindsdb/anton) - A personal AI agent that helps you get work done. Tell it what you need in plain language and it takes it from there - sending emails, calling APIs, connecting to data sources, building dashboards, and delivering results. No setup, no plugins, no fuss.
We believe useful AI systems require two fundamental capabilities: the ability to take meaningful actions autonomously **(Action and Execution)** and the ability to retrieve the right information **(Search and Retrieval)**. Our products are designed around these two foundations:

* [Query Engine](https://docs.mindsdb.com) - The product you are looking at, is a popular query engine for semantic-search.
* [Minds Anton](https://github.com/mindsdb/anton) - **Action and Execution** self-improving AI agent that can get any type work done. Tell it what you need in plain language and it takes it from there - creating reports, organizing data, sending emails, calling APIs, building dashboards, scheduling tasks, etc.

* [Minds Query Engine](https://github.com/mindsdb/engine) - Semantic **Search and Retrieval** query engine, used to index and organize large amounts of data from hundreds of structured and unstructured datasources.

## What you can build with MindsDB Products

| CONVERSATIONAL ANALYTICS AGENTS | SEMANTIC SEARCH AGENTS |
| --- | --- |
| Get precise, data-driven answers using natural language. <br /><br /> Unify and query data across sources (MySQL, Salesforce, Shopify, etc.), without ETL. <br /><br /> <a href="https://github.com/mindsdb/anton">Try Anton</a> | Ground LLM responses in your most relevant internal knowledge. <br /><br /> Search across unstructured sources like documents, support tickets, Google Drive, and more. <br /><br /> <a href="https://www.youtube.com/watch?v=HN4fHtS4mvo">Watch video</a> |
# USE CASES

## How MindsDB - Query Engine works
<div align="center">
<a href="https://www.youtube.com/watch?v=HN4fHtS4mvo" title="Watch demo">
<img
src="/assets/mindsdb_demo.gif"
alt="MindsDB demo - answer questions in plain English from live enterprise data"
title="Click to watch the full video"
width="80%"
/>
</a>
</div>
| Use Case | Solution |
|---|---|
| Plug-and-play conversational business intelligence across databases and SaaS tools | **Anton** |
| Embeddable conversational business intelligence for applications and internal platforms | **Query Engine** |
| Semantic search across company knowledge, documents, tickets, and cloud storage | **Anton** (+ **Query Engine** to optimize speed) |
| AI coworkers that can take actions across email, APIs, dashboards, and enterprise systems | **Anton** |
| Retrieval-Augmented Generation (RAG) infrastructure for embedded enterprise AI applications | **Query Engine** |
| AI agents grounded in enterprise knowledge that can both answer questions and execute tasks | **Anton + Query Engine** |
| Federated querying and retrieval across multiple structured and unstructured data sources in SQL | **Query Engine** |
| Automated reporting, recurring workflows, and operational task execution | **Anton** |
| Internal enterprise copilots with semantic retrieval and autonomous execution capabilities | **Anton + Query Engine** |
| Enhanced Multi-source AI search and analytics without ETL pipelines | **Query Engine** |
| AI operations assistants for sales, support, finance, and engineering teams | **Anton** |
| Large scale Enterprise AI systems combining memory, retrieval, reasoning, and execution | **Anton + Query Engine** |
---

MindsDB - Query Engine follows a simple workflow: **Connect → Unify → Respond**. At the center is an SQL-compatible data language with additional constructs for searching unstructured data, managing workflows (jobs/triggers), and building agents.
# DEPLOY ANYWHERE

<table style="width:100%; border-collapse:collapse; border:none;">
<tr>
<td style="width:25%; border:none; padding:8px 16px; vertical-align:middle;">
<strong><a href="https://docs.mindsdb.com/integrations/data-overview?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">Connect</a></strong>
</td>
<td style="width:75%; border:none; padding:8px 16px; vertical-align:middle;">
<strong>Universal data access:</strong> Give your agents federated access to 200+ live data sources (Postgres, MongoDB, Slack, files, and more).
</td>
</tr>
<tr>
<td style="width:25%; border:none; padding:8px 16px; vertical-align:middle;">
<strong><a href="https://docs.mindsdb.com/mindsdb-unify?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">Unify</a></strong>
</td>
<td style="width:75%; border:none; padding:8px 16px; vertical-align:middle;">
<strong>Dynamic context engine:</strong> Fuse structured tables with vectorized data (text, PDFs, HTML) inside a Knowledge Base.
</td>
</tr>
<tr>
<td style="width:25%; border:none; padding:8px 16px; vertical-align:middle;">
<strong><a href="https://docs.mindsdb.com/mindsdb-respond?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">Respond</a></strong>
</td>
<td style="width:75%; border:none; padding:8px 16px; vertical-align:middle;">
<strong>Autonomous reasoning:</strong> Deploy agents that blend and retrieve data points across your stack to produce grounded answers.
</td>
</tr>
</table>
Minds Platform is designed for flexible deployment across:

- Cloud
- VPC
- On-Prem
- Air-Gapped Environments
- Hybrid Infrastructure

## Setup

Users can install MindsDB via <a href="https://docs.mindsdb.com/setup/self-hosted/docker?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">Docker</a>, <a href="https://docs.mindsdb.com/setup/self-hosted/docker-desktop?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">Docker Extension</a>, or <a href="https://docs.mindsdb.com/contribute/install?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">PyPI</a>.

Here is how to pull and run MindsDB via Docker:
```bash
docker run --name mindsdb_container \
-e MINDSDB_APIS=http,mysql \
-p 47334:47334 -p 47335:47335 \
mindsdb/mindsdb:latest
```

## Usage

**Follow the <a href="https://docs.mindsdb.com/quickstart-tutorial?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">quickstart guide</a> to get started with MindsDB using our demo data.**

Retrieve and analyze data from over 200 <a href="https://docs.mindsdb.com/integrations/data-overview?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">data sources</a> in one SQL dialect. For AI agents, this means faster response time, better accuracy, and lower token consumption.
```sql
--use SQL to aggregate pipeline data from Salesforce
SELECT SUM(ExpectedRevenue) AS open_pipeline
FROM salesforce.opportunities
WHERE close_date >= CURDATE()

--use the same dialect to retrieve even from a non-SQL database, like MondoDB
SELECT COUNT(*) AS negative_emails_last_30_days
FROM mongodb.support_tickets
WHERE sentiment = 'negative'
AND created_at >= CURRENT_DATE - INTERVAL '30 days';
```

Create <a href="https://docs.mindsdb.com/mindsdb_sql/sql/create/view?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">views</a> and join data even from different types of data systems.
```sql
--join MongoDB and Salesforce data
CREATE VIEW risky_renewals AS (
SELECT *
FROM mongodb.support_tickets AS reviews
JOIN salesforce.opportunities AS deals
ON reviews.customer_domain = deals.customer_domain
WHERE deals.type = "renewal"
AND reviews.sentiment = "negative"
);
```

Join vectorized and structured data inside a <a href="https://docs.mindsdb.com/mindsdb_sql/knowledge_bases/overview?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">knowledge base</a>. Combine semantic search with precise metadata criteria in a single SQL query.
```sql
--create a knowledge base for customer issues
CREATE KNOWLEDGE_BASE customers_issues
USING
storage = my_vector.db,
content_columns = ['ticket_description'];
metadata_columns = ['customer_name', 'segment', 'revenue', 'is_pending_renewal'];

--find large customers who submitted ticket related to data security topics
SELECT * FROM customers_issues
WHERE content = 'data security'
AND
is_pending_renewal = 'true'.
revenue > 1000000;
```

Use MindsDB pre-packaged <a href="https://docs.mindsdb.com/mindsdb_sql/agents/agent_syntax?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">data agents</a> and connect them with your own. See how to use MindsDB via <a href="https://docs.mindsdb.com/overview_sdks_apis?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">API or MCP</a>.
```sql
CREATE AGENT my_agent
USING
model = {
"provider": "openai",
"model_name" : "gpt-xx",
"api_key": "sk-..."
},
data = {
"knowledge_bases": ["mindsdb.customer_issues"],
"tables": ["salesforce.opportunities", "postgres.sales", "mongodb.support_tickets"]
},
prompt_template = 'my prompt template and agent guidance';
```
See MindsDB’s recommended usage of agents <a href="https://docs.mindsdb.com/mindsdb_sql/agents/agent?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">here</a> and how to automate workflows with <a href="https://docs.mindsdb.com/mindsdb_sql/sql/create/jobs?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">jobs</a>.

## 📃 Tutorials
- Enterprise Knowledge Search (<a href="https://mindsdb.com/blog/fast-track-knowledge-bases-how-to-build-semantic-ai-search-by-andriy-burkov?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">example</a>)
- Advanced Semantic Search (<a href="https://mindsdb.com/blog/blend-hybrid-retrieval-with-structured-data-using-mindsdb-knowledge-bases?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">example</a>)
- Customer Support Automation (<a href="https://mindsdb.com/blog/building-janus-an-ai-powered-customer-support-helpdesk-system-powered-by-mindsdb?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">example1</a>, <a href="https://mindsdb.com/blog/building-agentic-workflow-auto-banking-customer-service-with-mindsdb?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">example2</a>)
- Intelligent Content Discovery (<a href="https://mindsdb.com/blog/mysql-mindsdb-unlocks-intelligent-content-discovery-for-web-cms-with-knowledge-bases-and-cursor?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">example</a>)
- Financial Analysis Agents (<a href="https://mindsdb.com/blog/streamline-financial-analysis-with-mindsdb-s-knowledge-bases-and-hybrid-search?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">example</a>)
- Real-time AI-powered analytics (<a href="https://mindsdb.com/blog/mariadb-mindsdb-turns-woocommerce-data-to-insights-with-real-time-ai-analytics-for-ecommerce-teams?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">example</a>)
- Conversational Data Assistants (<a href="https://mindsdb.com/blog/unlocking-operational-intelligence-in-energy-utilities-with-mindsdb-knowledge-bases-hybrid-search?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">example</a>)
- CRM Intelligence (<a href="https://mindsdb.com/blog/unlocking-salesforce-crm-intelligence-with-mindsdb-s-ai-powered-knowledge-bases?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">example</a>)
- Compliance & Customer Intelligence (<a href="https://mindsdb.com/blog/enterprise-software-vendors-drive-compliance-customer-insights-with-mindsdb-knowledge-bases-hybrid-search?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">example</a>)
- Conversation Intelligence (<a href="https://mindsdb.com/blog/introducing-mindsdb-s-integration-with-gong-ai-analytics-on-call-data?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">example</a>)
Subscribe to our (<a href="https://mindsdb.com/blog?utm_medium=community&utm_source=github&utm_campaign=mindsdb%20repo">blog</a>) for more
Maintain full control over your infrastructure, models, permissions, and data.

## 🫴 Help and support

Expand Down Expand Up @@ -210,14 +97,10 @@ Stuck on a query? Found a bug? We’re here to help.

**Security Note:** If you find a security vulnerability, please do not open a public issue. Refer to our <a href="https://github.com/mindsdb/mindsdb/security">security policy</a> for reporting instructions.

## 🤝 Contribute to MindsDB
## 🤝 Contribute to Minds Platform

MindsDB is open source and contributions are welcome! You can submit code changes through pull requests or by opening issues to report bugs, suggest new features, or enhancements.
Minds Platform is open source and contributions are welcome! You can submit code changes through pull requests or by opening issues to report bugs, suggest new features, or enhancements.

**Ways you can help:**
- Develop a <a href="https://docs.mindsdb.com/contribute/data-handlers">database integration</a>
- Develop an <a href="https://docs.mindsdb.com/contribute/app-handlers">app integration</a>
- Identify and fix bugs

**How to contribute**

Expand Down
Loading