Skip to content

Documentation: This and that #90

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
amotl merged 1 commit into from
Nov 3, 2025
Merged

Documentation: This and that #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,6 @@ It serves as a bridge between AI tools and your analytics database,
allowing you to analyze data, the cluster state, troubleshoot issues, and
perform operations using conversational prompts.

## Documentation

The project documentation is available at https://cratedb-mcp.readthedocs.io/.
It includes information on how to install and operate the package.


[development documentation]: https://cratedb-mcp.readthedocs.io/sandbox.html
[managed on GitHub]: https://github.com/crate/cratedb-mcp
Expand Down Expand Up @@ -77,6 +72,11 @@ It includes information on how to install and operate the package.



## Documentation

The project documentation is available at https://cratedb-mcp.readthedocs.io/.
It includes information on how to install and operate the package.

## Project information

### Acknowledgements
Expand Down
18 changes: 9 additions & 9 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,7 @@

:::{include} readme.md
:start-line: 1
:end-line: 79
:::

:::{note}
**Experimental:** Please note that the CrateDB MCP Server is an experimental
feature provided as-is without warranty or support guarantees. Enterprise
customers should use this feature at their own discretion.
:end-line: 74
:::

## Quickstart Guide
Expand Down Expand Up @@ -72,20 +66,26 @@ The CrateDB MCP Server provides two families of tools.
talk to a CrateDB database cluster to inquire database
and table metadata, and table content.

:Documentation server:
:Documentation inquiry:

The tools `get_cratedb_documentation_index` and `fetch_cratedb_docs`
look up guidelines specific to CrateDB topics,
to provide the most accurate information possible.
Relevant information is pulled from <https://cratedb.com/docs>, curated per
[cratedb-outline.yaml] through the [cratedb-about] package.

:Health inquiry:
:Health status:

The tool `get_cluster_health` returns cluster health information derived
from CrateDB's system tables.
:::

:::{note}
**Experimental:** Please note that the CrateDB MCP Server is an experimental
feature provided as-is without warranty or support guarantees. Enterprise
customers should use this feature at their own discretion.
:::


:::{toctree}
:caption: Handbook
Expand Down