@perfai/mcp 1.0.25 → 1.0.26
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +49 -40
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -23,7 +23,8 @@ npm install -g @perfai/mcp
|
|
|
23
23
|
### Claude (Desktop or CLI)
|
|
24
24
|
|
|
25
25
|
```bash
|
|
26
|
-
claude mcp add perfai-mcp -e PERFAI_USERNAME=your@email.com -e PERFAI_PASSWORD=yourpassword -- npx -y @perfai/mcp@latest
|
|
26
|
+
claude mcp add perfai-mcp --scope user -e PERFAI_USERNAME=your@email.com -e PERFAI_PASSWORD=yourpassword -- npx -y @perfai/mcp@latest
|
|
27
|
+
|
|
27
28
|
```
|
|
28
29
|
|
|
29
30
|
That single command registers the server, sets credentials, and connects it to Claude. No config file editing needed.
|
|
@@ -166,56 +167,63 @@ logout # clear session
|
|
|
166
167
|
|
|
167
168
|
### 🔓 Public (no authentication required)
|
|
168
169
|
|
|
169
|
-
| Tool
|
|
170
|
-
|
|
171
|
-
| `login`
|
|
172
|
-
| `auth_status` | Check current authentication status and user info.
|
|
170
|
+
| Tool | Description |
|
|
171
|
+
| ------------- | -------------------------------------------------------- |
|
|
172
|
+
| `login` | Authenticate with PerfAI via Auth0 OAuth. Opens browser. |
|
|
173
|
+
| `auth_status` | Check current authentication status and user info. |
|
|
173
174
|
|
|
174
175
|
### 🔒 Protected (authentication required)
|
|
175
176
|
|
|
176
177
|
#### User & Session
|
|
177
|
-
|
|
178
|
-
|
|
178
|
+
|
|
179
|
+
| Tool | Description |
|
|
180
|
+
| ----------- | ------------------------------------------------------ |
|
|
179
181
|
| `user_info` | Get detailed information about the authenticated user. |
|
|
180
|
-
| `logout`
|
|
181
|
-
| `setup`
|
|
182
|
+
| `logout` | Clear authentication session. |
|
|
183
|
+
| `setup` | Auto-configure org and app with default values. |
|
|
182
184
|
|
|
183
185
|
#### Organization & App Management
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
|
187
|
-
| `
|
|
188
|
-
| `
|
|
186
|
+
|
|
187
|
+
| Tool | Parameters | Description |
|
|
188
|
+
| ---------------------- | ---------------------------------------------------- | ------------------------------------------------------------------ |
|
|
189
|
+
| `manage_organizations` | `action` (list/select/refresh), `sequence`, `org_id` | List orgs with sequence numbers, select by number or ID. |
|
|
190
|
+
| `list_apps` | `search`, `environment`, `page`, `limit` | List all APPs with optional filters and pagination. |
|
|
191
|
+
| `select_app` | `sequence`, `name_or_label`, `app_id` | Select an APP by sequence number, partial name/label, or exact ID. |
|
|
189
192
|
|
|
190
193
|
#### Issue Summary
|
|
191
|
-
|
|
192
|
-
|
|
194
|
+
|
|
195
|
+
| Tool | Description |
|
|
196
|
+
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------- |
|
|
193
197
|
| `summarize_issues` | Full dashboard for the selected APP — security risk, design issues, quality issues, attack surface, bug bounty savings, and coverage. |
|
|
194
198
|
|
|
195
199
|
#### Security Issues
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
|
199
|
-
| `
|
|
200
|
-
| `
|
|
200
|
+
|
|
201
|
+
| Tool | Parameters | Description |
|
|
202
|
+
| ----------------------- | ------------------------------------------------------------------------------ | ----------------------------------------------------------- |
|
|
203
|
+
| `show_security_issues` | `limit`, `severities[]`, `status`, `sort_by`, `sort_order`, `search`, `cursor` | List security vulnerabilities with filters. |
|
|
204
|
+
| `ai_fix_security_issue` | `issue_id` (sequence #, ID, or description) | Generate an AI-powered fix prompt for a security issue. |
|
|
205
|
+
| `check_security_fixes` | `wait_seconds` | Check which previously fixed issues were actually resolved. |
|
|
201
206
|
|
|
202
207
|
#### Design Issues
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
|
206
|
-
| `
|
|
207
|
-
| `
|
|
208
|
+
|
|
209
|
+
| Tool | Parameters | Description |
|
|
210
|
+
| --------------------- | -------------------------------------------------------------- | ----------------------------------------------------- |
|
|
211
|
+
| `show_design_issues` | `limit`, `status`, `sort_by`, `sort_order`, `search`, `cursor` | List API design issues with filters. |
|
|
212
|
+
| `ai_fix_design_issue` | `issue_id` | Generate an AI-powered fix prompt for a design issue. |
|
|
213
|
+
| `check_design_fixes` | `wait_seconds` | Check which design fixes were actually resolved. |
|
|
208
214
|
|
|
209
215
|
#### Quality / Spec Validation Issues
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
|
213
|
-
| `
|
|
214
|
-
| `
|
|
216
|
+
|
|
217
|
+
| Tool | Parameters | Description |
|
|
218
|
+
| ---------------------- | ---------------------------------------------------- | ------------------------------------------------------ |
|
|
219
|
+
| `show_quality_issues` | `limit`, `sort_by`, `sort_order`, `search`, `cursor` | List spec validation issues. |
|
|
220
|
+
| `ai_fix_quality_issue` | `issue_id` | Generate an AI-powered fix prompt for a quality issue. |
|
|
221
|
+
| `check_quality_fixes` | `wait_seconds` | Check which quality fixes were actually resolved. |
|
|
215
222
|
|
|
216
223
|
#### Session State
|
|
217
|
-
|
|
218
|
-
|
|
224
|
+
|
|
225
|
+
| Tool | Description |
|
|
226
|
+
| ------------------- | -------------------------------------------------- |
|
|
219
227
|
| `show_fixed_issues` | Show all AI-fixed issues from the current session. |
|
|
220
228
|
|
|
221
229
|
---
|
|
@@ -308,15 +316,16 @@ npm run mcp:inspect # MCP Inspector UI at http://localhost:6274
|
|
|
308
316
|
|
|
309
317
|
## 🔍 Troubleshooting
|
|
310
318
|
|
|
311
|
-
| Problem
|
|
312
|
-
|
|
313
|
-
| Browser doesn't open on `login`
|
|
314
|
-
| `No organizations found`
|
|
315
|
-
| App not found by name
|
|
316
|
-
| Protected tool says "Authentication required" | Run `login` first
|
|
317
|
-
| Stale issues after a fix
|
|
319
|
+
| Problem | Fix |
|
|
320
|
+
| --------------------------------------------- | ---------------------------------------------------------- |
|
|
321
|
+
| Browser doesn't open on `login` | Manually visit the URL shown in the tool response |
|
|
322
|
+
| `No organizations found` | Run `manage_organizations {"action": "refresh"}` |
|
|
323
|
+
| App not found by name | Run `list_apps {}` first and use the exact sequence number |
|
|
324
|
+
| Protected tool says "Authentication required" | Run `login` first |
|
|
325
|
+
| Stale issues after a fix | Wait a moment and re-run `show_*_issues` |
|
|
318
326
|
|
|
319
327
|
Debug logs go to stderr:
|
|
328
|
+
|
|
320
329
|
```bash
|
|
321
330
|
npm start 2> debug.log
|
|
322
331
|
```
|