snow-flow 3.6.23 → 3.6.25

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 CHANGED
@@ -1,24 +1,102 @@
1
- # Snow-Flow
1
+ <div align="center">
2
+ <img src="assets/snow-flow-logo.svg" alt="Snow-Flow Logo" width="200" height="200">
3
+
4
+ # ❄️ Snow-Flow v3.6.25 ❄️
5
+
6
+ <p align="center">
7
+ <strong>🚀 Revolutionary ServiceNow Development Framework with AI-Powered Automation</strong>
8
+ </p>
9
+
10
+ <p align="center">
11
+ <a href="https://www.npmjs.com/package/snow-flow"><img src="https://img.shields.io/npm/v/snow-flow.svg?style=for-the-badge&logo=npm&color=CB3837" alt="npm version"></a>
12
+ <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge" alt="License: MIT"></a>
13
+ <a href="https://nodejs.org"><img src="https://img.shields.io/node/v/snow-flow.svg?style=for-the-badge&logo=node.js&color=339933" alt="Node.js Version"></a>
14
+ <a href="https://github.com/groeimetai/snow-flow"><img src="https://img.shields.io/github/stars/groeimetai/snow-flow?style=for-the-badge&logo=github" alt="GitHub Stars"></a>
15
+ </p>
16
+
17
+ <p align="center">
18
+ <strong>18 MCP Servers</strong> • <strong>200+ Specialized Tools</strong> • <strong>100% Real Implementation</strong>
19
+ </p>
20
+ </div>
2
21
 
3
- ServiceNow development framework with AI-powered automation through 17 MCP servers and 200+ specialized tools.
22
+ ---
23
+
24
+ ## 🎉 What's New in v3.6.25
25
+
26
+ <div align="center">
27
+ <table>
28
+ <tr>
29
+ <td align="center" width="50%">
30
+ <h3>🚀 Major Features</h3>
31
+ <ul align="left">
32
+ <li><strong>Catalog UI Policy Deployment</strong><br/>Deploy via unified <code>snow_deploy</code> tool</li>
33
+ <li><strong>Knowledge Base Verification</strong><br/>Prevents orphaned articles with strict validation</li>
34
+ <li><strong>Catalog Variable Table Fix</strong><br/>Variables now use correct <code>item_option_new</code></li>
35
+ <li><strong>Enhanced UI Policy Debugging</strong><br/>Comprehensive reference field debugging</li>
36
+ <li><strong>18th MCP Server</strong><br/>Local Development Server for artifact syncing</li>
37
+ </ul>
38
+ </td>
39
+ <td align="center" width="50%">
40
+ <h3>🔧 Critical Fixes</h3>
41
+ <ul align="left">
42
+ <li>✅ Catalog variables now visible in ServiceNow</li>
43
+ <li>✅ UI policy actions reference fields fixed</li>
44
+ <li>✅ Non-existent KB error handling added</li>
45
+ <li>✅ MCP transport 3x faster operations</li>
46
+ <li>✅ Widget coherence validation improved</li>
47
+ </ul>
48
+ </td>
49
+ </tr>
50
+ </table>
51
+ </div>
52
+
53
+ ## 📚 Table of Contents
54
+
55
+ <table>
56
+ <tr>
57
+ <td><a href="#-quick-start">⚡ Quick Start</a></td>
58
+ <td><a href="#-installation">📦 Installation</a></td>
59
+ <td><a href="#️-configuration">⚙️ Configuration</a></td>
60
+ <td><a href="#-claude-code-setup">🤖 Claude Code Setup</a></td>
61
+ </tr>
62
+ <tr>
63
+ <td><a href="#️-mcp-servers">🖥️ MCP Servers</a></td>
64
+ <td><a href="#-usage-examples">💡 Usage Examples</a></td>
65
+ <td><a href="#-commands">🔧 Commands</a></td>
66
+ <td><a href="#️-troubleshooting">🛠️ Troubleshooting</a></td>
67
+ </tr>
68
+ </table>
69
+
70
+ ---
71
+
72
+ ## ⚡ Quick Start
73
+
74
+ ```bash
75
+ # Install Snow-Flow globally
76
+ npm install -g snow-flow
77
+
78
+ # Initialize in your project
79
+ snow-flow init
80
+
81
+ # Configure your ServiceNow instance
82
+ # Edit .env with your credentials
4
83
 
5
- ## Table of Contents
6
- - [Installation](#installation)
7
- - [Configuration](#configuration)
8
- - [Claude Code Setup](#claude-code-setup)
9
- - [MCP Servers](#mcp-servers)
10
- - [Usage](#usage)
11
- - [Commands](#commands)
12
- - [Troubleshooting](#troubleshooting)
13
- - [License](#license)
84
+ # Start using with Claude Code!
85
+ ```
14
86
 
15
- ## Installation
87
+ ## 📦 Installation
16
88
 
