Provide technical narrative for CockroachDB and AI#23124
Provide technical narrative for CockroachDB and AI#23124bsanchez-the-roach wants to merge 6 commits intomainfrom
Conversation
Files changed:
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
kannanlakshmi
left a comment
There was a problem hiding this comment.
Thanks Brandon, left some minor comments and one major comment (adding ecosystem integration as a section).
jhlodin
left a comment
There was a problem hiding this comment.
Handful of comments and suggestions. Not much to change though
|
|
||
| ### 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 docs without leaving your editor—for example, how to configure [multi-region clusters]({% link {{ page.version.version }}/multiregion-overview.md %}), [tune queries]({% link {{ page.version.version }}/performance-best-practices-overview.md %}), or set up [TLS]({% link {{ page.version.version }}/security-reference/transport-layer-security.md %}) and [RBAC]({% link {{ page.version.version }}/security-reference/authorization.md %}). |
There was a problem hiding this comment.
| 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 docs without leaving your editor—for example, how to configure [multi-region clusters]({% link {{ page.version.version }}/multiregion-overview.md %}), [tune queries]({% link {{ page.version.version }}/performance-best-practices-overview.md %}), or set up [TLS]({% link {{ page.version.version }}/security-reference/transport-layer-security.md %}) and [RBAC]({% link {{ page.version.version }}/security-reference/authorization.md %}). | |
| 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 docs without leaving your editor. For example, you can write prompts asking how to configure [multi-region clusters]({% link {{ page.version.version }}/multiregion-overview.md %}), [tune queries]({% link {{ page.version.version }}/performance-best-practices-overview.md %}), or set up [TLS]({% link {{ page.version.version }}/security-reference/transport-layer-security.md %}) and [RBAC]({% link {{ page.version.version }}/security-reference/authorization.md %}). |
There was a problem hiding this comment.
This whole "for example" is strange to me and can potentially be cut since it's just arbitrarily linking to docs that may be useful. A single example prompt that links to the page(s) with relevant content makes more sense.
| ``` | ||
| How do table statistics get refreshed in CockroachDB? | ||
| ``` |
There was a problem hiding this comment.
Following up on the above comment, this is the type of example I would expect. Should remove the above "for example" sentence and instead append a sentence like "An AI tool using the documentation MCP server can provide a response to this prompt informed by X, Y, Z pages"
| 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 and node failures do not require application-level failover. |
There was a problem hiding this comment.
| - Data is automatically replicated and rebalanced across the cluster and node failures do not require application-level failover. | |
| - Data is automatically replicated and rebalanced across CockroachDB clusters, so node failures do not require application-level failover. |
DOC-16343
The changes apply to {v26.2, v26.1, v25.4, v25.2, v24.3, v24.1}, as these are the versions to which we're backporting our AI-related docs.
Importantly, though, v24.1 does not have the
VECTORdata type, and v24.3 has theVECTORdata type but doesn't have vector indexing. So the page is modified a bit for those two versions.The overview page doesn't currently link to the CockroachDB Cloud MCP server page because that's in a separate PR.