-
Notifications
You must be signed in to change notification settings - Fork 474
Provide technical narrative for CockroachDB and AI #23124
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.
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
+679
−18
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
c77202b
redrafted main AI overview page
bsanchez-the-roach 4bbdadb
fixed links
bsanchez-the-roach 5b80366
revised intro section
bsanchez-the-roach a539486
Merge branch 'main' into DOC-16343
bsanchez-the-roach e0b0a4c
removed references to vector stuff in v24.1 and v24.3
bsanchez-the-roach 80d672b
added youtube video links
bsanchez-the-roach 511d96d
made changes from Joe's feedback
bsanchez-the-roach 3662dd6
merged in cloud mcp server stuff
bsanchez-the-roach File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| --- | ||
| title: CockroachDB and AI | ||
| summary: Overview of CockroachDB's capabilities for AI applications and AI-assisted development | ||
| toc: true | ||
| docs_area: ai_tools | ||
| --- | ||
|
|
||
| CockroachDB supports AI in two primary ways: as a platform that enables AI-assisted development and administration, and as a data store for AI applications. | ||
|
|
||
| **Support for AI-assisted workflows**: CockroachDB integrates with AI development tools, including Claude Code, Cursor, and GitHub Copilot in VS Code. [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) servers provide access to CockroachDB Cloud clusters and CockroachDB documentation. The Agent Skills repository encodes operational workflows in a machine-executable format. | ||
|
|
||
| For more information, refer to [Support for AI-assisted workflows](#support-for-ai-assisted-workflows). | ||
|
|
||
| **A data store for AI applications**: CockroachDB can serve as the system of record for AI applications. It combines strongly consistent transactions, horizontal scalability, and multi-region deployments. These capabilities support storing agent state, conversation histories, and other AI-related data alongside relational data. | ||
|
|
||
| For more information, refer to [CockroachDB as a data store for AI applications](#cockroachdb-as-a-data-store-for-ai-applications). | ||
|
|
||
| ## Support for AI-assisted workflows | ||
|
|
||
| CockroachDB enables your AI development tools to work directly with CockroachDB and CockroachDB Cloud. CockroachDB provides the following functionality to support AI-assisted deployment and maintenance of clusters, and AI-assisted development of applications: | ||
|
|
||
| - Cluster-level read and write access via the [CockroachDB Cloud MCP server]({% link cockroachcloud/connect-to-the-cockroachdb-cloud-mcp-server.md %}). | ||
| - Operational workflows encoded as Agent Skills for CockroachDB. | ||
| - Command-line automation with the [`ccloud` CLI]({% link cockroachcloud/ccloud-get-started.md %}), designed to be compatible with AI agents. | ||
| - Access to the Cockroach Labs public documentation via the [CockroachDB Docs MCP server]({% link {{ page.version.version }}/docs-mcp-integration.md %}). | ||
|
|
||
| The following sections provide an overview of these tools. | ||
|
|
||
| ### CockroachDB Cloud MCP server | ||
|
|
||
| The [CockroachDB Cloud MCP server]({% link cockroachcloud/connect-to-the-cockroachdb-cloud-mcp-server.md %}) is a managed endpoint in CockroachDB Cloud that exposes a set of tools for inspecting and querying your clusters from your AI tools. These tools let your AI assistants list [databases]({% link {{ page.version.version }}/show-databases.md %}) and [tables]({% link {{ page.version.version }}/show-tables.md %}), describe [schemas]({% link {{ page.version.version }}/show-schemas.md %}) and [indexes]({% link {{ page.version.version }}/show-index.md %}), inspect cluster health and running queries, and run read-only SQL and [`EXPLAIN`]({% link {{ page.version.version }}/explain.md %}) statements. When explicitly enabled, they can also [create databases]({% link {{ page.version.version }}/create-database.md %}), [create tables]({% link {{ page.version.version }}/create-table.md %}), and [insert rows]({% link {{ page.version.version }}/insert.md %}). | ||
|
|
||
| This endpoint allows you to manage and modify a CockroachDB Cloud cluster using natural language prompts. For example, you could use the following prompt to instruct your AI tool to interface with the cluster: | ||
|
|
||
| ``` | ||
| List all of the tables in the demo_db database. | ||
| ``` | ||
|
|
||
| ### Agent Skills for CockroachDB | ||
|
|
||
| [Agent Skills for CockroachDB]({% link {{ page.version.version }}/agent-skills.md %}) are small, structured capabilities that encode CockroachDB operational expertise in a machine-executable format. These skills live in the public [cockroachdb-skills](https://github.com/cockroachlabs/cockroachdb-skills) repository and follow the [Agent Skills Specification](https://agentskills.io/specification), with defined inputs, outputs, and safety guardrails. | ||
|
|
||
| Each skill focuses on a specific task, such as auditing user privileges, triaging live SQL activity, validating production readiness, or checking backup and disaster recovery posture. Skills are organized into domains like onboarding and migrations, application development, performance and scaling, operations and lifecycle, resilience and disaster recovery, observability and diagnostics, security and governance, integrations, and cost management. | ||
|
|
||
| Your AI tools can consume these skills directly, so you can reuse the same operational workflows across different toolchains. | ||
|
|
||
| ### `ccloud` command-line interface | ||
|
|
||
| The [`ccloud` CLI]({% link cockroachcloud/ccloud-get-started.md %}) is the command-line interface for CockroachDB Cloud. You can use the `ccloud` CLI to create clusters, manage networking (for example, IP allowlists), create SQL users, retrieve connection information, and more. | ||
|
|
||
| Because `ccloud` is text-based and follows a stable command structure, it is well-suited for AI tools and automations. An AI assistant can generate or run `ccloud` commands to set up clusters, rotate credentials, or retrieve connection URLs, while you keep access mediated through the CLI and existing Cloud authentication. | ||
|
|
||
| ### CockroachDB Docs MCP server | ||
|
|
||
| The [CockroachDB Docs MCP server]({% link {{ page.version.version }}/docs-mcp-integration.md %}) exposes the published CockroachDB documentation to your MCP-compatible tools over HTTP. After you add the server configuration to your client, your AI assistant can answer questions using the official documentation without leaving your editor. For example, you could use your AI tool to ask the following: | ||
|
|
||
| ``` | ||
| How do table statistics get refreshed in CockroachDB? | ||
| ``` | ||
bsanchez-the-roach marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| An AI tool using the documentation MCP server can provide a response to this prompt informed by documentation pages such as [Cost-Based Optimizer]({% link {{ page.version.version }}/cost-based-optimizer.md %}) and [`CREATE STATISTICS`]({% link {{ page.version.version }}/create-statistics.md %}). | ||
|
|
||
| This integration only provides access to CockroachDB product documentation. It does not connect to your clusters or data. It is intended to give your AI tools reliable product information while you develop and operate CockroachDB and CockroachDB Cloud. | ||
|
|
||
| ## CockroachDB as a data store for AI applications | ||
|
|
||
| CockroachDB provides the database features needed to store and query AI-related data, including agent state, with the same transactional guarantees as your other workloads. | ||
|
|
||
| ### AI agent state and workflow coordination | ||
|
|
||
| AI agents that perform autonomous operations require durable storage for execution state, workflow metadata, and operational history. These agents must track state transitions across multi-step processes, coordinate activities between concurrent executions, and ensure that operations can be safely retried or resumed after failures. | ||
|
|
||
| CockroachDB's [transactional model]({% link {{ page.version.version }}/transactions.md %}) provides a foundation for storing agent state, execution history, and coordination metadata. [Serializable isolation]({% link {{ page.version.version }}/demo-serializable.md %}) ensures that state transitions occur correctly even when multiple agents or processes attempt concurrent updates. The database's [high availability]({% link {{ page.version.version }}/frequently-asked-questions.md %}#how-does-cockroachdb-survive-failures) design allows agents to continue operating during node or region failures without requiring external coordination services. | ||
|
|
||
| ### Scale, consistency, and governance | ||
|
|
||
| AI applications typically generate high data volumes, serve globally distributed users, and require both transactional correctness and operational durability. Conversation histories, feature tables, and agent state accumulate quickly and are accessed across regions. These characteristics make AI workloads well-suited to CockroachDB's core design: | ||
|
|
||
| - CockroachDB scales horizontally by adding nodes to increase capacity. | ||
| - Data is automatically replicated and rebalanced across the cluster, so node failures do not require application-level failover. | ||
| - [Multi-region deployments]({% link {{ page.version.version }}/multiregion-overview.md %}) place data closer to users and can enforce [data locality]({% link {{ page.version.version }}/regional-tables.md %}) or residency requirements while maintaining strong consistency. | ||
|
|
||
| CockroachDB provides [serializable transactions]({% link {{ page.version.version }}/demo-serializable.md %}) by default, ensuring that all data operations maintain consistency. | ||
|
|
||
bsanchez-the-roach marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ## See also | ||
bsanchez-the-roach marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| - [How CockroachDB's AI Assistance Boosts Developer Productivity](https://www.cockroachlabs.com/blog/cockroachdb-ai-assistance-for-developers/) | ||
| - [Agent Development with CockroachDB using the LangChain Framework](https://www.cockroachlabs.com/blog/agent-development-cockroachdb-langchain/) | ||
| - [CockroachDB Plugin for Claude Code](https://github.com/cockroachdb/claude-plugin) | ||
| - [CockroachDB Plugin for Cursor](https://github.com/cockroachdb/cursor-plugin) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.