snow-flow 3.4.36 â 3.5.0
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 +414 -287
- package/dist/cli/deploy-artifact.js +2 -2
- package/dist/index.d.ts +4 -0
- package/dist/index.js +10 -2
- package/dist/mcp/enhancements/smart-query-enhancement.d.ts +49 -0
- package/dist/mcp/enhancements/smart-query-enhancement.js +233 -0
- package/dist/mcp/servicenow-deployment-mcp.js +1 -1
- package/dist/mcp/servicenow-local-development-mcp.d.ts +48 -0
- package/dist/mcp/servicenow-local-development-mcp.js +570 -0
- package/dist/mcp/servicenow-mcp-server.js +2 -2
- package/dist/queen/agent-factory.js +134 -52
- package/dist/queen/queen-knowledge-base.d.ts +151 -0
- package/dist/queen/queen-knowledge-base.js +283 -0
- package/dist/queen/servicenow-queen.d.ts +129 -2
- package/dist/queen/servicenow-queen.js +1069 -618
- package/dist/services/widget-deployment-service.d.ts +1 -1
- package/dist/services/widget-deployment-service.js +1 -1
- package/dist/templates/claude-md-template.d.ts +1 -1
- package/dist/templates/claude-md-template.js +2 -2
- package/dist/types/servicenow.types.d.ts +1 -1
- package/dist/utils/artifact-local-sync.d.ts +115 -0
- package/dist/utils/artifact-local-sync.js +705 -0
- package/dist/utils/artifact-sync/artifact-registry.d.ts +66 -0
- package/dist/utils/artifact-sync/artifact-registry.js +450 -0
- package/dist/utils/artifact-sync/index.d.ts +33 -0
- package/dist/utils/artifact-sync/index.js +52 -0
- package/dist/utils/dependency-detector.d.ts +1 -1
- package/dist/utils/dependency-detector.js +1 -1
- package/dist/utils/mcp-tool-registry.js +109 -0
- package/dist/utils/servicenow-client.d.ts +1 -1
- package/dist/utils/servicenow-client.js +4 -8
- package/dist/utils/smart-field-fetcher.d.ts +68 -0
- package/dist/utils/smart-field-fetcher.js +395 -0
- package/package.json +2 -2
- package/website/.dockerignore +64 -0
- package/website/Dockerfile +36 -0
- package/website/README.md +40 -1
- package/website/cloudbuild.yaml +69 -0
- package/website/components/README.md +419 -0
- package/website/components/code-display/CodeDisplay.css +583 -0
- package/website/components/code-display/CodeDisplay.html +200 -0
- package/website/components/code-display/CodeDisplay.js +375 -0
- package/website/components/code-display/CodeDisplay.jsx +268 -0
- package/website/components/demo/ComponentLibraryDemo.html +845 -0
- package/website/components/feature-cards/FeatureCards.css +573 -0
- package/website/components/feature-cards/FeatureCards.html +247 -0
- package/website/components/feature-cards/FeatureCards.js +382 -0
- package/website/components/feature-cards/FeatureCards.jsx +235 -0
- package/website/components/hero/Hero.css +558 -0
- package/website/components/hero/Hero.html +98 -0
- package/website/components/hero/Hero.js +415 -0
- package/website/components/hero/Hero.jsx +214 -0
- package/website/components/interactive/InteractiveElements.css +776 -0
- package/website/components/interactive/InteractiveElements.html +283 -0
- package/website/components/interactive/InteractiveElements.js +489 -0
- package/website/components/interactive/InteractiveElements.jsx +444 -0
- package/website/components/layout/LayoutComponents.css +697 -0
- package/website/components/layout/LayoutComponents.html +374 -0
- package/website/components/layout/LayoutComponents.js +447 -0
- package/website/components/layout/LayoutComponents.jsx +379 -0
- package/website/components/navigation/Navigation.css +383 -0
- package/website/components/navigation/Navigation.html +89 -0
- package/website/components/navigation/Navigation.js +248 -0
- package/website/components/navigation/Navigation.jsx +124 -0
- package/website/css/animations.css +854 -0
- package/website/css/style.css +1010 -924
- package/website/index.html +728 -412
- package/website/js/animations.js +707 -0
- package/website/js/main.js +333 -381
- package/website/mcp-servers.html +310 -0
- package/website/nginx.conf +116 -0
- package/website/service.yaml +61 -0
package/README.md
CHANGED
|
@@ -1,391 +1,518 @@
|
|
|
1
|
-
# Snow-Flow
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
##
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
-
|
|
9
|
-
-
|
|
10
|
-
-
|
|
11
|
-
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
- **ZERO MANUAL WORK**: All systematic errors from user feedback now automatically handled
|
|
17
|
-
- **COMPREHENSIVE TESTING**: Enhanced flow testing with Business Rule fallback detection
|
|
18
|
-
|
|
19
|
-
### đ Enhanced Swarm Command (v1.1.42+)
|
|
20
|
-
Most intelligent features are now **enabled by default** - ÊÊn command voor alles!
|
|
21
|
-
- **DEFAULT TRUE**: `--smart-discovery`, `--live-testing`, `--auto-deploy`, `--auto-rollback`, `--shared-memory`, `--progress-monitoring`
|
|
22
|
-
- **INTELLIGENT ORCHESTRATION**: Uses `snow_orchestrate_development` MCP tool automatically
|
|
23
|
-
- **NO FLAGS NEEDED**: Just run `snow-flow swarm "create widget"` and everything works!
|
|
24
|
-
|
|
25
|
-
### đ Real-Time ServiceNow Integration (v1.1.41+)
|
|
26
|
-
- **LIVE VALIDATION**: `snow_validate_live_connection` - real-time auth and permission checking
|
|
27
|
-
- **SMART PREVENTION**: `snow_discover_existing_flows` - prevents duplicate flows
|
|
28
|
-
- **LIVE TESTING**: `snow_test_flow_execution` - real flow testing in live instances
|
|
29
|
-
- **BATCH VALIDATION**: `batch_deployment_validator` - comprehensive multi-artifact validation
|
|
30
|
-
- **AUTO ROLLBACK**: `deployment_rollback_manager` - automatic rollback with backup creation
|
|
31
|
-
|
|
32
|
-
## đ Key Features
|
|
33
|
-
|
|
34
|
-
### đ¤ 11 Specialized MCP Servers
|
|
35
|
-
Each server provides autonomous capabilities for different aspects of ServiceNow development:
|
|
36
|
-
|
|
37
|
-
1. **Deployment MCP** - Autonomous widget and application deployment
|
|
38
|
-
2. **Update Set MCP** - Professional change tracking and deployment management
|
|
39
|
-
3. **Intelligent MCP** - AI-powered artifact discovery and editing
|
|
40
|
-
4. **Graph Memory MCP** - Relationship tracking and impact analysis
|
|
41
|
-
5. **Platform Development MCP** - Development workflow automation
|
|
42
|
-
6. **Integration MCP** - Third-party system integration
|
|
43
|
-
7. **Operations MCP** - Operations and monitoring management
|
|
44
|
-
8. **Automation MCP** - Workflow and process automation
|
|
45
|
-
9. **Security & Compliance MCP** - Security auditing and compliance
|
|
46
|
-
10. **Reporting & Analytics MCP** - Data _analysis and reporting
|
|
47
|
-
11. **Memory MCP** - Multi-agent coordination and todo management
|
|
48
|
-
|
|
49
|
-
### đ¯ Core Capabilities
|
|
50
|
-
|
|
51
|
-
- **Natural Language Processing**: Create complex ServiceNow artifacts using plain English/Dutch commands
|
|
52
|
-
- **Intelligent Decision Making**: Automatically determines optimal architecture (flow vs subflow)
|
|
53
|
-
- **Zero Configuration**: All values dynamically discovered from your ServiceNow instance
|
|
54
|
-
- **Autonomous Deployment**: Direct deployment to ServiceNow with automatic error handling
|
|
55
|
-
- **Update Set Management**: Professional change tracking like ServiceNow pros use
|
|
56
|
-
- **Global Scope Strategy**: Intelligent scope selection with fallback mechanisms
|
|
57
|
-
- **Multi-Agent Coordination**: Parallel execution for complex tasks
|
|
58
|
-
|
|
59
|
-
## đ Quick Start
|
|
1
|
+
# Snow-Flow
|
|
2
|
+
|
|
3
|
+
ServiceNow development framework with AI-powered automation through 17 MCP servers and 200+ specialized tools.
|
|
4
|
+
|
|
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)
|
|
14
|
+
|
|
15
|
+
## Installation
|
|
60
16
|
|
|
61
17
|
### Prerequisites
|
|
62
|
-
- Node.js 18
|
|
18
|
+
- Node.js 18 or higher
|
|
19
|
+
- npm 9 or higher
|
|
63
20
|
- ServiceNow instance with admin access
|
|
64
|
-
-
|
|
21
|
+
- Claude Code desktop application
|
|
65
22
|
|
|
66
|
-
###
|
|
23
|
+
### Install from NPM
|
|
67
24
|
|
|
68
25
|
```bash
|
|
69
|
-
# Install
|
|
26
|
+
# Install globally
|
|
70
27
|
npm install -g snow-flow
|
|
71
28
|
|
|
72
|
-
#
|
|
73
|
-
snow-flow
|
|
29
|
+
# Verify installation
|
|
30
|
+
snow-flow --version
|
|
74
31
|
```
|
|
75
32
|
|
|
76
|
-
|
|
33
|
+
### Install from Source
|
|
34
|
+
|
|
77
35
|
```bash
|
|
78
|
-
# Clone
|
|
36
|
+
# Clone repository
|
|
79
37
|
git clone https://github.com/groeimetai/snow-flow.git
|
|
80
38
|
cd snow-flow
|
|
81
39
|
|
|
82
40
|
# Install dependencies
|
|
83
41
|
npm install
|
|
84
42
|
|
|
85
|
-
# Build
|
|
43
|
+
# Build project
|
|
86
44
|
npm run build
|
|
87
45
|
|
|
88
46
|
# Link globally (optional)
|
|
89
47
|
npm link
|
|
90
48
|
```
|
|
91
49
|
|
|
92
|
-
|
|
50
|
+
## Configuration
|
|
51
|
+
|
|
52
|
+
### Step 1: Initialize Snow-Flow
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
# Create project directory
|
|
56
|
+
mkdir my-servicenow-project
|
|
57
|
+
cd my-servicenow-project
|
|
58
|
+
|
|
59
|
+
# Initialize Snow-Flow
|
|
60
|
+
snow-flow init
|
|
61
|
+
```
|
|
62
|
+
|
|
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
|
|
68
|
+
|
|
69
|
+
### Step 2: Configure ServiceNow Credentials
|
|
70
|
+
|
|
71
|
+
Edit the `.env` file with your ServiceNow instance details:
|
|
93
72
|
|
|
94
|
-
1. Create a `.env` file in the project root:
|
|
95
73
|
```env
|
|
74
|
+
# ServiceNow Instance Configuration
|
|
96
75
|
SNOW_INSTANCE=your-instance.service-now.com
|
|
76
|
+
SNOW_USERNAME=admin.username
|
|
77
|
+
SNOW_PASSWORD=admin.password
|
|
78
|
+
|
|
79
|
+
# OAuth Configuration (recommended for production)
|
|
97
80
|
SNOW_CLIENT_ID=your-oauth-client-id
|
|
98
81
|
SNOW_CLIENT_SECRET=your-oauth-client-secret
|
|
99
|
-
SNOW_USERNAME=your-username
|
|
100
|
-
SNOW_PASSWORD=your-password
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
2. Set up OAuth in ServiceNow (see [SERVICENOW-OAUTH-SETUP.md](./SERVICENOW-OAUTH-SETUP.md))
|
|
104
82
|
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
snow-flow auth login
|
|
83
|
+
# Optional: Claude API Key
|
|
84
|
+
ANTHROPIC_API_KEY=your-claude-api-key
|
|
108
85
|
```
|
|
109
86
|
|
|
110
|
-
###
|
|
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
|
|
111
98
|
|
|
112
|
-
|
|
99
|
+
### Step 4: Authenticate
|
|
113
100
|
|
|
114
101
|
```bash
|
|
115
|
-
|
|
102
|
+
# Login to ServiceNow
|
|
103
|
+
snow-flow auth login
|
|
116
104
|
|
|
117
|
-
#
|
|
118
|
-
|
|
119
|
-
# Press Y to launch Claude Code with all MCP servers ready to use!
|
|
105
|
+
# Verify connection
|
|
106
|
+
snow-flow auth status
|
|
120
107
|
```
|
|
121
108
|
|
|
122
|
-
|
|
123
|
-
- â
Configured with correct paths for global npm installations
|
|
124
|
-
- â
Registered in Claude Code's settings
|
|
125
|
-
- â
Activated without manual approval steps
|
|
126
|
-
- â
Ready to use immediately after initialization
|
|
127
|
-
|
|
128
|
-
If you need to manually activate MCP servers later:
|
|
129
|
-
```bash
|
|
130
|
-
# For Mac/Linux:
|
|
131
|
-
claude --mcp-config .mcp.json .
|
|
109
|
+
## Claude Code Setup
|
|
132
110
|
|
|
133
|
-
|
|
134
|
-
claude.exe --mcp-config .mcp.json .
|
|
135
|
-
```
|
|
111
|
+
### Fix Permission Errors
|
|
136
112
|
|
|
137
|
-
|
|
113
|
+
**IMPORTANT:** If you encounter "dangerously skip permissions" errors in Claude Code, you must first authenticate with Claude:
|
|
138
114
|
|
|
139
|
-
### Create a Complex Flow with Natural Language
|
|
140
115
|
```bash
|
|
141
|
-
|
|
142
|
-
|
|
116
|
+
# 1. First, login to Claude (required for MCP servers to work)
|
|
117
|
+
claude login
|
|
143
118
|
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
snow-flow sparc "Create and deploy a widget that shows all critical incidents with real-time updates"
|
|
119
|
+
# 2. Then start Claude Code with MCP servers
|
|
120
|
+
claude --mcp-config .claude/claude_desktop_config.json
|
|
147
121
|
```
|
|
148
122
|
|
|
149
|
-
|
|
150
|
-
```bash
|
|
151
|
-
# Most intelligent features are enabled by default!
|
|
152
|
-
snow-flow swarm "Build a complete incident management system with dashboard, workflows, and notifications"
|
|
153
|
-
|
|
154
|
-
# Default settings:
|
|
155
|
-
# â
--smart-discovery (true) - Reuses existing artifacts
|
|
156
|
-
# â
--live-testing (true) - Tests in real-time
|
|
157
|
-
# â
--auto-deploy (true) - Deploys automatically (safe with update sets)
|
|
158
|
-
# â
--auto-rollback (true) - Rollbacks on failures
|
|
159
|
-
# â
--shared-memory (true) - Agents share context
|
|
160
|
-
# â
--progress-monitoring (true) - Real-time status
|
|
161
|
-
|
|
162
|
-
# Add --auto-permissions to enable automatic permission escalation
|
|
163
|
-
snow-flow swarm "Create enterprise workflow" --auto-permissions
|
|
164
|
-
|
|
165
|
-
# Disable specific features with --no- prefix
|
|
166
|
-
snow-flow swarm "Test workflow" --no-auto-deploy --no-live-testing
|
|
167
|
-
```
|
|
123
|
+
The `claude login` step is crucial - without it, MCP servers cannot authenticate with ServiceNow.
|
|
168
124
|
|
|
169
|
-
###
|
|
170
|
-
|
|
171
|
-
snow-flow
|
|
172
|
-
```
|
|
125
|
+
### Automatic MCP Server Activation
|
|
126
|
+
|
|
127
|
+
During `snow-flow init`, you'll be prompted to automatically activate all MCP servers:
|
|
173
128
|
|
|
174
|
-
### Create Flows in Dutch
|
|
175
129
|
```bash
|
|
176
|
-
|
|
130
|
+
đ Would you like to start Claude Code with MCP servers? (Y/n)
|
|
177
131
|
```
|
|
178
132
|
|
|
179
|
-
|
|
133
|
+
Selecting **Y** will:
|
|
134
|
+
- Configure all 17 MCP servers
|
|
135
|
+
- Auto-approve server permissions
|
|
136
|
+
- Launch Claude Code with servers ready
|
|
180
137
|
|
|
181
|
-
###
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
- Reusability assessment
|
|
185
|
-
- Performance optimization
|
|
186
|
-
- Maintainability considerations
|
|
138
|
+
### Manual MCP Server Activation
|
|
139
|
+
|
|
140
|
+
If you need to manually activate MCP servers:
|
|
187
141
|
|
|
188
|
-
### Update Set Management
|
|
189
|
-
Professional change tracking just like ServiceNow developers use:
|
|
190
142
|
```bash
|
|
191
|
-
#
|
|
192
|
-
|
|
143
|
+
# Mac/Linux
|
|
144
|
+
claude --mcp-config .claude/claude_desktop_config.json
|
|
193
145
|
|
|
194
|
-
#
|
|
195
|
-
|
|
146
|
+
# Windows
|
|
147
|
+
claude.exe --mcp-config .claude/claude_desktop_config.json
|
|
196
148
|
```
|
|
197
149
|
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
-
|
|
207
|
-
-
|
|
208
|
-
-
|
|
209
|
-
-
|
|
210
|
-
|
|
211
|
-
|
|
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
|
|
212
320
|
|
|
213
|
-
### Catalog Item Search with Fuzzy Matching
|
|
214
|
-
Find catalog items even when you don't know the exact name:
|
|
215
321
|
```javascript
|
|
216
322
|
// In Claude Code with MCP tools
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
323
|
+
await snow_deploy({
|
|
324
|
+
type: 'widget',
|
|
325
|
+
config: {
|
|
326
|
+
name: 'incident_dashboard',
|
|
327
|
+
title: 'Incident Dashboard',
|
|
328
|
+
template: '<div>{{data.message}}</div>',
|
|
329
|
+
script: 'data.message = "Hello World";',
|
|
330
|
+
client_script: 'function($scope) { var c = this; }'
|
|
331
|
+
}
|
|
222
332
|
});
|
|
223
333
|
```
|
|
224
334
|
|
|
225
|
-
###
|
|
226
|
-
|
|
335
|
+
### Execute Background Script (ES5 Only)
|
|
336
|
+
|
|
227
337
|
```javascript
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
}
|
|
237
|
-
],
|
|
238
|
-
simulate_approvals: true, // Auto-approves
|
|
239
|
-
cleanup_after_test: true // Removes test data
|
|
338
|
+
// IMPORTANT: ServiceNow uses Rhino engine - ES5 only!
|
|
339
|
+
await snow_execute_script_with_output({
|
|
340
|
+
script: `
|
|
341
|
+
var gr = new GlideRecord('incident');
|
|
342
|
+
gr.addQuery('active', true);
|
|
343
|
+
gr.query();
|
|
344
|
+
gs.info('Active incidents: ' + gr.getRowCount());
|
|
345
|
+
`
|
|
240
346
|
});
|
|
241
347
|
```
|
|
242
348
|
|
|
243
|
-
###
|
|
244
|
-
|
|
349
|
+
### Query ServiceNow Tables
|
|
350
|
+
|
|
245
351
|
```javascript
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
{
|
|
252
|
-
catalog_variable: "phone_model",
|
|
253
|
-
flow_input: "device_type"
|
|
254
|
-
},
|
|
255
|
-
{
|
|
256
|
-
catalog_variable: "user_department",
|
|
257
|
-
flow_input: "department"
|
|
258
|
-
}
|
|
259
|
-
],
|
|
260
|
-
trigger_condition: 'current.stage == "request_approved"',
|
|
261
|
-
execution_options: {
|
|
262
|
-
run_as: "user", // đ SEC-001 FIX: Default to 'user' to prevent privilege escalation
|
|
263
|
-
wait_for_completion: true
|
|
264
|
-
},
|
|
265
|
-
test_link: true // Creates test request
|
|
352
|
+
await snow_query_table({
|
|
353
|
+
table: 'incident',
|
|
354
|
+
query: 'active=true^priority=1',
|
|
355
|
+
fields: ['number', 'short_description', 'assigned_to'],
|
|
356
|
+
limit: 10
|
|
266
357
|
});
|
|
267
358
|
```
|
|
268
359
|
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
{ type: "script", data: scriptData }
|
|
277
|
-
],
|
|
278
|
-
transaction_mode: true, // All-or-nothing deployment
|
|
279
|
-
parallel: true, // Deploy simultaneously
|
|
280
|
-
dry_run: false
|
|
281
|
-
});
|
|
360
|
+
## Commands
|
|
361
|
+
|
|
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
|
|
282
367
|
```
|
|
283
368
|
|
|
284
|
-
|
|
369
|
+
### Agent Management
|
|
370
|
+
```bash
|
|
371
|
+
snow-flow agent spawn <type> # Create agents
|
|
372
|
+
snow-flow agent list # List active agents
|
|
373
|
+
```
|
|
285
374
|
|
|
375
|
+
### Task Management
|
|
376
|
+
```bash
|
|
377
|
+
snow-flow task create # Create tasks
|
|
378
|
+
snow-flow task list # View task queue
|
|
286
379
|
```
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
380
|
+
|
|
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
|
+
```
|
|
387
|
+
|
|
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
|
|
299
393
|
```
|
|
300
394
|
|
|
301
|
-
|
|
395
|
+
Available modes: orchestrator, coder, researcher, tdd, architect, reviewer, debugger, tester, analyzer, optimizer, documenter, designer, innovator, swarm-coordinator, memory-manager, batch-executor, workflow-manager
|
|
302
396
|
|
|
397
|
+
### Swarm Coordination
|
|
303
398
|
```bash
|
|
304
|
-
|
|
305
|
-
|
|
399
|
+
snow-flow swarm "<objective>" [options]
|
|
400
|
+
```
|
|
306
401
|
|
|
307
|
-
|
|
308
|
-
|
|
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)
|
|
309
409
|
|
|
310
|
-
|
|
311
|
-
npm run typecheck
|
|
410
|
+
## Troubleshooting
|
|
312
411
|
|
|
313
|
-
|
|
314
|
-
npm run dev
|
|
412
|
+
### Common Issues
|
|
315
413
|
|
|
316
|
-
|
|
317
|
-
|
|
414
|
+
#### 1. MCP Server Not Responding
|
|
415
|
+
```bash
|
|
416
|
+
# Check MCP server status
|
|
417
|
+
snow-flow mcp status
|
|
418
|
+
|
|
419
|
+
# Restart MCP servers
|
|
420
|
+
snow-flow mcp restart
|
|
421
|
+
|
|
422
|
+
# Debug mode
|
|
423
|
+
snow-flow mcp debug
|
|
318
424
|
```
|
|
319
425
|
|
|
320
|
-
|
|
426
|
+
#### 2. Authentication Failed
|
|
427
|
+
```bash
|
|
428
|
+
# Clear cached credentials
|
|
429
|
+
snow-flow auth logout
|
|
321
430
|
|
|
322
|
-
|
|
323
|
-
-
|
|
324
|
-
- [Update Set Guide](./UPDATE_SET_DEPLOYMENT_GUIDE.md) - Professional change management
|
|
325
|
-
- [API Integration Guide](./API_INTEGRATION_GUIDE.md) - ServiceNow API details
|
|
431
|
+
# Re-authenticate
|
|
432
|
+
snow-flow auth login
|
|
326
433
|
|
|
327
|
-
|
|
434
|
+
# Verify OAuth configuration
|
|
435
|
+
snow-flow auth test
|
|
436
|
+
```
|
|
328
437
|
|
|
329
|
-
|
|
438
|
+
#### 3. Permission Errors in Claude Code
|
|
439
|
+
Always run `claude login` before starting Claude Code with MCP servers.
|
|
330
440
|
|
|
331
|
-
|
|
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`
|
|
332
447
|
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
-
|
|
448
|
+
### Debug Commands
|
|
449
|
+
```bash
|
|
450
|
+
# Enable verbose logging
|
|
451
|
+
export DEBUG=snow-flow:*
|
|
337
452
|
|
|
338
|
-
|
|
453
|
+
# Check version and help
|
|
454
|
+
snow-flow --version
|
|
455
|
+
snow-flow --help
|
|
339
456
|
|
|
340
|
-
|
|
341
|
-
-
|
|
342
|
-
-
|
|
343
|
-
- Ensure consistency across implementations
|
|
344
|
-
- Reduce development time by 80%
|
|
457
|
+
# Test authentication
|
|
458
|
+
snow-flow auth login
|
|
459
|
+
snow-flow auth status
|
|
345
460
|
|
|
346
|
-
|
|
347
|
-
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
461
|
+
# Re-initialize if needed
|
|
462
|
+
snow-flow init
|
|
463
|
+
```
|
|
464
|
+
|
|
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
|
|
478
|
+
```
|
|
479
|
+
|
|
480
|
+
## Development
|
|
481
|
+
|
|
482
|
+
```bash
|
|
483
|
+
# Install dependencies
|
|
484
|
+
npm install
|
|
351
485
|
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
- Professional change tracking
|
|
355
|
-
- Automated testing and validation
|
|
356
|
-
- Simplified migration between instances
|
|
486
|
+
# Run tests
|
|
487
|
+
npm test
|
|
357
488
|
|
|
358
|
-
|
|
489
|
+
# Lint code
|
|
490
|
+
npm run lint
|
|
359
491
|
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
- [ ] Multi-instance synchronization
|
|
363
|
-
- [ ] AI-powered code review
|
|
364
|
-
- [ ] Automated testing framework
|
|
365
|
-
- [ ] Performance optimization recommendations
|
|
492
|
+
# Type checking
|
|
493
|
+
npm run typecheck
|
|
366
494
|
|
|
367
|
-
|
|
495
|
+
# Build project
|
|
496
|
+
npm run build
|
|
497
|
+
|
|
498
|
+
# Development mode
|
|
499
|
+
npm run dev
|
|
500
|
+
```
|
|
368
501
|
|
|
369
|
-
|
|
370
|
-
- **Interactive Prompt**: During `snow-flow init`, you're now prompted to automatically start Claude Code with all MCP servers
|
|
371
|
-
- **Zero Manual Steps**: No more manual MCP approval in Claude Code - servers load automatically using `claude --mcp-config`
|
|
372
|
-
- **Cross-Platform Support**: Works on Mac, Linux, and Windows with platform-specific activation scripts
|
|
373
|
-
- **Instant Availability**: All 11 ServiceNow MCP servers are immediately available in Claude Code after initialization
|
|
502
|
+
## Support
|
|
374
503
|
|
|
375
|
-
|
|
376
|
-
-
|
|
377
|
-
-
|
|
378
|
-
- **v1.1.22**: Verified global npm installation correctly registers all MCP servers
|
|
379
|
-
- **v1.1.20**: Added enabledMcpjsonServers to ensure MCP visibility in Claude Code
|
|
504
|
+
- GitHub Issues: https://github.com/groeimetai/snow-flow/issues
|
|
505
|
+
- Documentation: https://snow-flow.ai
|
|
506
|
+
- ServiceNow Community: https://community.servicenow.com
|
|
380
507
|
|
|
381
|
-
##
|
|
508
|
+
## License
|
|
382
509
|
|
|
383
|
-
|
|
510
|
+
MIT License - see LICENSE file for details.
|
|
384
511
|
|
|
385
|
-
##
|
|
512
|
+
## Version
|
|
386
513
|
|
|
387
|
-
|
|
514
|
+
Current version: 3.4.38
|
|
388
515
|
|
|
389
516
|
---
|
|
390
517
|
|
|
391
|
-
|
|
518
|
+
Snow-Flow - ServiceNow Development Automation with AI
|