17
- ### Prerequisites
18
- - Node.js 18 or higher
19
- - npm 9 or higher
20
- - ServiceNow instance with admin access
21
- - Claude Code desktop application
89
+ <div align="center">
90
+ <h3>📋 Prerequisites</h3>
91
+ <table>
92
+ <tr>
93
+ <td align="center">🟢 Node.js 18+</td>
94
+ <td align="center">📦 npm 9+</td>
95
+ <td align="center">☁️ ServiceNow Instance</td>
96
+ <td align="center">🤖 Claude Code Desktop</td>
97
+ </tr>
98
+ </table>
99
+ </div>
22
100
 
23
101
  ### Install from NPM
24
102
 
@@ -47,7 +125,7 @@ npm run build
47
125
  npm link
48
126
  ```
49
127
 
50
- ## Configuration
128
+ ## ⚙️ Configuration
51
129
 
52
130
  ### Step 1: Initialize Snow-Flow
53
131
 
@@ -60,11 +138,18 @@ cd my-servicenow-project
60
138
  snow-flow init
61
139
  ```
62
140
 
63
- This creates:
64
- - `.env` file for ServiceNow credentials
65
- - `.snow-flow/` configuration directory
66
- - `.claude/` MCP server configurations
67
- - `CLAUDE.md` with comprehensive documentation
141
+ <details>
142
+ <summary><strong>📁 Created Files & Directories</strong></summary>
143
+
144
+ | File/Directory | Purpose |
145
+ |----------------|----------|
146
+ | `.env` | ServiceNow credentials |
147
+ | `.snow-flow/` | Configuration directory |
148
+ | `.claude/` | MCP server configurations |
149
+ | `CLAUDE.md` | Comprehensive documentation |
150
+ | `.mcp.json` | MCP server registry |
151
+
152
+ </details>
68
153
 
69
154
  ### Step 2: Configure ServiceNow Credentials
70
155
 
@@ -79,34 +164,19 @@ SNOW_PASSWORD=admin.password
79
164
  # OAuth Configuration (recommended for production)
80
165
  SNOW_CLIENT_ID=your-oauth-client-id
81
166
  SNOW_CLIENT_SECRET=your-oauth-client-secret
82
-
83
- # Optional: Claude API Key
84
- ANTHROPIC_API_KEY=your-claude-api-key
85
167
  ```
86
168
 
87
- ### Step 3: Set Up OAuth in ServiceNow
88
-
89
- 1. Navigate to **System OAuth > Application Registry**
90
- 2. Click **New** > **Create an OAuth API endpoint for external clients**
91
- 3. Configure:
92
- - Name: `Snow-Flow OAuth`
93
- - Client ID: (auto-generated, copy to .env)
94
- - Client Secret: (generate new, copy to .env)
95
- - Redirect URL: `http://localhost:3000/callback`
96
- - Refresh Token Lifespan: `86400` (24 hours)
97
- 4. Save and activate
98
-
99
- ### Step 4: Authenticate
169
+ ### Step 3: Verify Configuration
100
170
 
101
171
  ```bash
102
- # Login to ServiceNow
103
- snow-flow auth login
172
+ # Test connection
173
+ snow-flow test-connection
104
174
 
105
- # Verify connection
106
- snow-flow auth status
175
+ # Check MCP server status
176
+ snow-flow mcp status
107
177
  ```
108
178
 
109
- ## Claude Code Setup
179
+ ## 🤖 Claude Code Setup
110
180
 
111
181
  ### Fix Permission Errors
112
182
 
@@ -131,7 +201,7 @@ During `snow-flow init`, you'll be prompted to automatically activate all MCP se
131
201
  ```
132
202
 
133
203
  Selecting **Y** will:
134
- - Configure all 17 MCP servers
204
+ - Configure all 18 MCP servers
135
205
  - Auto-approve server permissions
136
206
  - Launch Claude Code with servers ready
137
207
 
@@ -147,372 +217,419 @@ claude --mcp-config .claude/claude_desktop_config.json
147
217
  claude.exe --mcp-config .claude/claude_desktop_config.json
148
218
  ```
149
219
 
