Skip to content

Commit 16152e0

Browse files
committed
Remove MCP server guide and update quick start docs
1 parent 92c1a01 commit 16152e0

File tree

3 files changed

+35
-835
lines changed

3 files changed

+35
-835
lines changed

docs/_quarto.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,6 @@ website:
101101
- section: "MCP Server"
102102
contents:
103103
- user-guide/mcp-quick-start.qmd
104-
- user-guide/mcp-server-guide.qmd
105104

106105
page-footer:
107106
left: 'Proudly supported by <a href="https://www.posit.co/" class="no-icon"><img src="/assets/posit-logo-black.svg" alt="Posit" width="80" style="padding-left: 3px;vertical-align:text-top;"></a>'

docs/user-guide/mcp-quick-start.qmd

Lines changed: 35 additions & 51 deletions
Original file line numberDiff line numberDiff 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
76
---
87

9-
## **⚡ Instant Setup**
8+
## Getting Started in 5 Minutes
109

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).
1211

13-
### **1. Install**
12+
### 1. Install
1413

1514
```bash
1615
pip install pointblank[mcp,pd,excel]
@@ -35,9 +34,9 @@ pip install pointblank[mcp,pd,pl]
3534
pip install pointblank[mcp,pd,pl,excel]
3635
```
3736

38-
### **2. Configure Your IDE**
37+
### 2. Configure Your IDE
3938

40-
**For VS Code:**
39+
**For VS Code**:
4140

4241
**Option 1: Workspace Configuration (Recommended for teams)**
4342

@@ -62,53 +61,51 @@ pip install pointblank[mcp,pd,pl,excel]
6261

6362
> ⚠️ **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.
6463
65-
**For Positron:**
64+
**For Positron**:
6665

6766
1. Open Positron Settings
6867
2. Navigate to MCP Server configuration
6968
3. Add the configuration (format may vary)
7069

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.
7271
73-
### **3. Start Chatting**
72+
### 3. Start Chatting
7473

7574
```
7675
"Load my sales data and check its quality"
7776
```
7877

79-
That's it! 🎉
80-
81-
---
78+
That's basically how you get started.
8279

83-
## **💬 Essential Commands**
80+
## Essential Commands
8481

8582
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.
8683

87-
### **Load Data**
84+
### Load Data
8885

8986
```
9087
"Load the file /path/to/data.csv"
9188
"Open my customer data from Downloads"
9289
"Load the Excel file with sales metrics"
9390
```
9491

95-
### **Check Quality**
92+
### Check Quality
9693

9794
```
9895
"Analyze the data quality"
9996
"What issues should I worry about?"
10097
"Check for missing values and duplicates"
10198
```
10299

103-
### **Create Validation**
100+
### Create Data Validations
104101

105102
```
106103
"Set up validation rules for this data"
107104
"Check that all emails are valid"
108105
"Make sure amounts are positive"
109106
```
110107

111-
### **Run & Export**
108+
### Run and Export
112109

113110
```
114111
"Run the validation"
@@ -118,11 +115,12 @@ Master these four command patterns and you'll be able to handle most data valida
118115

119116
---
120117

121-
## **🎯 Top 3 Use Cases**
118+
## Top Three Use Cases
122119

123120
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.
124121

125122
### **1. 📊 Quick Data Check**
123+
126124
**When:** You get a new dataset
127125
```
128126
👤 "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
134132
```
135133

136134
### **2. 🔄 Daily Validation**
135+
137136
**When:** Regular data quality checks
138137
```
139138
👤 "Run our standard sales validation"
@@ -144,6 +143,7 @@ Once you have Pointblank set up, these scenarios show the most common and powerf
144143
```
145144

146145
### **3. 🚨 Issue Investigation**
146+
147147
**When:** Something looks wrong
148148
```
149149
👤 "Conversion rates jumped to 95%. That's impossible"
@@ -157,54 +157,52 @@ These examples show how natural conversation can quickly identify and resolve da
157157

158158
---
159159

160-
## **🛠️ Common Validation Rules**
160+
## Common Validation Rules
161161

162162
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.
163163

164-
### **Data Integrity**
164+
### Data Integrity
165165

166166
- "Check for duplicate IDs"
167167
- "Ensure no missing required fields"
168168
- "Validate that dates are reasonable"
169169

170-
### **Business Logic**
170+
### Business Logic
171171

172172
- "Amounts must be positive"
173173
- "Email addresses must be valid format"
174174
- "Status must be active, inactive, or pending"
175175

176-
### **Cross-Field Validation**
176+
### Cross-Field Validation
177177

178178
- "End date must be after start date"
179179
- "Discount percentage between 0 and 100"
180180
- "Age must match birth date"
181181

182182
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.
183183

184-
---
185-
186-
## **💡 Pro Tips**
184+
## Some Tips and Tricks
187185

188186
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.
189187

190-
### **Talk Naturally**
188+
### Talk Naturally
191189

192190
**Good:** "Check if customer emails look valid"
193191
**Avoid:** "Execute col_vals_regex on email column"
194192

195-
### **Provide Context**
193+
### Provide Context
196194

197195
**Good:** "This is for the board presentation"
198196
**Avoid:** Just asking for validation without explanation
199197

200-
### **Build Incrementally**
198+
### Build Incrementally
201199

202200
1. Start with data profiling
203201
2. Add basic validation rules
204202
3. Create templates for reuse
205203
4. Set up automated checks
206204

207-
### **Save Templates**
205+
### Save Templates
208206

209207
```
210208
"Save these rules as 'customer_validation'"
@@ -214,9 +212,7 @@ These expert recommendations will help you get maximum value from your Pointblan
214212

215213
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.
216214

217-
---
218-
219-
## **🔧 File Support**
215+
## File Support
220216

221217
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.
222218

@@ -229,9 +225,7 @@ Pointblank works with all major data formats, making it easy to validate data re
229225

230226
The consistent natural language interface works the same regardless of file format, so you can focus on validation logic rather than technical details.
231227

232-
---
233-
234-
## **⚠️ Quick Troubleshooting**
228+
## Quick Troubleshooting
235229

236230
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.
237231

@@ -244,18 +238,8 @@ When you encounter issues, these quick fixes resolve the most common problems. D
244238

245239
Remember, you can always ask the AI to explain what's happening or suggest solutions when you run into problems.
246240

247-
---
248-
249-
## **🎉 You're Ready!**
241+
## Now You're Ready!
250242

251243
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.
252244

253245
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)
258-
2. Explore [Chat Scenarios](../VS_CODE_CHAT_SCENARIOS.md)
259-
3. Check out [Testing Examples](../MCP_TESTING_GUIDE.md)
260-
261-
**Happy validating!** 🚀

0 commit comments

Comments
 (0)