snow-flow 3.4.14 → 3.4.15
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/.mcp.json.template +91 -31
- package/README.md +597 -96
- package/package.json +2 -2
- package/website/README.md +152 -0
- package/website/css/api-docs.css +366 -0
- package/website/css/style.css +809 -0
- package/website/index.html +750 -0
- package/website/js/main.js +323 -0
- package/website/netlify.toml +37 -0
- package/website/package.json +49 -0
- package/website/vercel.json +54 -0
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "snow-flow",
|
|
3
|
-
"version": "3.4.
|
|
4
|
-
"description": "ServiceNow development framework with MCP server integration. Executes background scripts using ES5 JavaScript only (ServiceNow Rhino engine requirement). Provides
|
|
3
|
+
"version": "3.4.15",
|
|
4
|
+
"description": "ServiceNow development framework with MCP server integration. Executes background scripts using ES5 JavaScript only (ServiceNow Rhino engine requirement). Provides 17 MCP servers for complete ServiceNow operations including widget deployment with coherence validation, table operations, script execution, machine learning, advanced features, and comprehensive platform management.",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"type": "commonjs",
|
|
7
7
|
"bin": {
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
# Snow-Flow Website 🏔️❄️
|
|
2
|
+
|
|
3
|
+
Official documentation website for Snow-Flow - Advanced ServiceNow Development Framework.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
This website provides comprehensive documentation for Snow-Flow, including:
|
|
8
|
+
- Complete feature overview
|
|
9
|
+
- Installation guides
|
|
10
|
+
- API documentation for all 16+ MCP servers
|
|
11
|
+
- 200+ tool references
|
|
12
|
+
- Real-world examples
|
|
13
|
+
- Best practices
|
|
14
|
+
|
|
15
|
+
## Structure
|
|
16
|
+
|
|
17
|
+
```
|
|
18
|
+
website/
|
|
19
|
+
├── index.html # Main landing page
|
|
20
|
+
├── css/
|
|
21
|
+
│ ├── style.css # Main styles
|
|
22
|
+
│ └── api-docs.css # API documentation styles
|
|
23
|
+
├── js/
|
|
24
|
+
│ └── main.js # Interactive functionality
|
|
25
|
+
├── docs/
|
|
26
|
+
│ └── api-full.html # Complete API reference
|
|
27
|
+
├── examples/ # Code examples (to be added)
|
|
28
|
+
└── images/ # Images and assets
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Features
|
|
32
|
+
|
|
33
|
+
- **Responsive Design**: Works perfectly on desktop, tablet, and mobile
|
|
34
|
+
- **Interactive Navigation**: Smooth scrolling and active section highlighting
|
|
35
|
+
- **Code Highlighting**: Syntax highlighting with Prism.js
|
|
36
|
+
- **Copy Code**: One-click code copying
|
|
37
|
+
- **Search Functionality**: Search through MCP tools
|
|
38
|
+
- **Animation**: Smooth animations and transitions
|
|
39
|
+
- **Dark Theme Code Blocks**: Easy-to-read code examples
|
|
40
|
+
|
|
41
|
+
## Local Development
|
|
42
|
+
|
|
43
|
+
To run the website locally:
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
# Using Python (Python 3)
|
|
47
|
+
python -m http.server 8000
|
|
48
|
+
|
|
49
|
+
# Using Python (Python 2)
|
|
50
|
+
python -m SimpleHTTPServer 8000
|
|
51
|
+
|
|
52
|
+
# Using Node.js
|
|
53
|
+
npx http-server
|
|
54
|
+
|
|
55
|
+
# Using PHP
|
|
56
|
+
php -S localhost:8000
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Then open `http://localhost:8000` in your browser.
|
|
60
|
+
|
|
61
|
+
## Deployment
|
|
62
|
+
|
|
63
|
+
The website is static HTML/CSS/JS and can be deployed to any static hosting service:
|
|
64
|
+
|
|
65
|
+
### GitHub Pages
|
|
66
|
+
1. Push to GitHub repository
|
|
67
|
+
2. Enable GitHub Pages in repository settings
|
|
68
|
+
3. Select source branch and folder
|
|
69
|
+
|
|
70
|
+
### Netlify
|
|
71
|
+
1. Connect GitHub repository
|
|
72
|
+
2. Set build settings (no build command needed)
|
|
73
|
+
3. Deploy
|
|
74
|
+
|
|
75
|
+
### Vercel
|
|
76
|
+
```bash
|
|
77
|
+
npx vercel
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### Traditional Hosting
|
|
81
|
+
Simply upload all files to your web server's public directory.
|
|
82
|
+
|
|
83
|
+
## Adding Examples
|
|
84
|
+
|
|
85
|
+
To add your own ServiceNow examples:
|
|
86
|
+
|
|
87
|
+
1. Navigate to the "Examples" section
|
|
88
|
+
2. Find the "Your Examples" placeholder card
|
|
89
|
+
3. Add your code examples in the designated area
|
|
90
|
+
4. Examples should demonstrate real ServiceNow implementations
|
|
91
|
+
|
|
92
|
+
## Customization
|
|
93
|
+
|
|
94
|
+
### Colors
|
|
95
|
+
Edit the CSS variables in `css/style.css`:
|
|
96
|
+
|
|
97
|
+
```css
|
|
98
|
+
:root {
|
|
99
|
+
--primary-color: #0066cc;
|
|
100
|
+
--secondary-color: #00a6ff;
|
|
101
|
+
--accent-color: #00d4ff;
|
|
102
|
+
/* ... */
|
|
103
|
+
}
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### Logo
|
|
107
|
+
The logo uses emojis (🏔️❄️). To change it, update all instances in:
|
|
108
|
+
- `index.html`
|
|
109
|
+
- `docs/api-full.html`
|
|
110
|
+
|
|
111
|
+
### Content
|
|
112
|
+
All content is in HTML files and can be edited directly:
|
|
113
|
+
- Main content: `index.html`
|
|
114
|
+
- API documentation: `docs/api-full.html`
|
|
115
|
+
|
|
116
|
+
## Browser Support
|
|
117
|
+
|
|
118
|
+
- Chrome/Edge (latest)
|
|
119
|
+
- Firefox (latest)
|
|
120
|
+
- Safari (latest)
|
|
121
|
+
- Mobile browsers (iOS Safari, Chrome Mobile)
|
|
122
|
+
|
|
123
|
+
## Technologies Used
|
|
124
|
+
|
|
125
|
+
- **HTML5**: Semantic markup
|
|
126
|
+
- **CSS3**: Modern styling with CSS Grid and Flexbox
|
|
127
|
+
- **JavaScript**: Vanilla JS for maximum performance
|
|
128
|
+
- **Prism.js**: Code syntax highlighting
|
|
129
|
+
- **Google Fonts**: Inter font family
|
|
130
|
+
|
|
131
|
+
## Contributing
|
|
132
|
+
|
|
133
|
+
To contribute to the documentation:
|
|
134
|
+
|
|
135
|
+
1. Fork the repository
|
|
136
|
+
2. Create a feature branch
|
|
137
|
+
3. Make your changes
|
|
138
|
+
4. Test locally
|
|
139
|
+
5. Submit a pull request
|
|
140
|
+
|
|
141
|
+
## License
|
|
142
|
+
|
|
143
|
+
MIT License - Same as Snow-Flow
|
|
144
|
+
|
|
145
|
+
## Contact
|
|
146
|
+
|
|
147
|
+
- GitHub: [https://github.com/groeimetai/snow-flow](https://github.com/groeimetai/snow-flow)
|
|
148
|
+
- NPM: [https://www.npmjs.com/package/snow-flow](https://www.npmjs.com/package/snow-flow)
|
|
149
|
+
|
|
150
|
+
---
|
|
151
|
+
|
|
152
|
+
Built with ❤️ for the ServiceNow developer community
|
|
@@ -0,0 +1,366 @@
|
|
|
1
|
+
/* API Documentation Specific Styles */
|
|
2
|
+
|
|
3
|
+
.api-docs {
|
|
4
|
+
margin-top: 70px;
|
|
5
|
+
padding: 60px 0;
|
|
6
|
+
min-height: 100vh;
|
|
7
|
+
}
|
|
8
|
+
|
|
9
|
+
.api-docs h1 {
|
|
10
|
+
font-size: 2.5rem;
|
|
11
|
+
margin-bottom: 3rem;
|
|
12
|
+
color: var(--text-primary);
|
|
13
|
+
text-align: center;
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
.api-section {
|
|
17
|
+
margin-bottom: 4rem;
|
|
18
|
+
background: white;
|
|
19
|
+
border-radius: 12px;
|
|
20
|
+
padding: 2rem;
|
|
21
|
+
box-shadow: var(--shadow-sm);
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
.api-section h2 {
|
|
25
|
+
font-size: 2rem;
|
|
26
|
+
margin-bottom: 2rem;
|
|
27
|
+
color: var(--text-primary);
|
|
28
|
+
padding-bottom: 1rem;
|
|
29
|
+
border-bottom: 2px solid var(--border-color);
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
.api-method {
|
|
33
|
+
margin-bottom: 3rem;
|
|
34
|
+
padding-bottom: 2rem;
|
|
35
|
+
border-bottom: 1px solid var(--border-color);
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
.api-method:last-child {
|
|
39
|
+
border-bottom: none;
|
|
40
|
+
margin-bottom: 0;
|
|
41
|
+
padding-bottom: 0;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
.api-method h3 {
|
|
45
|
+
font-size: 1.5rem;
|
|
46
|
+
color: var(--primary-color);
|
|
47
|
+
margin-bottom: 1rem;
|
|
48
|
+
font-family: 'Fira Code', monospace;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
.api-method p {
|
|
52
|
+
color: var(--text-secondary);
|
|
53
|
+
margin-bottom: 1.5rem;
|
|
54
|
+
line-height: 1.8;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
.api-method pre {
|
|
58
|
+
background: var(--dark-bg);
|
|
59
|
+
border-radius: 8px;
|
|
60
|
+
padding: 1.5rem;
|
|
61
|
+
overflow-x: auto;
|
|
62
|
+
margin-bottom: 1.5rem;
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
.api-method code {
|
|
66
|
+
color: #e6e6e6;
|
|
67
|
+
font-family: 'Fira Code', 'Courier New', monospace;
|
|
68
|
+
font-size: 0.95rem;
|
|
69
|
+
line-height: 1.6;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
.tool-list {
|
|
73
|
+
list-style: none;
|
|
74
|
+
padding: 0;
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
.tool-list li {
|
|
78
|
+
padding: 0.8rem;
|
|
79
|
+
background: var(--light-bg);
|
|
80
|
+
margin-bottom: 0.5rem;
|
|
81
|
+
border-radius: 6px;
|
|
82
|
+
transition: all 0.3s ease;
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
.tool-list li:hover {
|
|
86
|
+
background: white;
|
|
87
|
+
box-shadow: var(--shadow-sm);
|
|
88
|
+
transform: translateX(5px);
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
.tool-list code {
|
|
92
|
+
background: white;
|
|
93
|
+
padding: 4px 8px;
|
|
94
|
+
border-radius: 4px;
|
|
95
|
+
color: var(--primary-color);
|
|
96
|
+
font-weight: 500;
|
|
97
|
+
margin-right: 1rem;
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
/* Error Table */
|
|
101
|
+
.error-table {
|
|
102
|
+
width: 100%;
|
|
103
|
+
border-collapse: collapse;
|
|
104
|
+
margin-top: 1rem;
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
.error-table thead {
|
|
108
|
+
background: var(--gradient-secondary);
|
|
109
|
+
color: white;
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
.error-table th {
|
|
113
|
+
padding: 1rem;
|
|
114
|
+
text-align: left;
|
|
115
|
+
font-weight: 600;
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
.error-table tbody tr {
|
|
119
|
+
border-bottom: 1px solid var(--border-color);
|
|
120
|
+
transition: background 0.3s ease;
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
.error-table tbody tr:hover {
|
|
124
|
+
background: var(--light-bg);
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
.error-table td {
|
|
128
|
+
padding: 1rem;
|
|
129
|
+
color: var(--text-secondary);
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
.error-table td:first-child {
|
|
133
|
+
font-family: 'Fira Code', monospace;
|
|
134
|
+
color: var(--error-color);
|
|
135
|
+
font-weight: 500;
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
.error-table code {
|
|
139
|
+
background: var(--light-bg);
|
|
140
|
+
padding: 2px 6px;
|
|
141
|
+
border-radius: 4px;
|
|
142
|
+
color: var(--primary-color);
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
/* Sidebar Navigation for API Docs */
|
|
146
|
+
.api-sidebar {
|
|
147
|
+
position: fixed;
|
|
148
|
+
left: 0;
|
|
149
|
+
top: 70px;
|
|
150
|
+
width: 250px;
|
|
151
|
+
height: calc(100vh - 70px);
|
|
152
|
+
background: white;
|
|
153
|
+
border-right: 1px solid var(--border-color);
|
|
154
|
+
padding: 2rem 1rem;
|
|
155
|
+
overflow-y: auto;
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
.api-sidebar h4 {
|
|
159
|
+
font-size: 0.9rem;
|
|
160
|
+
text-transform: uppercase;
|
|
161
|
+
color: var(--text-light);
|
|
162
|
+
margin-bottom: 1rem;
|
|
163
|
+
letter-spacing: 1px;
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
.api-sidebar ul {
|
|
167
|
+
list-style: none;
|
|
168
|
+
padding: 0;
|
|
169
|
+
margin-bottom: 2rem;
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
.api-sidebar li {
|
|
173
|
+
margin-bottom: 0.5rem;
|
|
174
|
+
}
|
|
175
|
+
|
|
176
|
+
.api-sidebar a {
|
|
177
|
+
color: var(--text-secondary);
|
|
178
|
+
text-decoration: none;
|
|
179
|
+
display: block;
|
|
180
|
+
padding: 0.5rem 1rem;
|
|
181
|
+
border-radius: 6px;
|
|
182
|
+
transition: all 0.3s ease;
|
|
183
|
+
}
|
|
184
|
+
|
|
185
|
+
.api-sidebar a:hover {
|
|
186
|
+
background: var(--light-bg);
|
|
187
|
+
color: var(--primary-color);
|
|
188
|
+
}
|
|
189
|
+
|
|
190
|
+
.api-sidebar a.active {
|
|
191
|
+
background: var(--gradient-secondary);
|
|
192
|
+
color: white;
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
/* Parameters Table */
|
|
196
|
+
.params-table {
|
|
197
|
+
width: 100%;
|
|
198
|
+
margin: 1.5rem 0;
|
|
199
|
+
border-collapse: collapse;
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
.params-table th {
|
|
203
|
+
background: var(--light-bg);
|
|
204
|
+
padding: 0.8rem;
|
|
205
|
+
text-align: left;
|
|
206
|
+
font-weight: 600;
|
|
207
|
+
color: var(--text-primary);
|
|
208
|
+
}
|
|
209
|
+
|
|
210
|
+
.params-table td {
|
|
211
|
+
padding: 0.8rem;
|
|
212
|
+
border-bottom: 1px solid var(--border-color);
|
|
213
|
+
}
|
|
214
|
+
|
|
215
|
+
.params-table .param-name {
|
|
216
|
+
font-family: 'Fira Code', monospace;
|
|
217
|
+
color: var(--primary-color);
|
|
218
|
+
font-weight: 500;
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
.params-table .param-type {
|
|
222
|
+
color: var(--warning-color);
|
|
223
|
+
font-family: 'Fira Code', monospace;
|
|
224
|
+
font-size: 0.9rem;
|
|
225
|
+
}
|
|
226
|
+
|
|
227
|
+
.params-table .param-required {
|
|
228
|
+
background: var(--error-color);
|
|
229
|
+
color: white;
|
|
230
|
+
padding: 2px 8px;
|
|
231
|
+
border-radius: 4px;
|
|
232
|
+
font-size: 0.8rem;
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
.params-table .param-optional {
|
|
236
|
+
background: var(--success-color);
|
|
237
|
+
color: white;
|
|
238
|
+
padding: 2px 8px;
|
|
239
|
+
border-radius: 4px;
|
|
240
|
+
font-size: 0.8rem;
|
|
241
|
+
}
|
|
242
|
+
|
|
243
|
+
/* Response Examples */
|
|
244
|
+
.response-example {
|
|
245
|
+
background: #2d2d2d;
|
|
246
|
+
border-radius: 8px;
|
|
247
|
+
padding: 1.5rem;
|
|
248
|
+
margin: 1.5rem 0;
|
|
249
|
+
}
|
|
250
|
+
|
|
251
|
+
.response-example h4 {
|
|
252
|
+
color: white;
|
|
253
|
+
margin-bottom: 1rem;
|
|
254
|
+
font-size: 1.1rem;
|
|
255
|
+
}
|
|
256
|
+
|
|
257
|
+
.response-status {
|
|
258
|
+
display: inline-block;
|
|
259
|
+
padding: 4px 12px;
|
|
260
|
+
border-radius: 20px;
|
|
261
|
+
font-size: 0.9rem;
|
|
262
|
+
font-weight: 600;
|
|
263
|
+
margin-left: 1rem;
|
|
264
|
+
}
|
|
265
|
+
|
|
266
|
+
.response-status.success {
|
|
267
|
+
background: var(--success-color);
|
|
268
|
+
color: white;
|
|
269
|
+
}
|
|
270
|
+
|
|
271
|
+
.response-status.error {
|
|
272
|
+
background: var(--error-color);
|
|
273
|
+
color: white;
|
|
274
|
+
}
|
|
275
|
+
|
|
276
|
+
/* Search Box for API */
|
|
277
|
+
.api-search {
|
|
278
|
+
position: sticky;
|
|
279
|
+
top: 90px;
|
|
280
|
+
background: white;
|
|
281
|
+
padding: 1rem 0;
|
|
282
|
+
margin-bottom: 2rem;
|
|
283
|
+
z-index: 100;
|
|
284
|
+
}
|
|
285
|
+
|
|
286
|
+
.api-search input {
|
|
287
|
+
width: 100%;
|
|
288
|
+
padding: 12px 20px;
|
|
289
|
+
border: 2px solid var(--border-color);
|
|
290
|
+
border-radius: 25px;
|
|
291
|
+
font-size: 1rem;
|
|
292
|
+
transition: all 0.3s ease;
|
|
293
|
+
}
|
|
294
|
+
|
|
295
|
+
.api-search input:focus {
|
|
296
|
+
border-color: var(--primary-color);
|
|
297
|
+
box-shadow: 0 0 0 3px rgba(0,102,204,0.1);
|
|
298
|
+
outline: none;
|
|
299
|
+
}
|
|
300
|
+
|
|
301
|
+
/* Version Badge */
|
|
302
|
+
.version-badge {
|
|
303
|
+
display: inline-block;
|
|
304
|
+
background: var(--gradient-secondary);
|
|
305
|
+
color: white;
|
|
306
|
+
padding: 4px 12px;
|
|
307
|
+
border-radius: 20px;
|
|
308
|
+
font-size: 0.9rem;
|
|
309
|
+
margin-left: 1rem;
|
|
310
|
+
}
|
|
311
|
+
|
|
312
|
+
/* Copy Button for Code Blocks */
|
|
313
|
+
.copy-btn {
|
|
314
|
+
position: absolute;
|
|
315
|
+
top: 10px;
|
|
316
|
+
right: 10px;
|
|
317
|
+
background: rgba(255,255,255,0.1);
|
|
318
|
+
color: white;
|
|
319
|
+
border: 1px solid rgba(255,255,255,0.2);
|
|
320
|
+
padding: 5px 15px;
|
|
321
|
+
border-radius: 5px;
|
|
322
|
+
cursor: pointer;
|
|
323
|
+
font-size: 0.9rem;
|
|
324
|
+
transition: all 0.3s ease;
|
|
325
|
+
opacity: 0.7;
|
|
326
|
+
}
|
|
327
|
+
|
|
328
|
+
.copy-btn:hover {
|
|
329
|
+
opacity: 1;
|
|
330
|
+
background: rgba(255,255,255,0.2);
|
|
331
|
+
}
|
|
332
|
+
|
|
333
|
+
.copy-btn.copied {
|
|
334
|
+
background: var(--success-color);
|
|
335
|
+
border-color: var(--success-color);
|
|
336
|
+
}
|
|
337
|
+
|
|
338
|
+
/* Responsive Design */
|
|
339
|
+
@media (max-width: 1024px) {
|
|
340
|
+
.api-sidebar {
|
|
341
|
+
display: none;
|
|
342
|
+
}
|
|
343
|
+
}
|
|
344
|
+
|
|
345
|
+
@media (max-width: 768px) {
|
|
346
|
+
.api-docs {
|
|
347
|
+
padding: 40px 0;
|
|
348
|
+
}
|
|
349
|
+
|
|
350
|
+
.api-section {
|
|
351
|
+
padding: 1.5rem;
|
|
352
|
+
}
|
|
353
|
+
|
|
354
|
+
.api-method h3 {
|
|
355
|
+
font-size: 1.2rem;
|
|
356
|
+
}
|
|
357
|
+
|
|
358
|
+
.error-table {
|
|
359
|
+
font-size: 0.9rem;
|
|
360
|
+
}
|
|
361
|
+
|
|
362
|
+
.error-table th,
|
|
363
|
+
.error-table td {
|
|
364
|
+
padding: 0.5rem;
|
|
365
|
+
}
|
|
366
|
+
}
|