150
- ## MCP Servers
151
-
152
- Snow-Flow includes 17 specialized MCP servers with 200+ tools:
153
-
154
- ### 1. Deployment Server (10 tools)
155
- Widget and artifact deployment with coherence validation
156
- - `snow_deploy` - Create new artifacts
157
- - `snow_update` - Update existing artifacts
158
- - `snow_delete` - Delete artifacts
159
- - `snow_validate_deployment` - Validate before deployment
160
- - `snow_rollback_deployment` - Rollback failed deployments
161
- - `snow_preview_widget` - Preview widgets
162
- - `snow_widget_test` - Test widget functionality
163
- - `snow_batch_deploy` - Deploy multiple artifacts
164
-
165
- ### 2. Operations Server (12 tools)
166
- Core ServiceNow operations and queries
167
- - `snow_query_table` - Query any table with pagination
168
- - `snow_query_incidents` - Query and analyze incidents
169
- - `snow_cmdb_search` - Search CMDB
170
- - `snow_user_lookup` - Find users
171
- - `snow_operational_metrics` - Get metrics
172
- - `snow_knowledge_search` - Search knowledge base
173
- - `snow_create_incident` - Create incidents
174
- - `snow_update_incident` - Update incidents
175
-
176
- ### 3. Automation Server (27 tools)
177
- Script execution and automation
178
- - `snow_execute_background_script` - Execute background scripts (ES5 only)
179
- - `snow_execute_script_with_output` - Execute with output capture
180
- - `snow_execute_script_sync` - Synchronous execution
181
- - `snow_confirm_script_execution` - Confirm execution
182
- - `snow_create_scheduled_job` - Create scheduled jobs
183
- - `snow_create_atf_test` - Create automated tests
184
- - `snow_execute_atf_test` - Run tests
185
- - `snow_property_manager` - Manage properties
186
-
187
- ### 4. Platform Development Server (9 tools)
188
- Create platform artifacts
189
- - `snow_create_script_include` - Create Script Includes
190
- - `snow_create_business_rule` - Create Business Rules
191
- - `snow_create_client_script` - Create Client Scripts
192
- - `snow_create_ui_policy` - Create UI Policies
193
- - `snow_create_ui_action` - Create UI Actions
194
- - `snow_create_ui_page` - Create UI Pages
195
-
196
- ### 5. Integration Server (10 tools)
197
- REST/SOAP and data management
198
- - `snow_create_rest_message` - Create REST integrations
199
- - `snow_create_transform_map` - Create transform maps
200
- - `snow_create_import_set` - Manage import sets
201
- - `snow_test_web_service` - Test web services
202
- - `snow_configure_email` - Configure email
203
-
204
- ### 6. System Properties Server (12 tools)
205
- System property management
206
- - `snow_property_get` - Get property values
207
- - `snow_property_set` - Set property values
208
- - `snow_property_list` - List properties
209
- - `snow_property_delete` - Delete properties
210
- - `snow_property_bulk_update` - Bulk updates
211
- - `snow_property_export` - Export to JSON
212
- - `snow_property_import` - Import from JSON
213
-
214
- ### 7. Update Set Server (6 tools)
215
- Change management and deployment
216
- - `snow_update_set_create` - Create update sets
217
- - `snow_update_set_switch` - Switch active update set
218
- - `snow_update_set_current` - Get current update set
219
- - `snow_update_set_complete` - Complete update set
220
- - `snow_update_set_export` - Export as XML
221
- - `snow_ensure_active_update_set` - Ensure active set
222
-
223
- ### 8. Development Assistant Server (6 tools)
224
- Intelligent artifact management
225
- - `snow_find_artifact` - Find any artifact
226
- - `snow_edit_artifact` - Edit existing artifacts
227
- - `snow_get_by_sysid` - Get by sys_id
228
- - `snow_analyze_artifact` - Analyze dependencies
229
- - `snow_comprehensive_search` - Deep search
230
- - `snow_analyze_requirements` - Analyze requirements
231
-
232
- ### 9. Security & Compliance Server (5 tools)
233
- Security and compliance management
234
- - `snow_create_security_policy` - Create policies
235
- - `snow_audit_compliance` - Audit compliance
236
- - `snow_scan_vulnerabilities` - Scan vulnerabilities
237
- - `snow_assess_risk` - Risk assessment
238
- - `snow_review_access_control` - Review ACLs
239
-
240
- ### 10. Reporting & Analytics Server (5 tools)
241
- Reporting and visualization
242
- - `snow_create_report` - Create reports
243
- - `snow_create_dashboard` - Create dashboards
244
- - `snow_define_kpi` - Define KPIs
245
- - `snow_schedule_report` - Schedule reports
246
- - `snow_analyze_data_quality` - Data quality
247
-
248
- ### 11. Machine Learning Server (6 tools)
249
- AI/ML capabilities with TensorFlow.js
250
- - `ml_train_incident_classifier` - Train classifiers
251
- - `ml_predict_change_risk` - Predict risks
252
- - `ml_detect_anomalies` - Detect anomalies
253
- - `ml_forecast_incidents` - Forecast incidents
254
- - `ml_performance_analytics` - Performance ML
255
- - `ml_hybrid_recommendation` - Recommendations
256
-
257
- ### 12. Orchestration Server (6 tools)
258
- Multi-agent coordination
259
- - `swarm_init` - Initialize swarms
260
- - `agent_spawn` - Create agents
261
- - `task_orchestrate` - Orchestrate tasks
262
- - `memory_search` - Search memory
263
- - `neural_train` - Train neural networks
264
- - `performance_report` - Performance reports
265
-
266
- ### 13. Knowledge & Catalog Server (7 tools)
267
- Knowledge and service catalog
268
- - `snow_create_knowledge_article` - Create articles
269
- - `snow_search_knowledge` - Search knowledge
270
- - `snow_create_catalog_item` - Create catalog items
271
- - `snow_create_catalog_variable` - Create variables
272
- - `snow_order_catalog_item` - Order items
273
- - `snow_discover_catalogs` - Discover catalogs
274
-
275
- ### 14. Change & Virtual Agent Server (7 tools)
276
- Change management and Virtual Agent
277
- - `snow_create_change_request` - Create changes
278
- - `snow_schedule_cab_meeting` - Schedule CAB
279
- - `snow_create_va_topic` - Create VA topics
280
- - `snow_send_va_message` - Send VA messages
281
- - `snow_create_pa_indicator` - Create PA indicators
282
- - `snow_get_pa_scores` - Get PA scores
283
-
284
- ### 15. Flow & Workspace Server (10 tools)
285
- Flow Designer and Workspace
286
- - `snow_list_flows` - List flows
287
- - `snow_execute_flow` - Execute flows
288
- - `snow_get_flow_details` - Get flow details
289
- - `snow_get_flow_execution_status` - Execution status
290
- - `snow_get_flow_execution_history` - Execution history
291
- - `snow_import_flow_from_xml` - Import flows
292
- - `snow_create_workspace` - Create workspaces
293
- - `snow_configure_mobile_app` - Configure mobile
294
- - `snow_send_push_notification` - Push notifications
295
-
296
- ### 16. CMDB & Event Server (8 tools)
297
- CMDB and event management
298
- - `snow_create_ci` - Create Configuration Items
299
- - `snow_create_ci_relationship` - Create relationships
300
- - `snow_run_discovery` - Run discovery
301
- - `snow_create_event` - Create events
302
- - `snow_create_hr_case` - Create HR cases
303
- - `snow_employee_onboarding` - Onboarding
304
- - `snow_create_customer_case` - Customer cases
305
- - `snow_create_devops_pipeline` - DevOps pipelines
306
-
307
- ### 17. Advanced Features Server (7 tools)
308
- Batch operations and optimization
309
- - `snow_batch_api` - Batch API (80% reduction)
310
- - `snow_get_table_relationships` - Table relationships
311
- - `snow_analyze_query` - Query optimization
312
- - `snow_detect_code_patterns` - Pattern detection
313
- - `snow_discover_process` - Process discovery
314
- - `snow_analyze_workflow_execution` - Workflow analysis
315
- - `snow_generate_documentation` - Auto-documentation
316
-
317
- ## Usage
318
-
319
- ### Basic Widget Deployment
220
+ ## 🖥️ MCP Servers
221
+
222
+ <div align="center">
223
+ <h3>🎯 18 Specialized MCP Servers • 200+ Tools • Complete ServiceNow Coverage</h3>
224
+ </div>
225
+
226
+ <details>
227
+ <summary><strong>🚀 Click to see all 18 MCP Servers and their capabilities</strong></summary>
228
+
229
+ ### 1️⃣ **Deployment Server** (10 tools)
230
+ 🎯 **Purpose:** Widget and artifact deployment with coherence validation
231
+
232
+ | Tool | Description |
233
+ |------|-------------|
234
+ | `snow_deploy` | Create new artifacts with support for 15+ types including `catalog_ui_policy` |
235
+ | `snow_update` | Update existing artifacts with validation |
236
+ | `snow_delete` | Delete artifacts safely |
237
+ | `snow_validate_deployment` | Pre-deployment validation |
238
+ | `snow_rollback_deployment` | Rollback failed deployments |
239
+ | `snow_preview_widget` | Preview widget before deployment |
240
+ | `snow_widget_test` | Test widget functionality |
241
+ | `snow_deployment_status` | Get deployment status |
242
+ | `snow_deployment_debug` | Debug deployment issues |
243
+
244
+ ### 2️⃣ **Operations Server** (15+ tools)
245
+ 🎯 **Purpose:** Core ServiceNow operations and queries
246
+
247
+ | Tool | Description |
248
+ |------|-------------|
249
+ | `snow_query_table` | Universal table querying with pagination |
250
+ | `snow_create_incident` | Create and manage incidents |
251
+ | `snow_update_record` | Update any table record |
252
+ | `snow_delete_record` | Delete records with validation |
253
+ | `snow_discover_table_fields` | Discover table schema |
254
+ | `snow_cmdb_search` | Search Configuration Management Database |
255
+ | `snow_user_lookup` | Find users and groups |
256
+ | `snow_operational_metrics` | Get operational metrics |
257
+ | `snow_knowledge_search` | Search knowledge base |
258
+
259
+ ### 3️⃣ **Automation Server** (20+ tools)
260
+ 🎯 **Purpose:** Script execution and automation
261
+
262
+ | Tool | Description |
263
+ |------|-------------|
264
+ | `snow_execute_script_with_output` | Execute scripts with full output capture |
265
+ | `snow_execute_background_script` | Execute background scripts with autoConfirm option |
266
+ | `snow_get_script_output` | Retrieve script execution history |
267
+ | `snow_get_logs` | Access system logs |
268
+ | `snow_test_rest_connection` | Test REST integrations |
269
+ | `snow_trace_execution` | Trace script execution |
270
+ | `snow_schedule_job` | Create scheduled jobs |
271
+ | `snow_create_event` | Trigger system events |
272
+
273
+ ### 4️⃣ **Platform Development Server** (12+ tools)
274
+ 🎯 **Purpose:** Platform development artifacts
275
+
276
+ | Tool | Description |
277
+ |------|-------------|
278
+ | `snow_create_script_include` | Create reusable scripts |
279
+ | `snow_create_business_rule` | Create business rules |
280
+ | `snow_create_client_script` | Create client-side scripts |
281
+ | `snow_create_ui_policy` | Create UI policies |
282
+ | `snow_create_ui_action` | Create UI actions |
283
+ | `snow_create_ui_page` | Create UI pages |
284
+
285
+ ### 5️⃣ **Integration Server** (10+ tools)
286
+ 🎯 **Purpose:** Integration and data management
287
+
288
+ | Tool | Description |
289
+ |------|-------------|
290
+ | `snow_create_rest_message` | Create REST integrations |
291
+ | `snow_create_transform_map` | Create data transformation maps |
292
+ | `snow_create_import_set` | Manage import sets |
293
+ | `snow_test_web_service` | Test web services |
294
+ | `snow_configure_email` | Configure email settings |
295
+
296
+ ### 6️⃣ **System Properties Server** (12 tools)
297
+ 🎯 **Purpose:** System property management
298
+
299
+ | Tool | Description |
300
+ |------|-------------|
301
+ | `snow_property_get` | Retrieve property values |
302
+ | `snow_property_set` | Set property values |
303
+ | `snow_property_list` | List properties by pattern |
304
+ | `snow_property_delete` | Remove properties |
305
+ | `snow_property_bulk_update` | Bulk operations |
306
+ | `snow_property_export` | Export to JSON |
307
+ | `snow_property_import` | Import from JSON |
308
+
309
+ ### 7️⃣ **Update Set Server** (6 tools)
310
+ 🎯 **Purpose:** Change management and deployment
311
+
312
+ | Tool | Description |
313
+ |------|-------------|
314
+ | `snow_update_set_create` | Create new update sets |
315
+ | `snow_update_set_switch` | Switch active update set |
316
+ | `snow_update_set_complete` | Mark as complete |
317
+ | `snow_update_set_export` | Export as XML |
318
+ | `snow_ensure_active_update_set` | Ensure update set is active |
319
+
320
+ ### 8️⃣ **Development Assistant Server** (8+ tools)
321
+ 🎯 **Purpose:** Intelligent artifact search and management
322
+
323
+ | Tool | Description |
324
+ |------|-------------|
325
+ | `snow_find_artifact` | Find any ServiceNow artifact |
326
+ | `snow_edit_artifact` | Edit existing artifacts |
327
+ | `snow_get_by_sysid` | Get artifact by sys_id |
328
+ | `snow_analyze_artifact` | Analyze dependencies |
329
+ | `snow_comprehensive_search` | Deep search across tables |
330
+
331
+ ### 9️⃣ **Security & Compliance Server** (10+ tools)
332
+ 🎯 **Purpose:** Security and compliance management
333
+
334
+ | Tool | Description |
335
+ |------|-------------|
336
+ | `snow_create_security_policy` | Create security policies |
337
+ | `snow_audit_compliance` | Compliance auditing |
338
+ | `snow_scan_vulnerabilities` | Vulnerability scanning |
339
+ | `snow_review_access_control` | ACL review |
340
+
341
+ ### 🔟 **Reporting & Analytics Server** (10+ tools)
342
+ 🎯 **Purpose:** Reporting and data visualization
343
+
344
+ | Tool | Description |
345
+ |------|-------------|
346
+ | `snow_create_report` | Create reports |
347
+ | `snow_create_dashboard` | Create dashboards |
348
+ | `snow_define_kpi` | Define KPIs |
349
+ | `snow_schedule_report` | Schedule report delivery |
350
+
351
+ ### 1️⃣1️⃣ **Machine Learning Server** (10+ tools)
352
+ 🎯 **Purpose:** AI/ML capabilities with TensorFlow.js
353
+
354
+ | Tool | Description |
355
+ |------|-------------|
356
+ | `ml_train_incident_classifier` | Train incident classifier |
357
+ | `ml_predict_change_risk` | Predict change risks |
358
+ | `ml_detect_anomalies` | Anomaly detection |
359
+ | `ml_forecast_incidents` | Incident forecasting |
360
+
361
+ ### 1️⃣2️⃣ **Knowledge & Catalog Server** (15+ tools)
362
+ 🎯 **Purpose:** Knowledge base and service catalog management
363
+
364
+ | Tool | Description |
365
+ |------|-------------|
366
+ | `snow_create_knowledge_article` | Create knowledge articles with KB validation |
367
+ | `snow_search_knowledge` | Search knowledge base |
368
+ | `snow_create_catalog_item` | Create catalog items |
369
+ | `snow_create_catalog_variable` | Create catalog variables in correct table |
370
+ | `snow_create_catalog_ui_policy` | Create UI policies with full support |
371
+ | `snow_order_catalog_item` | Order catalog items |
372
+
373
+ ### 1️⃣3️⃣ **Change, Virtual Agent & PA Server** (15+ tools)
374
+ 🎯 **Purpose:** Change management, Virtual Agent, and Performance Analytics
375
+
376
+ | Tool | Description |
377
+ |------|-------------|
378
+ | `snow_create_change_request` | Create change requests |
379
+ | `snow_schedule_cab_meeting` | Schedule CAB meetings |
380
+ | `snow_create_va_topic` | Create Virtual Agent topics |
381
+ | `snow_create_pa_indicator` | Create PA indicators |
382
+
383
+ ### 1️⃣4️⃣ **Flow, Workspace & Mobile Server** (12+ tools)
384
+ 🎯 **Purpose:** Flow Designer, Workspace, and Mobile management
385
+
386
+ | Tool | Description |
387
+ |------|-------------|
388
+ | `snow_list_flows` | List Flow Designer flows |
389
+ | `snow_execute_flow` | Execute flows programmatically |
390
+ | `snow_create_workspace` | Create workspaces |
391
+ | `snow_configure_mobile_app` | Configure mobile app |
392
+
393
+ ### 1️⃣5️⃣ **CMDB, Event, HR, CSM & DevOps Server** (20+ tools)
394
+ 🎯 **Purpose:** CMDB, Events, HR, Customer Service, DevOps
395
+
396
+ | Tool | Description |
397
+ |------|-------------|
398
+ | `snow_create_ci` | Create Configuration Items |
399
+ | `snow_create_event` | Create events |
400
+ | `snow_create_hr_case` | Create HR cases |
401
+ | `snow_create_customer_case` | Create customer cases |
402
+ | `snow_create_devops_pipeline` | Create DevOps pipelines |
403
+
404
+ ### 1️⃣6️⃣ **Advanced Features Server** (15+ tools)
405
+ 🎯 **Purpose:** Advanced optimization and analysis
406
+
407
+ | Tool | Description |
408
+ |------|-------------|
409
+ | `snow_batch_api` | Batch API operations (80% reduction) |
410
+ | `snow_analyze_query` | Query optimization |
411
+ | `snow_detect_code_patterns` | Code pattern detection |
412
+ | `snow_generate_documentation` | Auto-documentation |
413
+
414
+ ### 1️⃣7️⃣ **Local Development Server** (10+ tools)
415
+ 🎯 **Purpose:** Bridge between ServiceNow and Claude Code
416
+
417
+ | Tool | Description |
418
+ |------|-------------|
419
+ | `snow_pull_artifact` | Pull artifacts to local files |
420
+ | `snow_push_artifact` | Push changes back with validation |
421
+ | `snow_validate_artifact_coherence` | Validate relationships |
422
+ | `snow_convert_to_es5` | Convert modern JS to ES5 |
423
+
424
+ ### 1️⃣8️⃣ **Snow-Flow Orchestration Server** (8 tools)
425
+ 🎯 **Purpose:** Multi-agent coordination and task management
426
+
427
+ | Tool | Description |
428
+ |------|-------------|
429
+ | `swarm_init` | Initialize agent swarms |
430
+ | `agent_spawn` | Create specialized agents |
431
+ | `task_orchestrate` | Orchestrate complex tasks |
432
+ | `memory_search` | Search persistent memory |
433
+ | `neural_train` | Train neural networks (TensorFlow.js) |
434
+ | `performance_report` | Generate performance reports |
435
+
436
+ </details>
437
+
438
+ ## 💡 Usage Examples
439
+
440
+ ### 🔍 Basic Queries
320
441
 
