wopee-mcp 1.5.0 → 1.5.1
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 +17 -98
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -92,122 +92,40 @@ Dispatch a new analysis suite
|
|
|
92
92
|
|
|
93
93
|
### Generation Tools
|
|
94
94
|
|
|
95
|
-
These tools generate various artifacts for a specific suite. All require a `suiteUuid
|
|
95
|
+
These tools generate various artifacts for a specific suite. All require a `suiteUuid` and `fileType` to generate.
|
|
96
96
|
|
|
97
|
-
#### `
|
|
97
|
+
#### `wopee_generate_file`
|
|
98
98
|
|
|
99
|
-
Generates
|
|
100
|
-
|
|
101
|
-
- **Parameters:**
|
|
102
|
-
- `suiteUuid` - The UUID of the suite to generate context for
|
|
103
|
-
- **Returns:** Generated output in case of successful generation
|
|
104
|
-
|
|
105
|
-
**Example Usage:**
|
|
106
|
-
|
|
107
|
-
```
|
|
108
|
-
Generate app context for suite abc-123-def-456
|
|
109
|
-
```
|
|
110
|
-
|
|
111
|
-
#### `wopee_generate_general_user_stories`
|
|
112
|
-
|
|
113
|
-
Generates general user stories markdown file for the selected suite.
|
|
99
|
+
Generates a specific file(artifact) for the selected suite.
|
|
114
100
|
|
|
115
101
|
- **Parameters:**
|
|
116
102
|
- `suiteUuid` - The UUID of the suite
|
|
117
|
-
-
|
|
118
|
-
|
|
119
|
-
**Example Usage:**
|
|
120
|
-
|
|
121
|
-
```
|
|
122
|
-
Generate general user stories for my latest suite
|
|
123
|
-
```
|
|
124
|
-
|
|
125
|
-
#### `wopee_generate_user_stories`
|
|
126
|
-
|
|
127
|
-
Generates detailed user stories JSON file for the selected suite.
|
|
128
|
-
|
|
129
|
-
- **Parameters:**
|
|
130
|
-
- `suiteUuid` - The UUID of the suite
|
|
131
|
-
- **Returns:** Generated output in case of successful generation
|
|
132
|
-
|
|
133
|
-
**Example Usage:**
|
|
134
|
-
|
|
135
|
-
```
|
|
136
|
-
Generate user stories for suite abc-123-def-456
|
|
137
|
-
```
|
|
138
|
-
|
|
139
|
-
#### `wopee_generate_test_cases`
|
|
140
|
-
|
|
141
|
-
Generates test cases for the selected suite based on the analysis and user stories.
|
|
142
|
-
|
|
143
|
-
- **Parameters:**
|
|
144
|
-
- `suiteUuid` - The UUID of the suite
|
|
145
|
-
- **Returns:** Generated output in case of successful generation
|
|
103
|
+
- `fileType` - `"APP_CONTEXT" | "GENERAL_USER_STORIES" | "USER_STORIES" | "TEST_CASES"`
|
|
104
|
+
- **Returns:** Generated output in case of successful generation.
|
|
146
105
|
|
|
147
106
|
**Example Usage:**
|
|
148
107
|
|
|
149
108
|
```
|
|
150
|
-
Generate
|
|
109
|
+
Generate app context for my most recent analysis suite
|
|
151
110
|
```
|
|
152
111
|
|
|
153
112
|
### Fetch Tools
|
|
154
113
|
|
|
155
|
-
These tools retrieve generated artifacts for a specific suite. All require a `suiteUuid`.
|
|
114
|
+
These tools retrieve generated artifacts for a specific suite. All require a `suiteUuid` and `fileType`.
|
|
156
115
|
|
|
157
|
-
#### `
|
|
116
|
+
#### `wopee_fetch_file`
|
|
158
117
|
|
|
159
|
-
Fetches the
|
|
118
|
+
Fetches the enquired file(artifact) from the selected suite.
|
|
160
119
|
|
|
161
120
|
- **Parameters:**
|
|
162
121
|
- `suiteUuid` - The UUID of the suite
|
|
163
|
-
-
|
|
164
|
-
|
|
165
|
-
**Example Usage:**
|
|
166
|
-
|
|
167
|
-
```
|
|
168
|
-
Fetch app context for my latest suite
|
|
169
|
-
```
|
|
170
|
-
|
|
171
|
-
#### `wopee_fetch_general_user_stories`
|
|
172
|
-
|
|
173
|
-
Fetches the general user stories markdown file for a suite.
|
|
174
|
-
|
|
175
|
-
- **Parameters:**
|
|
176
|
-
- `suiteUuid` - The UUID of the suite
|
|
177
|
-
- **Returns:** The general user stories markdown content
|
|
178
|
-
|
|
179
|
-
**Example Usage:**
|
|
180
|
-
|
|
181
|
-
```
|
|
182
|
-
Fetch general user stories for suite abc-123-def-456
|
|
183
|
-
```
|
|
184
|
-
|
|
185
|
-
#### `wopee_fetch_user_stories`
|
|
186
|
-
|
|
187
|
-
Fetches the user stories JSON file for a suite.
|
|
188
|
-
|
|
189
|
-
- **Parameters:**
|
|
190
|
-
- `suiteUuid` - The UUID of the suite
|
|
191
|
-
- **Returns:** The user stories JSON content
|
|
192
|
-
|
|
193
|
-
**Example Usage:**
|
|
194
|
-
|
|
195
|
-
```
|
|
196
|
-
Fetch user stories for suite abc-123-def-456
|
|
197
|
-
```
|
|
198
|
-
|
|
199
|
-
#### `wopee_fetch_test_cases`
|
|
200
|
-
|
|
201
|
-
Fetches the test cases JSON file for a suite.
|
|
202
|
-
|
|
203
|
-
- **Parameters:**
|
|
204
|
-
- `suiteUuid` - The UUID of the suite
|
|
205
|
-
- **Returns:** The test cases JSON content
|
|
122
|
+
- `fileType` - `"APP_CONTEXT" | "GENERAL_USER_STORIES" | "USER_STORIES" | "TEST_CASES"`
|
|
123
|
+
- **Returns:** The file contents in case of successful fetch.
|
|
206
124
|
|
|
207
125
|
**Example Usage:**
|
|
208
126
|
|
|
209
127
|
```
|
|
210
|
-
Fetch
|
|
128
|
+
Fetch user stories for the latest suite
|
|
211
129
|
```
|
|
212
130
|
|
|
213
131
|
### Update Tools
|
|
@@ -259,9 +177,10 @@ Dispatch agent for my latest suite's user story US001 and test case TC003
|
|
|
259
177
|
|
|
260
178
|
2. **Generate artifacts:**
|
|
261
179
|
|
|
262
|
-
- Generate app context: `
|
|
263
|
-
- Generate user stories: `
|
|
264
|
-
- Generate
|
|
180
|
+
- Generate app context: `wopee_generate_file` with `APP_CONTEXT` and specific `suiteUuid`
|
|
181
|
+
- Generate general user stories: `wopee_generate_file` with `GENERAL_USER_STORIES` and specific `suiteUuid`
|
|
182
|
+
- Generate user stories: `wopee_generate_file` with `USER_STORIES` and specific `suiteUuid`
|
|
183
|
+
- Generate test cases: `wopee_generate_file` with `TEST_CASES` and specific `suiteUuid`
|
|
265
184
|
|
|
266
185
|
3. **Fetch generated content:**
|
|
267
186
|
|
|
@@ -273,5 +192,5 @@ Dispatch agent for my latest suite's user story US001 and test case TC003
|
|
|
273
192
|
## Notes
|
|
274
193
|
|
|
275
194
|
- Most tools require a `suiteUuid`. Always start by fetching or creating a suite.
|
|
276
|
-
- `wopee_dispatch_analysis` tool will go through whole cycle of processing - crawling the application and generating all of the artifacts one by one.
|
|
195
|
+
- `wopee_dispatch_analysis` tool will go through whole cycle of processing - crawling the application and generating all of the files(artifacts) one by one.
|
|
277
196
|
- It is advisable to use [cmd.wopee.io](https://cmd.wopee.io) for a convenient visual representation of the generated data and results of the agent runs.
|