@quarri/claude-data-tools 1.2.0 → 1.2.1

package/README.md

@@ -1,98 +1,163 @@
-# Quarri Claude Code Plugin
+# Quarri Claude Plugin
 
 Natural language data analysis with Quarri. Query databases, create visualizations, and get insights using plain English.
 
 ## Installation
 
-### Via Claude Code Marketplace
+### Claude Code
 
 ```bash
 claude /install quarri
 ```
 
-### Manual Installation
+Or manually add to your Claude Code configuration:
+
+```json
+{
+  "mcpServers": {
+    "quarri": {
+      "command": "npx",
+      "args": ["@quarri/claude-data-tools"]
+    }
+  }
+}
+```
+
+### Claude Desktop
+
+1. **Authenticate first** (one-time setup):
 
 ```bash
-npm install -g @quarri/claude-data-tools
+# New users - create a free trial account
+npx @quarri/claude-data-tools signup
+
+# Existing users - log in
+npx @quarri/claude-data-tools auth
 ```
 
-Then add to your Claude Code configuration:
+2. **Add to Claude Desktop config**:
+
+   - **macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
+   - **Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
 
 ```json
 {
   "mcpServers": {
     "quarri": {
-      "command": "quarri-mcp"
+      "command": "npx",
+      "args": ["@quarri/claude-data-tools"]
     }
   }
 }
 ```
 
+3. **Restart Claude Desktop**
+
 ## Authentication
 
-On first use, you'll be prompted to authenticate:
+### New Users
+
+Create a free trial account:
+
+```bash
+npx @quarri/claude-data-tools signup
+```
 
-### Existing Quarri Users
+You'll receive a verification email to complete signup.
+
+### Existing Users
+
+```bash
+npx @quarri/claude-data-tools auth
+```
 
 1. Enter your email address
 2. Check your email for a 6-digit verification code
 3. Enter the code to complete authentication
 
-### New Users (with invitation)
-
-1. Select "invite" when prompted
-2. Enter your email address
-3. Enter the invitation token from your admin's email
-4. Your account will be created automatically
+Credentials are stored securely in `~/.quarri/credentials`.
 
 ## Features
 