321
442
  ```javascript
322
- // In Claude Code with MCP tools
443
+ // Query any table
444
+ await snow_query_table({
445
+ table: 'incident',
446
+ query: 'active=true^priority=1',
447
+ fields: ['number', 'short_description', 'assigned_to'],
448
+ limit: 10
449
+ });
450
+
451
+ // Find users
452
+ await snow_user_lookup({
453
+ name: 'John Doe',
454
+ include_groups: true
455
+ });
456
+ ```
457
+
458
+ ### 🎯 Widget Deployment
459
+
460
+ ```javascript
461
+ // Deploy new widget
323
462
  await snow_deploy({
324
463
  type: 'widget',
325
464
  config: {
326
- name: 'incident_dashboard',
327
- title: 'Incident Dashboard',
465
+ name: 'my_dashboard',
466
+ title: 'My Dashboard',
328
467
  template: '<div>{{data.message}}</div>',
329
- script: 'data.message = "Hello World";',
468
+ server_script: 'data.message = "Hello World";',
330
469
  client_script: 'function($scope) { var c = this; }'
331
470
  }
332
471
  });
333
472
  ```
334
473
 
335
- ### Execute Background Script (ES5 Only)
474
+ ### 📦 Script Execution
336
475
 
337
476
  ```javascript
338
- // IMPORTANT: ServiceNow uses Rhino engine - ES5 only!
477
+ // Execute script with output capture
339
478
  await snow_execute_script_with_output({
340
479
  script: `
