You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/user-guide/mcp-quick-start.qmd
+35-51Lines changed: 35 additions & 51 deletions
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,15 @@
1
-
# 🚀 **Pointblank MCP Server: Quick Start Guide**
2
-
3
-
## **Get Started in 5 Minutes**
4
-
5
-
Transform your data validation workflow with conversational AI in VS Code or Positron IDE!
6
-
1
+
---
2
+
title: "MCP Quick Start"
3
+
jupyter: python3
4
+
toc-expand: 2
5
+
html-table-processing: none
7
6
---
8
7
9
-
## **⚡ Instant Setup**
8
+
## Getting Started in 5 Minutes
10
9
11
-
Three simple steps to start validating data through conversation. No complex configuration required!
10
+
Transform your data validation workflow with conversational AI in VS Code or Positron IDE. Here are three simple steps to start validating data through conversation (and no complex configuration required).
> ⚠️ **Security Note**: Only add MCP servers from trusted sources. VS Code will ask you to confirm trust when starting the server for the first time.
64
63
65
-
**For Positron:**
64
+
**For Positron**:
66
65
67
66
1. Open Positron Settings
68
67
2. Navigate to MCP Server configuration
69
68
3. Add the configuration (format may vary)
70
69
71
-
> **Note:** If you don't see MCP settings, you may need to install an MCP extension first. Search for "MCP" in the Extensions marketplace.
70
+
> **Note**: If you don't see MCP settings, you may need to install an MCP extension first. Search for "MCP" in the Extensions marketplace.
72
71
73
-
### **3. Start Chatting**
72
+
### 3. Start Chatting
74
73
75
74
```
76
75
"Load my sales data and check its quality"
77
76
```
78
77
79
-
That's it! 🎉
80
-
81
-
---
78
+
That's basically how you get started.
82
79
83
-
## **💬 Essential Commands**
80
+
## Essential Commands
84
81
85
82
Master these four command patterns and you'll be able to handle most data validation scenarios. Think of these as your fundamental vocabulary for talking to Pointblank.
86
83
87
-
### **Load Data**
84
+
### Load Data
88
85
89
86
```
90
87
"Load the file /path/to/data.csv"
91
88
"Open my customer data from Downloads"
92
89
"Load the Excel file with sales metrics"
93
90
```
94
91
95
-
### **Check Quality**
92
+
### Check Quality
96
93
97
94
```
98
95
"Analyze the data quality"
99
96
"What issues should I worry about?"
100
97
"Check for missing values and duplicates"
101
98
```
102
99
103
-
### **Create Validation**
100
+
### Create Data Validations
104
101
105
102
```
106
103
"Set up validation rules for this data"
107
104
"Check that all emails are valid"
108
105
"Make sure amounts are positive"
109
106
```
110
107
111
-
### **Run & Export**
108
+
### Run and Export
112
109
113
110
```
114
111
"Run the validation"
@@ -118,11 +115,12 @@ Master these four command patterns and you'll be able to handle most data valida
118
115
119
116
---
120
117
121
-
## **🎯 Top 3 Use Cases**
118
+
## Top Three Use Cases
122
119
123
120
Once you have Pointblank set up, these scenarios show the most common and powerful ways to use natural language data validation. Each example demonstrates the conversational flow and immediate value you'll experience.
124
121
125
122
### **1. 📊 Quick Data Check**
123
+
126
124
**When:** You get a new dataset
127
125
```
128
126
👤 "I just got customer_data.csv. Is it clean?"
@@ -134,6 +132,7 @@ Once you have Pointblank set up, these scenarios show the most common and powerf
134
132
```
135
133
136
134
### **2. 🔄 Daily Validation**
135
+
137
136
**When:** Regular data quality checks
138
137
```
139
138
👤 "Run our standard sales validation"
@@ -144,6 +143,7 @@ Once you have Pointblank set up, these scenarios show the most common and powerf
144
143
```
145
144
146
145
### **3. 🚨 Issue Investigation**
146
+
147
147
**When:** Something looks wrong
148
148
```
149
149
👤 "Conversion rates jumped to 95%. That's impossible"
@@ -157,54 +157,52 @@ These examples show how natural conversation can quickly identify and resolve da
157
157
158
158
---
159
159
160
-
## **🛠️ Common Validation Rules**
160
+
## Common Validation Rules
161
161
162
162
Understanding what validation rules to ask for will help you quickly build comprehensive data quality checks. These examples cover the most frequent validation scenarios across different industries and data types.
163
163
164
-
### **Data Integrity**
164
+
### Data Integrity
165
165
166
166
- "Check for duplicate IDs"
167
167
- "Ensure no missing required fields"
168
168
- "Validate that dates are reasonable"
169
169
170
-
### **Business Logic**
170
+
### Business Logic
171
171
172
172
- "Amounts must be positive"
173
173
- "Email addresses must be valid format"
174
174
- "Status must be active, inactive, or pending"
175
175
176
-
### **Cross-Field Validation**
176
+
### Cross-Field Validation
177
177
178
178
- "End date must be after start date"
179
179
- "Discount percentage between 0 and 100"
180
180
- "Age must match birth date"
181
181
182
182
These rule patterns can be combined and customized for your specific data and business requirements. The natural language interface makes it easy to express complex validation logic without learning technical syntax.
183
183
184
-
---
185
-
186
-
## **💡 Pro Tips**
184
+
## Some Tips and Tricks
187
185
188
186
These expert recommendations will help you get maximum value from your Pointblank MCP server and avoid common pitfalls. Following these practices ensures smooth, productive validation workflows.
189
187
190
-
### **Talk Naturally**
188
+
### Talk Naturally
191
189
192
190
✅ **Good:** "Check if customer emails look valid"
193
191
❌ **Avoid:** "Execute col_vals_regex on email column"
194
192
195
-
### **Provide Context**
193
+
### Provide Context
196
194
197
195
✅ **Good:** "This is for the board presentation"
198
196
❌ **Avoid:** Just asking for validation without explanation
199
197
200
-
### **Build Incrementally**
198
+
### Build Incrementally
201
199
202
200
1. Start with data profiling
203
201
2. Add basic validation rules
204
202
3. Create templates for reuse
205
203
4. Set up automated checks
206
204
207
-
### **Save Templates**
205
+
### Save Templates
208
206
209
207
```
210
208
"Save these rules as 'customer_validation'"
@@ -214,9 +212,7 @@ These expert recommendations will help you get maximum value from your Pointblan
214
212
215
213
These practices help you build sustainable data quality workflows that scale with your organization's needs while remaining accessible to team members with varying technical backgrounds.
216
214
217
-
---
218
-
219
-
## **🔧 File Support**
215
+
## File Support
220
216
221
217
Pointblank works with all major data formats, making it easy to validate data regardless of how it's stored. This universal support means you can maintain consistent validation practices across your entire data ecosystem.
222
218
@@ -229,9 +225,7 @@ Pointblank works with all major data formats, making it easy to validate data re
229
225
230
226
The consistent natural language interface works the same regardless of file format, so you can focus on validation logic rather than technical details.
231
227
232
-
---
233
-
234
-
## **⚠️ Quick Troubleshooting**
228
+
## Quick Troubleshooting
235
229
236
230
When you encounter issues, these quick fixes resolve the most common problems. Don't worry; the natural language interface means you can always ask for help and explanations in plain English.
237
231
@@ -244,18 +238,8 @@ When you encounter issues, these quick fixes resolve the most common problems. D
244
238
245
239
Remember, you can always ask the AI to explain what's happening or suggest solutions when you run into problems.
246
240
247
-
---
248
-
249
-
## **🎉 You're Ready!**
241
+
## Now You're Ready!
250
242
251
243
You now have everything needed to start validating data through natural conversation. The beauty of Pointblank's MCP server is that it grows with your expertise: start simple and gradually build more sophisticated validation workflows as you become comfortable with the interface.
252
244
253
245
Start with simple commands and build up to more complex validation workflows. The AI will guide you through the process and help you create robust data quality checks!
254
-
255
-
### **Next Steps:**
256
-
257
-
1. Try the [detailed User Guide](mcp-server-guide.qmd)
0 commit comments