Skip to content

Commit 3abd7cd

Browse files
even-weieven-wei
authored
Merge branch 'main' into feature/simplify-cicd-docs
2 parents bfd11ef + f55d44d commit 3abd7cd

File tree

5 files changed

+152
-2
lines changed

5 files changed

+152
-2
lines changed

‎docs/5-data-diffing/connect-to-warehouse.md‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ If you use Recce Cloud, here are the warehouse connection settings. We currently
1010

1111
- [Snowflake](#snowflake)
1212
- [Databricks](#databricks)
13+
- [BigQuery](#bigquery)
1314

1415
Others are coming in future releases
1516

@@ -52,7 +53,8 @@ For more information on setting up key pair authentication, refer to [Snowflake'
5253

5354
### Databricks
5455

55-
We only support token-based authentication.
56+
!!!info "Important"
57+
We currently only support token-based authentication.
5658

5759
| Field | Description | Examples |
5860
| ----------- | --------------------------------------------------------------------------------------------- | ----------------------------- |
@@ -61,3 +63,15 @@ We only support token-based authentication.
6163
| `catalog` | The catalog used to connect to the warehouse. This is optional if you are using Unity Catalog | `MY_CATALOG` |
6264
| `schema` | The default schema to connect to | `MY_SCHEMA` |
6365
| `token` | The Personal Access Token (PAT) to connect to Databricks | `dapiXXXXXXXXXXXXXXXXXXXXXXX` |
66+
67+
68+
### BigQuery
69+
70+
!!!info "Important"
71+
For authentication, we currently provide support for service account JSON only. More details [here](https://docs.getdbt.com/docs/core/connect-data-platform/bigquery-setup#service-account-json).
72+
73+
| Field | Description | Examples |
74+
| -------------- | ------------------------------------------------------------------------------------------ | ----------------------------- |
75+
| `project` | The GCP project to connect to | `GCP_PROJECT_ID` |
76+
| `dataset` | The default BigQuery dataset to connect to | `DBT_DATASET_NAME` |
77+
| `keyfile_json` | The [keyfile](https://docs.getdbt.com/guides/bigquery?step=7#generate-bigquery-credentials) generated from your GCP service account to connect to BigQuery | `keyfile_json: type: xxx project_id: xxx private_key_id: xxx ...` |

‎docs/5-data-diffing/mcp-server.md‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
title: MCP Server
3+
---
4+
5+
Recce exposes its tools to AI agents, enabling integration with tools like Claude Code. This allows you to interact with Recce analysis through natural language queries directly in your Claude Code sessions.
6+
7+
8+
## Installation
9+
10+
Install Recce with the MCP extra dependency:
11+
12+
```shell
13+
pip install 'recce[mcp]'
14+
```
15+
16+
## Method 1: MCP Server (Stdio)
17+
18+
Configure Recce as an MCP server with stdio transport. Claude Code will automatically launch the MCP server when you start a session.
19+
20+
1. Configure the MCP server for your dbt project:
21+
22+
```shell
23+
cd my-dbt-project/
24+
claude mcp add --scope project recce -- recce mcp-server
25+
```
26+
27+
2. Run Claude Code
28+
29+
```shell
30+
claude
31+
```
32+
33+
Verify the connection by running the `/mcp` command in Claude Code:
34+
35+
```
36+
> /mcp
37+
╭────────────────────────────────────────────────────────────╮
38+
│ Manage MCP servers │
39+
│ │
40+
│ ❯ 1. recce ✔ connected · Enter to view details │
41+
```
42+
43+
3. Ask Claude Code about your changes
44+
45+
```shell
46+
> Understand changes from Recce.
47+
```
48+
49+
## Method 2: MCP Server (SSE)
50+
51+
Alternatively, launch a standalone MCP server that Claude Code connects to via HTTP-SSE. This requires running the server in a separate terminal.
52+
53+
1. Start the standalone MCP server:
54+
55+
```shell
56+
cd my-dbt-project/
57+
recce mcp-server --sse
58+
```
59+
60+
2. In a **separate** terminal, configure the MCP server for your dbt project:
61+
62+
```shell
63+
cd my-dbt-project/
64+
claude mcp add --transport sse --scope project recce http://localhost:8000/sse
65+
```
66+
67+
3. run Claude Code:
68+
69+
```shell
70+
claude
71+
```
72+
73+
Verify the connection by running the `/mcp` command in Claude Code:
74+
75+
```
76+
> /mcp
77+
╭────────────────────────────────────────────────────────────╮
78+
│ Manage MCP servers │
79+
│ │
80+
│ ❯ 1. recce ✔ connected · Enter to view details │
81+
```
82+
83+
4. Ask Claude Code about your changes:
84+
85+
```shell
86+
> Understand changes from Recce.
87+
```

‎docs/7-cicd/pr_mr_summary.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: PR/MR Summary
3+
---
4+
Recce provides summary of each PR for you to understand the change and the impact. Recce Summary uses a template-based format, while AI Summary is dynamically generated by AI agents for more intelligent analysis.
5+
6+
7+
## Recce Summary
8+
Recce allows to generate a summary for a PR based on the updated metadata and the run result of the checklist and post the summary on your PR/MR comment
9+
10+
Recce Summary uses a template-based format and includes: lineage graph, check results, and launch URL.
11+
12+
### How to generate
13+
14+
1. **Trigger via CI Automation**: Summary is automatically generated when Recce runs in your CI workflow.
15+
16+
2. **Trigger via Recce Cloud**: In the Recce Cloud PR/MR session list, click **Execute Recce Summary** to manually generate the analysis.
17+
18+
> Note: This action is only available after the session metadata has been updated.
19+
20+
## AI Summary
21+
22+
AI Summary leverages state-of-the-art AI agents to understand your changes by analyzing your PR information and updated metadata. It proactively thinks and decides what to validate by data diffing in your data warehouse, then provides comprehensive insights to help you make informed decisions.
23+
24+
**Features**
25+
26+
- Automatically identify what to validate
27+
- Explore changes through data diffing in Recce
28+
- Generate actionable insights to guide your merge decision
29+
30+
### How to generate
31+
32+
33+
34+
1. **Trigger via Recce Cloud**: In the Recce Cloud PR/MR session list, click **Execute Recce AI Summary** to generate the analysis.
35+
36+
2. **Trigger via GitHub PR Comment (GitHub only)**: In your GitHub PR page, comment `/recce` to trigger the AI Summary generation. The Recce bot will respond with status updates.
37+
38+
![AI Summary slash command example](../assets/images/7-cicd/ai-summary-slash-command.png){: .shadow}
39+
40+
Progress Indicators:
41+
42+
- 👀 : Request received
43+
- 🚀 : Summary is generating
44+
- 👍 : Summary is generated
45+
46+
3. **Trigger via CI Automation (Coming Soon)**: AI Summary will be automatically triggered when you update PR metadata through CI.

‎docs/assets/images/7-cicd/ai-summary-slash-command.png‎

13.2 KB
Loading

‎mkdocs.yml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ nav:
7070
- 5-data-diffing/topK-diff.md
7171
- 5-data-diffing/histogram-diff.md
7272
- 5-data-diffing/query.md
73+
- 5-data-diffing/mcp-server.md
7374
- Collaborate Validation:
7475
- 6-collaboration/invitation.md
7576
- 6-collaboration/checklist.md
@@ -78,7 +79,9 @@ nav:
7879
- 7-cicd/ci-cd-getting-started.md
7980
- 7-cicd/setup-cd.md
8081
- 7-cicd/setup-ci.md
81-
- 7-cicd/scenario-dev.md
82+
- 7-cicd/pr_mr_summary.md
83+
#- 7-cicd/recce-debug.md # content outdated
84+
- 7-cicd/scenario-dev.md
8285
- 7-cicd/scenario-pr-review.md
8386
- 7-cicd/preset-checks.md
8487
- 7-cicd/best-practices-prep-env.md

0 commit comments

Comments
 (0)