341
- var gr = new GlideRecord('incident');
342
- gr.addQuery('active', true);
343
- gr.query();
344
- gs.info('Active incidents: ' + gr.getRowCount());
480
+ var count = new GlideAggregate('incident');
481
+ count.addQuery('active', true);
482
+ count.query();
483
+ if (count.next()) {
484
+ gs.info('Active incidents: ' + count.getAggregate('COUNT'));
485
+ }
345
486
  `
346
487
  });
347
488
  ```
348
489
 
349
- ### Query ServiceNow Tables
490
+ ### 📖 Knowledge Management
350
491
 
351
492
  ```javascript
352
- await snow_query_table({
353
- table: 'incident',
354
- query: 'active=true^priority=1',
355
- fields: ['number', 'short_description', 'assigned_to'],
356
- limit: 10
493
+ // Create knowledge article with KB validation
494
+ await snow_create_knowledge_article({
495
+ kb_knowledge_base: 'IT Knowledge Base',
496
+ short_description: 'How to reset password',
497
+ text: 'Step-by-step guide...',
498
+ keywords: ['password', 'reset', 'security']
357
499
  });
358
500
  ```
359
501
 
360
- ## Commands
502
+ ### 🛒 Catalog Management
361
503
 
362
- ### Core Commands
363
- ```bash
364
- snow-flow swarm "<objective>" # Execute multi-agent swarm
365
- snow-flow auth login # Authenticate with ServiceNow
366
- snow-flow init # Initialize project
367
- ```
504
+ ```javascript
505
+ // Create catalog item with variables
506
+ await snow_create_catalog_item({
507
+ name: 'New Laptop Request',
508
+ category: 'Hardware',
509
+ short_description: 'Request a new laptop'
510
+ });
368
511
 
369
- ### Agent Management
370
- ```bash
371
- snow-flow agent spawn <type> # Create agents
372
- snow-flow agent list # List active agents
512
+ // Create catalog UI policy
513
+ await snow_deploy({
514
+ type: 'catalog_ui_policy',
515
+ config: {
516
+ catalog_item: 'item_sys_id',
517
+ short_description: 'Manager Approval Required',
518
+ conditions: [{
519
+ catalog_variable: 'cost',
520
+ operation: 'greater_than',
521
+ value: '1000'
522
+ }],
523
+ actions: [{
524
+ catalog_variable: 'manager_approval',
525
+ type: 'set_mandatory',
526
+ mandatory: true
527
+ }]
528
+ }
529
+ });
373
530
  ```
374
531
 
375
- ### Task Management
376
- ```bash
377
- snow-flow task create # Create tasks
378
- snow-flow task list # View task queue
379
- ```
532
+ ## 🔧 Commands
380
533
 
381
- ### Memory Operations
382
- ```bash
383
- snow-flow memory store <key> <data> # Store data
384
- snow-flow memory get <key> # Retrieve data
385
- snow-flow memory list # List all keys
386
- ```
534
+ <details>
535
+ <summary><strong>🚀 Core System Commands</strong></summary>
387
536
 
388
- ### SPARC Development Modes
389
- ```bash
390
- snow-flow sparc "<task>" # Orchestrator mode
391
- snow-flow sparc run <mode> "<task>" # Specific mode
392
- snow-flow sparc tdd "<feature>" # Test-driven development
393
- ```
537
+ ### Core System
538
+ - `snow-flow start` - Start orchestration system
539
+ - `snow-flow status` - Show comprehensive system status
540
+ - `snow-flow monitor` - Real-time monitoring dashboard
541
+ - `snow-flow test-connection` - Test ServiceNow connection
394
542
 
395
- Available modes: orchestrator, coder, researcher, tdd, architect, reviewer, debugger, tester, analyzer, optimizer, documenter, designer, innovator, swarm-coordinator, memory-manager, batch-executor, workflow-manager
543
+ ### MCP Management
544
+ - `snow-flow mcp start` - Start MCP servers
545
+ - `snow-flow mcp status` - Show MCP server status
546
+ - `snow-flow mcp tools` - List available MCP tools
396
547
 
397
- ### Swarm Coordination
398
- ```bash
399
- snow-flow swarm "<objective>" [options]
400
- ```
548
+ ### Configuration
549
+ - `snow-flow init` - Initialize Snow-Flow project
550
+ - `snow-flow config show` - Show current configuration
551
+ - `snow-flow config set <key> <value>` - Set configuration value
401
552
 
402
- Options:
403
- - `--strategy` (research, development, analysis, testing, optimization, maintenance)
404
- - `--mode` (centralized, distributed, hierarchical, mesh, hybrid)
405
- - `--max-agents <n>` (default: 5)
406
- - `--parallel` Enable parallel execution
407
- - `--monitor` Real-time monitoring
408
- - `--output <format>` (json, sqlite, csv, html)
553
+ ### Development
554
+ - `snow-flow agent spawn <type>` - Create AI agents
555
+ - `snow-flow task create` - Create tasks
556
+ - `snow-flow memory store <key> <data>` - Store persistent data
409
557
 
410
- ## Troubleshooting
558
+ ### Orchestration
559
+ - `snow-flow swarm "<objective>"` - Multi-agent coordination
560
+ - `snow-flow sparc "<task>"` - SPARC mode orchestration
561
+ - `snow-flow sparc tdd "<feature>"` - Test-driven development
411
562
 
412
- ### Common Issues
563
+ </details>
413
564
 
414
- #### 1. MCP Server Not Responding
415
- ```bash
416
- # Check MCP server status
417
- snow-flow mcp status
565
+ ## 🛠️ Troubleshooting
418
566
 
