Skip to content

Commit 6231923

Browse files
authored
docs: add read-only toolset to aurora tools documentation (#2319)
1 parent 7a13f2e commit 6231923

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

apps/framework-docs/src/pages/aurora/tool-reference.mdx

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
# Tool Reference
22

3-
## Standard tools
3+
Aurora CLI can allow you to use various Aurora MCP tool-sets, as well as install and configure certain external tools.
4+
5+
The command `aurora config tools` allows you to configure the tools you want to use. These tools are additive, select the tools you wish to use (if certain tools have dependencies, they will be enabled automatically).
6+
7+
## Read tools
8+
Tools needed to read the Moose project and its associated infrastructure.
49

510
- `read_moose_project`
611
- Reads `moose.config.toml` to get configuration details about Moose project and infrastructure.
@@ -10,13 +15,17 @@
1015
- Read queries from ClickHouse.
1116
- `read_redpanda_topic`
1217
- Read from Redpanda.
18+
19+
## Egress tools
20+
Tools needed to create and test egress APIs.
21+
1322
- `create_egress_api`
1423
- Creates an egress API from Moose ClickHouse. Can utilize type safe parameters.
1524
- `test_egress_api`
1625
- Tests the specified APIs.
1726

18-
## Experimental Tools
19-
27+
## Experimental Moose tools
28+
Tools for creating and testing Moose data pipelines.
2029
> Note, these are experimental tools, if you want to use them, toggle the experimental features flag with `aurora config tools experimental`
2130
2231
- `write_spec`
@@ -39,3 +48,6 @@
3948
- `read_production_clickhouse`
4049
- Read your Boreal ClickHouse database. In this iteration, requires manually inputting certain fields into `mcp.json`: `BOREAL_CLICKHOUSE_HOST`, `BOREAL_CLICKHOUSE_PORT`, `BOREAL_CLICKHOUSE_USER`, `BOREAL_CLICKHOUSE_PASSWORD`, `BOREAL_CLICKHOUSE_DATABASE`. Whilst the tool is read only, we suggest furnishing the MCP with read-only credentials in an abundance of caution.
4150

51+
## External tools
52+
53+
- `external-duck-db-mcp` allows you to use and configure the official DuckDB MCP. This requires the path to your DuckDB file.

0 commit comments

Comments
 (0)