Aurora

Reference

Tools reference

Tool Reference

Aurora CLI can allow you to use various Aurora MCP tool-sets, as well as install and configure certain external tools. See CLI reference for more information. You can also configure the toolsets available in your Aurora MCP by manually editing your MCP.json file. See MCP.json reference for more information.

Tools are grouped by their purpose into toolsets.

Performance Tip

The fewer tools you enable, the higher performance the agent using the tool set will have, especially with respect to tool selection.

Toolsets

Read Only Moose tools

Default toolset. Public Beta.

Write Moose tools

Default toolset. Public Beta.

Experimental: Remote ClickHouse Tools

Experimental tool. Public Alpha.

Other experimental tools

Experimental tools. Research preview.

Read Only Moose tools

Tools needed to read the Moose project and its associated infrastructure.

Activate this toolset

These tools are enabled by default.

To enable them explicitly:

Run the following command:

Terminal
aurora config tools

and enable moose-read-tools. e.g.:

Terminal
? Select tools to enable (no selection defaults to moose-read-tools):  
  [x] moose-read-tools - Enable moose read tools for data inspection
  [ ] moose-write-tools - Enable moose write tools for full functionality (requires API key, auto-enables read tools)
  [ ] remote-clickhouse-tools - Enable Remote Clickhouse integration

When is this toolset useful?

Tools

read_moose_project

Retrieves an infrastructure map from the local Moose development server. Retrieves a list of all primitives in the project (e.g. Data Models, Workflows, Streaming Functions, Materialized Views, APIs), as well as their associated infrastructure (e.g. ClickHouse tables, Redpanda topics, etc.).

read_clickhouse_tables

Queries local ClickHouse.

read_redpanda_topic

Reads from local Redpanda.

check_moose_status

Checks the status of the Moose project. Useful for debugging.

Write Moose tools

Tools needed to create and test Moose primitives. These are used to ingest data, transform data and create egress patterns for data in your project.

Activate this toolset

These tools are enabled by default (except for in Claude Desktop, where these tools aren’t recommended). These tools require that the read-only-moose-tools toolset is enabled.

To enable them explicitly:

Run the following command:

Terminal
aurora config tools

and enable moose-write-tools. e.g.:

Terminal
? Select tools to enable (no selection defaults to moose-read-tools):  
  [ ] moose-read-tools - Enable moose read tools for data inspection
  [x] moose-write-tools - Enable moose write tools for full functionality (requires API key, auto-enables read tools)
  [ ] remote-clickhouse-tools - Enable Remote Clickhouse integration

Usage tips

Consider Data Flow

Consider the flow of data through your Moose project when creating new primitives. For example, if you want to create a streaming function, the write_stream_function tool will have a much better chance of success if there is a data sample, a source and a destination data model in place. See Moose Docs for best practices.

Use Testing Tools

Many of the tools have testing corollaries (and for the ones that don’t, there are general purpose tools that can allow the agent to test the created primitive, like read_moose_project, read_clickhouse_tables, read_redpanda_topic). Use those testing tools to ensure that the agent is doing what you intend it to do.

Step-by-Step Approach

Step by step prompting (e.g. “Get sample data from X API”, “Create an ingest data model”, “Create a workflow to periodically grab data from the API”, …) has a higher success rate than trying to one-shot the entire project creation flow.

When is this toolset useful?

Tools

write_spec

Generates a plan for an end to end Moose project (from ingest, through transformation and egress).

Files created:

  • Creates a .md file in the current directory with the plan.

write_and_run_temp_script

Creates and runs a temporary script, usually either for sampling or for API inspection.

Files created:

  • Creates a temporary script in the /project/.moose/aurora directory, and runs it, usually creating a sample data file in the same directory.

write_workflow

Creates a Moose Workflow, typically run on a schedule, typically used to ingest data. Moose documentation.

Files created:

  • Creates a script in the project directory with the workflow, and imports it into index.ts or main.py.

Infrastructure created:

  • Creates a Moose managed temporal script, orchestrating the workflow that was created.

run_workflow

Runs a Moose workflow. Used as part of the write_workflow flow. Moose documentation.

write_ingestion_pipeline

Creates a Moose data model, typically used to define the schema of the data in your Moose project. Moose documentation.

Files created:

  • Creates a data model in the project directory, and imports it into index.ts or main.py.

Infrastructure created:

  • Depending on the configuration, creates a ClickHouse table, a Redpanda topic, and/or an ingest API.

write_stream_function

Creates a Moose stream processing function. Runs on a per row basis as data is ingested into the stream. Moose documentation.

Files created:

  • Creates a stream function in the project directory, and imports it into index.ts or main.py.

Infrastructure created:

  • Creates a streaming function.

write_materialized_view

Creates a Moose materialized view. Moose documentation.

Files created:

  • Creates a materialized view in the project directory, and imports it into index.ts or main.py.

Infrastructure created:

  • Creates a materialized view in ClickHouse.

create_egress_api

Creates an egress API from Moose ClickHouse. Can utilize type safe parameters. Moose documentation.

Files created:

  • Creates an egress API in the project directory, and imports it into index.ts or main.py.

Infrastructure created:

  • Creates an egress API.

test_egress_api

Tests the specified APIs. Used as part of the create_egress_api flow.

Experimental: Remote ClickHouse Tools (Alpha)

Tools for reading data in your external ClickHouse database (e.g. those hosted in Boreal or ClickHouse Cloud). These are useful for iterating off a production project, for debugging production issues or for local testing of changes to production data.

Read-only credentials

For an abundance of caution, we suggest using read-only credentials for this toolset. ClickHouse documentation. If you want to modify your ClickHouse database, we suggest using Moose to do so.

Activate this toolset

These tools are not enabled by default.

To enable them explicitly:

Run the following command:

Terminal
aurora config tools

and enable remote-clickhouse-tools. e.g.:

Terminal
? Select tools to enable (no selection defaults to moose-read-tools):  
  [ ] moose-read-tools - Enable moose read tools for data inspection
  [ ] moose-write-tools - Enable moose write tools for full functionality (requires API key, auto-enables read tools)
  [x] remote-clickhouse-tools - Enable Remote Clickhouse integration

Other Experimental Tools

These tools are in research preview, let us know if you are interested in using them.

Experimental: Context management tools (Research Preview)

Tools for managing context related to your Moose project.

Useful for:

  • testing your data infrastructure against policy (e.g. data quality, data security, data governance)
  • ensuring metrics definition standardization for ad hoc queries of your data

If you are interested in using these tools, please contact us at support@moose.ai.

Experimental: External tools (Research Preview)

Tools for interacting with external data systems.

Current supported external data systems:

  • DuckDB
  • Databricks

If you are interested in using these tools, or any other external data tools, please contact us at support@moose.ai.

CLI reference

MCP.json reference