419
- # Restart MCP servers
420
- snow-flow mcp restart
567
+ <details>
568
+ <summary><strong>🆘 Common Issues & Solutions</strong></summary>
421
569
 
422
- # Debug mode
423
- snow-flow mcp debug
424
- ```
570
+ ### Common Issues
425
571
 
426
- #### 2. Authentication Failed
572
+ **Permission Errors**
427
573
  ```bash
428
- # Clear cached credentials
429
- snow-flow auth logout
430
-
431
- # Re-authenticate
432
- snow-flow auth login
433
-
434
- # Verify OAuth configuration
435
- snow-flow auth test
574
+ Error: "dangerously skip permissions"
575
+ Solution: Run 'claude login' before starting Claude Code
436
576
  ```
437
577
 
438
- #### 3. Permission Errors in Claude Code
439
- Always run `claude login` before starting Claude Code with MCP servers.
440
-
441
- #### 4. ES5 Syntax Errors
442
- ServiceNow uses Rhino engine. Always use ES5 syntax:
443
- - Use `var` instead of `const/let`
444
- - Use `function()` instead of arrow functions
445
- - Use string concatenation instead of template literals
446
- - Use traditional for loops instead of `for...of`
447
-
448
- ### Debug Commands
578
+ **Connection Failed**
449
579
  ```bash