-### 47 Tools for Data Analysis
-
-**Sub-Agents (12):**
-- `quarri_query_agent` - Generate SQL from natural language
-- `quarri_explain_agent` - Explain SQL queries
-- `quarri_chart_agent` - Generate visualizations
-- `quarri_metric_builder_agent` - Define metrics interactively
-- `quarri_planning_agent` - Create analysis plans
-- `quarri_insight_agent` - Generate actionable insights
-- `quarri_stats_agent` - Statistical analysis
-- `quarri_staging_agent` - Stage raw data
-- `quarri_modeling_agent` - Design data models
-- `quarri_transformers_agent` - Generate transformation SQL
-- `quarri_extraction_agent` - Create data pipelines
-- `quarri_query_with_analysis` - Full analysis pipeline
-
-**Data Tools (8):**
-- `quarri_execute_sql` - Run SQL queries
-- `quarri_get_schema` - View database schema
-- `quarri_search_values` - Semantic search
-- `quarri_get_metrics`, `quarri_create_metric`, `quarri_approve_metric`
-- `quarri_get_metric_detail`, `quarri_search_metrics`
-
-**Configuration (8):**
-- `quarri_list_agent_prompts`, `quarri_update_agent_prompt`
-- `quarri_list_rules`, `quarri_create_rule`, `quarri_update_rule`, `quarri_delete_rule`
-- `quarri_vectorize_column_values`, `quarri_list_searchable_columns`
-
-**Canvas (5):**
-- `quarri_list_canvases`, `quarri_get_canvas`
-- `quarri_create_chart_panel`, `quarri_update_chart_panel`
-- `quarri_export_canvas`
-
-**Team (3):**
-- `quarri_list_teams`, `quarri_get_team_filters`, `quarri_get_team_restrictions`
-
-**Extraction (7):**
-- `quarri_list_extraction_sources`, `quarri_configure_extraction`
-- `quarri_discover_tables`, `quarri_propose_transformation`
-- `quarri_upload_csv`, `quarri_generate_quarri_schema`, `quarri_list_raw_tables`
-
-**Debug (3):**
-- `quarri_read_server_logs`, `quarri_query_repl_activity`, `quarri_read_fly_logs`
-
-**Session (2):**
-- `quarri_list_databases`, `quarri_select_database`
+### Interactive UI Components (MCP Apps)
+
+Quarri returns rich, interactive UI components for data display:
+
+- **Data Tables** - Sortable, paginated query results
+- **Charts** - Interactive Plotly visualizations
+- **Schema Explorer** - Visual database structure
+- **Metrics Cards** - KPI displays with status badges
+- **Logs View** - Syntax-highlighted log entries
+- **Code View** - Syntax-highlighted source code
+
+These render automatically in Claude Desktop and Claude Code when using supported tools.
+
+### 39 Tools for Data Analysis
+
+**Data Tools:**
+- `quarri_execute_sql` - Run SQL queries → interactive data table
+- `quarri_get_schema` - View database schema → schema explorer
+- `quarri_search_values` - Semantic search → search results
+- `quarri_get_metrics` - List defined metrics → metrics list
+- `quarri_create_metric` - Define new metrics
+- `quarri_approve_metric` - Approve pending metrics
+- `quarri_get_metric_detail` - Metric details → metric card
+- `quarri_search_metrics` - Search metrics → metrics list
+
+**Configuration:**
+- `quarri_list_agent_prompts` - View agent prompts → prompts list
+- `quarri_update_agent_prompt` - Update prompts
+- `quarri_list_rules` - Query generation rules → rules list
+- `quarri_create_rule`, `quarri_update_rule`, `quarri_delete_rule`
+- `quarri_vectorize_column_values` - Enable semantic search
+- `quarri_list_searchable_columns` - View searchable columns → columns list
+
+**Team & Security:**
+- `quarri_list_teams` - Organization teams → teams list
+- `quarri_get_team_filters` - Row-level security → filters view
+- `quarri_get_team_restrictions` - Column restrictions → restrictions view
+
+**Data Extraction:**
+- `quarri_list_extraction_sources` - Data sources → sources list
+- `quarri_configure_extraction` - Configure sources
+- `quarri_discover_tables` - Discover tables → tables list
+- `quarri_propose_transformation` - Propose transforms
+- `quarri_upload_csv` - Upload CSV files
+- `quarri_generate_quarri_schema` - Generate schema config
+- `quarri_list_raw_tables` - Raw tables → tables list
+
+**Connectors:**
+- `quarri_get_connector_code` - View connector code → code view
+- `quarri_get_connector_logs` - Connector logs → logs view
+- `quarri_log_analysis_run` - Log analysis runs
+- `quarri_schedule_extraction` - Schedule extractions
+- `quarri_store_generated_code` - Save connector code
+- `quarri_update_connector_code` - Update connector code
+
+**Debug:**
+- `quarri_read_server_logs` - Server logs → logs view
+- `quarri_query_repl_activity` - Activity history → activity list
+- `quarri_read_fly_logs` - Production logs → logs view
+
+**Session:**
+- `quarri_auth_status` - Check auth → auth status card
+- `quarri_trial_status` - Trial info → trial status card
+- `quarri_list_databases` - Available databases
+- `quarri_select_database` - Switch database
+
+### Skills (Slash Commands)
+
+Quarri includes intelligent skills for common workflows:
+
+- `/quarri-query` - Natural language to SQL
+- `/quarri-analyze` - Full analysis pipeline
+- `/quarri-chart` - Generate visualizations
+- `/quarri-insights` - Statistical insights
+- `/quarri-metric` - Define metrics interactively
+- `/quarri-explain` - Explain SQL queries
+- `/quarri-extract` - Create data pipelines
+- `/quarri-diagnose` - Debug connector issues
+- `/quarri-guide` - Quarri usage guide
 
 ## Usage Examples
 
@@ -102,64 +167,58 @@ On first use, you'll be prompted to authenticate:
 What were our top 10 products by revenue last month?
 ```
 
-Claude will use `quarri_query_with_analysis` to:
-1. Generate SQL from your question
-2. Execute the query
-3. Perform statistical analysis
-4. Generate a chart
-5. Provide key insights
+Claude will generate SQL, execute it, and return results in an interactive data table.
 
-### Create a Metric
+### Create a Visualization
 
 ```
-Help me define a metric for customer lifetime value
+/quarri-chart Show monthly revenue trend for 2024
 ```
 
-Claude will guide you through defining the metric using `quarri_metric_builder_agent`.
+Returns an interactive Plotly chart rendered in the conversation.
 
-### Configure Semantic Search
+### Define a Metric
 
 ```
-Enable semantic search on the product_name column
+/quarri-metric Help me define customer lifetime value
 ```
 
-Claude will use `quarri_vectorize_column_values` to enable natural language search.
+Guides you through defining a reusable metric with SQL template.
+
+### Configure Semantic Search
 
-## Configuration
+```
+Enable semantic search on the product_name column
+```
 
-Credentials are stored in `~/.quarri/credentials` with secure permissions (0600).
+Uses `quarri_vectorize_column_values` to enable natural language search on column values.
 
-### Environment Variables
+## Environment Variables
 
 - `QUARRI_API_URL` - API endpoint (default: https://app.quarri.ai)
 
 ## Development
 
-### Building
-
 ```bash
+# Install dependencies
 npm install
-npm run build
-```
 
-### Testing
+# Build
+npm run build
 
-```bash
+# Run tests
 npm test
-```
-
-### Local Development
 
-```bash
+# Local development
 npm run dev
 ```
 
-## License
-
-MIT
-
 ## Support
 
 - GitHub Issues: https://github.com/djayatillake/quarri-claude-plugin/issues
 - Documentation: https://docs.quarri.ai
 - Email: support@quarri.ai
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quarri/claude-data-tools",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "Quarri Data Assistant - Natural language data analysis with Quarri",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",