setup-assistant · diff
git:20260327.c506acd to git:20261110.0e87468
61 added, 84 removed. Audit A to A.
What this update changes in the checks
No check changed: every fixed check gives the same answer before and after this update.
A tripped check is a label, not a verdict: read the matched text and the lines below. This week's updates that newly trip a check.
---
name: setup-assistant
description: Guides through installation, configuration, and first-time setup of the Claude Patent Creator system.
---
# Setup Assistant Skill
Expert system for installing, configuring, and setting up the Claude Patent Creator MCP server.
## When to Use
Installing first time, setting up new environment, configuring authentication, troubleshooting installation, migrating to new machine, updating dependencies, verifying health.
- ## Quick Setup (5 Minutes)
-
- ```bash
- # 1. Create virtual environment
- python -m venv venv
- venv\Scripts\activate # Windows
- source venv/bin/activate # Linux/macOS
-
- # 2. Run installer
- python install.py
+ ## Quick Setup (about an hour, mostly waiting)
- # 3. Restart Claude Code
+ Follow the README's Quick Start; it is the tested path. In short:
- # 4. Test
- # Ask Claude: "Search MPEP for claim definiteness"
+ ```bash
+ # Mac/Linux (Windows: py -m venv patent-creator-venv, then .\patent-creator-venv\Scripts\...)
+ cd ~
+ python3 -m venv patent-creator-venv
+ patent-creator-venv/bin/pip install git+https://github.com/RobThePCGuy/Claude-Patent-Creator.git
+ patent-creator-venv/bin/patent-creator setup
```
+ Setup takes 25-40 minutes without an NVIDIA GPU and ends by testing the connection to Claude Code. Then restart Claude Code and ask: "Search MPEP for claim definiteness". From a plugin, `/claude-patent-creator-standalone:setup-patent-system` does the same steps into the same folder.
+
## Complete Setup Lifecycle
### Phase 1: Pre-Installation Checks
**Requirements:**
- - Python 3.9-3.12 (3.11 recommended)
+ - Python 3.10-3.13 (CI tests 3.11; 3.13 walked end to end)
- 8GB+ RAM (16GB recommended)
- 5GB free disk
- Optional: NVIDIA GPU with CUDA 12.x
**Verify:**
```bash
- python --version # Should show 3.9-3.12
+ python3 --version # Should show 3.10-3.13
nvidia-smi # Optional: Check GPU
```
- ### Phase 2: Virtual Environment
-
- ```bash
- # Create venv
- python -m venv venv
+ ### Phase 2: Virtual Environment and Install
- # Activate
- venv\Scripts\activate # Windows
- source venv/bin/activate # Linux/macOS
+ Use the README's folder, `~/patent-creator-venv`, so every README instruction works as written. Nothing needs activating; call the venv's commands by path.
- # Verify
- which python # Should show venv path
+ ```bash
+ # Mac/Linux
+ cd ~
+ python3 -m venv patent-creator-venv
+ patent-creator-venv/bin/pip install git+https://github.com/RobThePCGuy/Claude-Patent-Creator.git
+ # Windows (PowerShell, from cd ~)
+ py -m venv patent-creator-venv
+ .\patent-creator-venv\Scripts\pip install git+https://github.com/RobThePCGuy/Claude-Patent-Creator.git
```
- **Important:** Always activate venv before running scripts!
+ From a source checkout instead: `pip install -e .` inside a venv made in the checkout.
- ### Phase 3: Dependency Installation
+ ### Phase 3: Setup
- **Automated (Recommended):**
```bash
- python install.py
- # Handles: PyTorch order, GPU detection, MCP registration
+ ~/patent-creator-venv/bin/patent-creator setup # Windows: .\patent-creator-venv\Scripts\patent-creator setup
```
- **Manual (Advanced):**
- ```bash
- # Install PyTorch FIRST (critical!)
- pip install torch torchvision --index-url https://download.pytorch.org/whl/cu128
-
- # Then install package (includes all dependencies)
- pip install -e .
- ```
+ Handles GPU detection (installs the CUDA PyTorch build on NVIDIA and restarts itself), downloads, the index build (25-40 min without an NVIDIA GPU, with progress lines), Graphviz (asks first), BigQuery detection, and registration with a live connection test.
- **Why PyTorch order matters:** If installed after sentence-transformers, you get CPU-only version.
+ **NVIDIA by hand only:** install the CUDA PyTorch build before `sentence-transformers`, or you get the CPU-only build: `~/patent-creator-venv/bin/python -m pip install torch --index-url https://download.pytorch.org/whl/cu128`.
### Phase 4: BigQuery Authentication (Optional)
BigQuery adds 100M+ patent search but is NOT required. MPEP search, claims review, EPO analysis, and all other features work without it.
The setup auto-detects existing gcloud credentials. If already authenticated, BigQuery works automatically.
**If the user wants to enable BigQuery later:**
```bash
# One command — opens browser for Google sign-in (free, no credit card)
- ! gcloud auth application-default login
+ ! gcloud auth application-default login # typed in the Claude Code prompt; in a plain terminal drop the "!"
```
**Do NOT present BigQuery as a failure or required step.** It is a bonus feature.
### Phase 5: MCP Server Registration
- **Automated:**
- ```bash
- python install.py # Handles registration automatically
- ```
+ Setup registers the server and tests the connection itself. To recheck: `~/patent-creator-venv/bin/patent-creator verify-config`.
**Manual:**
```bash
# Get paths
- patent-creator verify-config
+ ~/patent-creator-venv/bin/patent-creator verify-config
# Register (use forward slashes!)
claude mcp add --transport stdio claude-patent-creator --scope user -- \
"C:/path/to/venv/Scripts/python.exe" \
"C:/path/to/mcp_server/server.py"
# Verify
claude mcp list
```
**Critical:** Restart Claude Code after registration!
### Phase 6: Configuration Files
- Create `.env`:
+ Nothing is required. Save optional keys with the config command (they go in `~/.config/claude-patent-creator/config.json`, or `%APPDATA%\claude-patent-creator\config.json` on Windows):
```bash
- # Required
- GOOGLE_CLOUD_PROJECT=your_project_id
- ANTHROPIC_API_KEY=<YOUR_ANTHROPIC_API_KEY>
-
- # Optional
- PATENT_LOG_LEVEL=INFO
- PATENT_LOG_FORMAT=human
- PATENT_ENABLE_METRICS=true
-
- # Windows only
- CLAUDE_CODE_GIT_BASH_PATH=C:\dev\Git\bin\bash.exe
+ ~/patent-creator-venv/bin/patent-creator config set SERPAPI_API_KEY "key" # patent search, free 250/month (recommended)
+ ~/patent-creator-venv/bin/patent-creator config set GOOGLE_CLOUD_PROJECT my-proj # optional BigQuery search
+ ~/patent-creator-venv/bin/patent-creator config list # everything, with sources
```
+ ANTHROPIC_API_KEY / OPENAI_API_KEY are only for HyDE with HYDE_BACKEND=api, which is off by default. A `.env` in a source checkout also works.
+
### Phase 7: Health Check
```bash
- patent-creator health
+ ~/patent-creator-venv/bin/patent-creator health # Windows: .\patent-creator-venv\Scripts\patent-creator health
```
### Phase 8: Present Results
**Setup is complete when MPEP index is built and MCP server is registered.** BigQuery and EPO OPS are optional enhancements.
Present a clean summary table showing what's ready. Do NOT dump manual setup instructions for optional features. The system is fully functional for:
- MPEP/USC/CFR/EPC/PCT legal search
- Claims analysis (US + EPO)
- Specification analysis (US + EPO)
- Formalities checking (US + EPO + PCT)
- - Patent diagram generation
+ - Patent diagram generation (once Graphviz is installed)
- Patent application drafting
- If BigQuery is also configured, mention patent search as available. If not, do NOT present it as a failure — just omit it from the "ready" list.
+ Patent search needs a free SerpApi key (recommended) or BigQuery. If one is configured, list patent search as available. If not, say it is one free key away (README Quick Start, Step 3) rather than presenting it as a failure.
**Test with:**
```
"Search MPEP for claim definiteness requirements"
```
**If this works -> Setup complete. Tell the user they're ready.**
## Common Setup Issues
| Issue | Solution |
|-------|----------|
| PyTorch CPU-only | Reinstall PyTorch FIRST |
| MCP not loading | Restart Claude Code, verify with `claude mcp list` |
| Path errors | Use forward slashes (/) not backslashes (\\) |
| BigQuery fails | Re-auth: `gcloud auth application-default login` |
- | Index not found | Build: `patent-creator rebuild-index` |
- | Import errors | Activate venv |
+ | Index not found | Build: `~/patent-creator-venv/bin/patent-creator setup --rebuild` |
+ | Import errors | Run the venv's own commands (`~/patent-creator-venv/bin/...`); nothing needs activating |
## Platform-Specific Notes
### Windows
- - PowerShell: Use `venv\Scripts\activate`
+ - PowerShell: call `.\patent-creator-venv\Scripts\patent-creator` from `cd ~`; no activation needed
- Git Bash required for MCP commands
- Paths: Always forward slashes in MCP config
- CUDA: Install NVIDIA drivers + toolkit
### Linux
- - venv: `source venv/bin/activate`
+ - venv: call `~/patent-creator-venv/bin/patent-creator`; no activation needed
- FAISS-GPU: Available on Linux only
- Permissions: May need sudo
### macOS
- - Apple Silicon: Use MPS (auto-detected)
+ - Apple Silicon: builds the index on the CPU (faster than MPS for this job, 25-40 min)
- Intel: Use CPU or external GPU
- Homebrew: May need for dependencies
## Update & Maintenance
### Updating Dependencies
```bash
- venv\Scripts\activate
- pip install -e . --upgrade
- python scripts/test_install.py
+ ~/patent-creator-venv/bin/pip install --upgrade git+https://github.com/RobThePCGuy/Claude-Patent-Creator.git
+ ~/patent-creator-venv/bin/patent-creator setup # re-checks, rebuilds only if needed
```
+ From a source checkout: `git pull`, then `venv/bin/pip install -e . --upgrade` and `venv/bin/python -m pytest -q`.
+
### Rebuilding Index
```bash
- patent-creator rebuild-index
- # Wait 5-15 minutes
+ ~/patent-creator-venv/bin/patent-creator setup --rebuild
+ # About 5 minutes with an NVIDIA GPU, 25-40 minutes otherwise
```
### Re-registering MCP
```bash
- claude mcp remove claude-patent-creator
- python install.py
+ ~/patent-creator-venv/bin/patent-creator setup # re-registers and retests; downloads and index are kept
# Restart Claude Code
```
## Quick Reference
### Essential Commands
```bash
# Setup
- python install.py
- patent-creator health
+ ~/patent-creator-venv/bin/patent-creator setup
+ ~/patent-creator-venv/bin/patent-creator health
claude mcp list
- # Testing
- python scripts/test_install.py
- python scripts/test_gpu.py
- python scripts/test_bigquery.py
-
# Maintenance
- patent-creator rebuild-index
- patent-creator verify-config
+ ~/patent-creator-venv/bin/patent-creator setup --rebuild
+ ~/patent-creator-venv/bin/patent-creator verify-config
+
+ # Source checkout only
+ venv/bin/python -m pytest -q
```
### Critical Files
- - `.env` - Environment variables
- - `requirements.txt` - Dependencies
- - `mcp_server/index/` - MPEP search index
+ - `~/.config/claude-patent-creator/config.json` - saved settings and keys (`~/patent-creator-venv/bin/patent-creator config path`)
+ - `~/.local/share/claude-patent-creator/data/` - downloaded sources and the search index (`PATENT_DATA_DIR` moves it)
+ - `.env` - environment variables, source checkout only
- `pdfs/` - MPEP PDF files