450
- # Enable verbose logging
451
- export DEBUG=snow-flow:*
452
-
453
- # Check version and help
454
- snow-flow --version
455
- snow-flow --help
456
-
457
- # Test authentication
458
- snow-flow auth login
459
- snow-flow auth status
460
-
461
- # Re-initialize if needed
462
- snow-flow init
580
+ Error: "Unable to connect to ServiceNow"
581
+ Solution: Check .env credentials and instance URL
463
582
  ```
464
583
 
465
- ## Project Structure
466
-
467
- ```
468
- snow-flow/
469
- ├── src/
470
- │ ├── mcp/ # 17 MCP server implementations
471
- │ ├── queen/ # Queen agent orchestration
472
- │ ├── utils/ # Utilities and helpers
473
- │ └── types/ # TypeScript definitions
474
- ├── .snow-flow/ # Configuration directory
475
- ├── .claude/ # MCP server configs
476
- ├── website/ # Documentation website
477
- └── package.json # NPM package configuration
584
+ **MCP Server Not Found**
585
+ ```bash
586
+ Error: "MCP server not responding"
587
+ Solution: Restart Claude Code with --mcp-config flag
478
588
  ```
479
589
 
480
- ## Development
481
-
590
+ **Large Widget Errors**
482
591
  ```bash
483
- # Install dependencies
484
- npm install
485
-
486
- # Run tests
487
- npm test
488
-
489
- # Lint code
490
- npm run lint
491
-
492
- # Type checking
493
- npm run typecheck
494
-
495
- # Build project
496
- npm run build
497
-
498
- # Development mode
499
- npm run dev
592
+ Error: "Content exceeds maximum allowed tokens"
593
+ Solution: Use snow_pull_artifact instead of snow_query_table
500
594
  ```
