- Add macOS venv setup using KiCAD's bundled Python (fixes #45) - Update JLCPCB database size from 1-2 GB to 3-5 GB (accurate for 2.5M+ parts) - Update all "100k+" references to "2.5M+" for consistency - Update jlcpcb-api.ts tool description (JLCSearch API, no auth required) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
22
README.md
22
README.md
@@ -230,7 +230,7 @@ The server provides 64 tools organized into functional categories. With the new
|
|||||||
|
|
||||||
### JLCPCB Integration (5 tools)
|
### JLCPCB Integration (5 tools)
|
||||||
- `download_jlcpcb_database` - Download complete JLCPCB parts catalog (one-time setup)
|
- `download_jlcpcb_database` - Download complete JLCPCB parts catalog (one-time setup)
|
||||||
- `search_jlcpcb_parts` - Search 100k+ parts with parametric filters
|
- `search_jlcpcb_parts` - Search 2.5M+ parts with parametric filters
|
||||||
- `get_jlcpcb_part` - Get detailed part info with pricing and footprints
|
- `get_jlcpcb_part` - Get detailed part info with pricing and footprints
|
||||||
- `get_jlcpcb_database_stats` - View database statistics and coverage
|
- `get_jlcpcb_database_stats` - View database statistics and coverage
|
||||||
- `suggest_jlcpcb_alternatives` - Find cheaper or more available alternatives
|
- `suggest_jlcpcb_alternatives` - Find cheaper or more available alternatives
|
||||||
@@ -372,20 +372,32 @@ See [Windows Installation Guide](docs/WINDOWS_SETUP.md) for detailed instruction
|
|||||||
|
|
||||||
### macOS
|
### macOS
|
||||||
|
|
||||||
|
**Important:** On macOS, use KiCAD's bundled Python to ensure proper access to pcbnew module.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Install KiCAD 9.0 from kicad.org/download/macos
|
# Install KiCAD 9.0 from kicad.org/download/macos
|
||||||
|
|
||||||
# Install Node.js
|
# Install Node.js
|
||||||
brew install node@20
|
brew install node@20
|
||||||
|
|
||||||
# Clone and build
|
# Clone repository
|
||||||
git clone https://github.com/mixelpixx/KiCAD-MCP-Server.git
|
git clone https://github.com/mixelpixx/KiCAD-MCP-Server.git
|
||||||
cd KiCAD-MCP-Server
|
cd KiCAD-MCP-Server
|
||||||
|
|
||||||
|
# Create virtual environment using KiCAD's bundled Python
|
||||||
|
/Applications/KiCad/KiCad.app/Contents/Frameworks/Python.framework/Versions/Current/bin/python3 -m venv venv --system-site-packages
|
||||||
|
|
||||||
|
# Activate virtual environment
|
||||||
|
source venv/bin/activate
|
||||||
|
|
||||||
|
# Install dependencies
|
||||||
npm install
|
npm install
|
||||||
pip3 install -r requirements.txt
|
pip install -r requirements.txt
|
||||||
npm run build
|
npm run build
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**Note:** The `--system-site-packages` flag is required to access KiCAD's pcbnew module from the virtual environment.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
### Claude Desktop
|
### Claude Desktop
|
||||||
@@ -479,7 +491,7 @@ To download the database:
|
|||||||
Ask Claude: "Download the JLCPCB parts database"
|
Ask Claude: "Download the JLCPCB parts database"
|
||||||
```
|
```
|
||||||
|
|
||||||
This creates a local SQLite database at `data/jlcpcb_parts.db` (~1-2 GB for full catalog).
|
This creates a local SQLite database at `data/jlcpcb_parts.db` (3-5 GB for full 2.5M+ part catalog).
|
||||||
|
|
||||||
**Mode 2: Local Symbol Libraries (No Setup Required)**
|
**Mode 2: Local Symbol Libraries (No Setup Required)**
|
||||||
|
|
||||||
@@ -758,7 +770,7 @@ npm run format
|
|||||||
- UI auto-launch
|
- UI auto-launch
|
||||||
- Full MCP protocol compliance
|
- Full MCP protocol compliance
|
||||||
- JLCPCB parts integration (local libraries + JLCSearch API)
|
- JLCPCB parts integration (local libraries + JLCSearch API)
|
||||||
- Cost optimization and component selection with 100k+ parts catalog
|
- Cost optimization and component selection with 2.5M+ parts catalog
|
||||||
|
|
||||||
**Under Active Development (IPC Backend):**
|
**Under Active Development (IPC Backend):**
|
||||||
- Real-time UI synchronization via KiCAD 9.0 IPC API
|
- Real-time UI synchronization via KiCAD 9.0 IPC API
|
||||||
|
|||||||
@@ -45,7 +45,7 @@ Downloaded 200 parts...
|
|||||||
Downloaded 2,500,000 parts...
|
Downloaded 2,500,000 parts...
|
||||||
|
|
||||||
Total parts: 2,500,000+
|
Total parts: 2,500,000+
|
||||||
Database size: ~1-2 GB
|
Database size: 3-5 GB (full catalog)
|
||||||
```
|
```
|
||||||
|
|
||||||
### Usage Examples
|
### Usage Examples
|
||||||
|
|||||||
@@ -12,8 +12,8 @@ export function registerJLCPCBApiTools(server: McpServer, callKicadScript: Funct
|
|||||||
"download_jlcpcb_database",
|
"download_jlcpcb_database",
|
||||||
`Download the complete JLCPCB parts catalog to local database.
|
`Download the complete JLCPCB parts catalog to local database.
|
||||||
|
|
||||||
This is a one-time setup that downloads ~100k+ parts from JLCPCB API.
|
This is a one-time setup that downloads ~2.5M+ parts from JLCSearch API.
|
||||||
Requires JLCPCB_API_KEY and JLCPCB_API_SECRET environment variables.
|
No API credentials required - uses public JLCSearch API.
|
||||||
|
|
||||||
The download takes 5-10 minutes and creates a local SQLite database
|
The download takes 5-10 minutes and creates a local SQLite database
|
||||||
for fast offline searching.`,
|
for fast offline searching.`,
|
||||||
|
|||||||
Reference in New Issue
Block a user