Skip to content

Commit b5440a6

Browse files
committed
Enhance ESLint configuration and add setup documentation for MCP Inspector
- Updated ESLint configuration to include additional global variables for testing. - Introduced a new `INSPECTOR-QUICKSTART.md` file for streamlined setup instructions. - Added `SETUP-GUIDE.md` for comprehensive guidance on configuring the Claudeus WordPress MCP. - Created `mcp-inspector-config.json` for server configuration. - Updated package dependencies for improved functionality and security. - Removed outdated response example files to clean up the repository.
1 parent 1ac9130 commit b5440a6

20 files changed

Lines changed: 2840 additions & 219247 deletions

‎INSPECTOR-QUICKSTART.md‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
# 🎸 Inspector Quick Start - Clean Configuration
2+
3+
## 🔥 **Recommended Method: Use Servers File (CLEANEST)**
4+
5+
This avoids all the env var clutter in the UI!
6+
7+
### Step 1: Click "Servers File" Button
8+
9+
In the Inspector UI, click the **"Servers File"** button at the bottom (not "Server Entry").
10+
11+
### Step 2: Load the Config
12+
13+
Point it to:
14+
```
15+
/Users/deus/opus/mcp/claudeus-wp-mcp/mcp-inspector-config.json
16+
```
17+
18+
### Step 3: Connect
19+
20+
Click "Connect" - **No env var clutter!** ✨
21+
22+
---
23+
24+
## Alternative: Manual Server Entry (If You Prefer)
25+
26+
### Inspector Settings
27+
28+
```
29+
Transport Type: STDIO
30+
31+
Command: dist/inspector-wrapper.js
32+
33+
Arguments: dist/index.js
34+
```
35+
36+
### Environment Variables
37+
38+
**Note:** The env vars you see (HOME, LOGNAME, etc.) are from your shell - just **ignore them**!
39+
40+
**✅ ONLY ADD THIS:**
41+
42+
```
43+
Variable Name: WP_SITES_PATH
44+
Value: /Users/deus/opus/mcp/claudeus-wp-mcp/wp-sites.json
45+
```
46+
47+
The other variables are filtered out by our wrapper before reaching the server.
48+
49+
## Test Commands
50+
51+
Once connected, try these in the Inspector:
52+
53+
### 1. Discover WordPress Endpoints
54+
```json
55+
{
56+
"name": "claudeus_wp_discover_endpoints",
57+
"arguments": {
58+
"site": "default_test"
59+
}
60+
}
61+
```
62+
63+
### 2. List Posts
64+
```json
65+
{
66+
"name": "claudeus_wp_content__get_posts",
67+
"arguments": {
68+
"site": "default_test",
69+
"filters": {
70+
"per_page": 5
71+
}
72+
}
73+
}
74+
```
75+
76+
### 3. Get Pages
77+
```json
78+
{
79+
"name": "claudeus_wp_content__get_pages",
80+
"arguments": {
81+
"site": "default_test"
82+
}
83+
}
84+
```
85+
86+
## Before You Click Connect
87+
88+
1. ✅ Build completed: `pnpm build`
89+
2. ✅ `wp-sites.json` exists in project root
90+
3. ✅ WordPress URL is updated in `wp-sites.json`
91+
4. ✅ WordPress Application Password is added to `wp-sites.json`
92+
5. ✅ `WP_SITES_PATH` environment variable is set in Inspector
93+
94+
## What Success Looks Like
95+
96+
**✅ Connected:**
97+
- Inspector shows "Connected" status
98+
- Tools tab shows ~30 tools listed
99+
- Can execute tools and get responses
100+
101+
**❌ Failed:**
102+
- Error: "WP_SITES_PATH environment variable is required"
103+
→ Solution: Add the environment variable in Inspector
104+
105+
- Error: "Config file not found"
106+
→ Solution: Verify path to `wp-sites.json` is correct
107+
108+
- Error: "Invalid configuration"
109+
→ Solution: Check `wp-sites.json` has valid JSON syntax
110+
111+
## Pro Tip 🤘
112+
113+
If you see those system env vars (HOME, PATH, etc.) in the Inspector, **that's normal**! They're inherited by any process. Just add the `WP_SITES_PATH` variable to the list - don't delete the others.
114+

0 commit comments

Comments
 (0)