501
595
 
502
- ## Support
503
-
504
- - GitHub Issues: https://github.com/groeimetai/snow-flow/issues
505
- - Documentation: https://snow-flow.ai
506
- - ServiceNow Community: https://community.servicenow.com
507
-
508
- ## License
509
-
510
- MIT License - see LICENSE file for details.
511
-
512
- ## Version
513
-
514
- Current version: 3.4.38
515
-
516
- ---
517
-
518
- Snow-Flow - ServiceNow Development Automation with AI
596
+ ### Debugging Tips
597
+
598
+ 1. **Check Logs**
599
+ ```bash
600
+ # View MCP server logs
601
+ tail -f .snow-flow/logs/mcp-*.log
602
+ ```
603
+
604
+ 2. **Test Connection**
605
+ ```bash
606
+ # Verify ServiceNow connectivity
607
+ snow-flow test-connection
608
+ ```
609
+
610
+ 3. **Validate Configuration**
611
+ ```bash
612
+ # Check all settings
613
+ snow-flow config validate
614
+ ```
615
+
616
+ ### Getting Help
617
+
618
+ - GitHub Issues: [https://github.com/groeimetai/snow-flow/issues](https://github.com/groeimetai/snow-flow/issues)
619
+ - Documentation: Run `snow-flow --help`
620
+ - MCP Server Logs: Check `.snow-flow/logs/`
621
+
622
+ </details>
623
+
624
+ ## 📄 License
625
+
626
+ <div align="center">
627
+ <p>MIT License. See <a href="LICENSE">LICENSE</a> file for details.</p>
628
+ <p>Made with ❤️ by the Snow-Flow Team</p>
629
+ <br/>
630
+ <p>
631
+ <a href="https://github.com/groeimetai/snow-flow">GitHub</a> •
632
+ <a href="https://www.npmjs.com/package/snow-flow">NPM</a> •
633
+ <a href="https://groeimetai.github.io/snow-flow/">Documentation</a>
634
+ </p>
635
+ </div>