@boolesai/tspec-cli 0.0.4 → 0.0.5
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 +98 -0
- package/dist/index.js +14669 -166
- package/dist/index.js.map +1 -1
- package/package.json +2 -1
- package/types/commands/list.d.ts +15 -0
- package/types/commands/mcp.d.ts +2 -0
- package/types/commands/parse.d.ts +28 -0
- package/types/commands/run.d.ts +28 -0
- package/types/commands/validate.d.ts +20 -0
- package/types/mcp/server.d.ts +1 -0
package/README.md
CHANGED
|
@@ -131,6 +131,104 @@ tspec list
|
|
|
131
131
|
tspec list --output json
|
|
132
132
|
```
|
|
133
133
|
|
|
134
|
+
### `tspec mcp`
|
|
135
|
+
|
|
136
|
+
Start MCP (Model Context Protocol) server for AI tool integration.
|
|
137
|
+
|
|
138
|
+
```bash
|
|
139
|
+
tspec mcp
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
This starts an MCP server over stdio that exposes TSpec commands as tools for AI assistants like Claude.
|
|
143
|
+
|
|
144
|
+
## MCP Integration
|
|
145
|
+
|
|
146
|
+
TSpec CLI can run as an MCP server, exposing all commands as tools for AI assistants.
|
|
147
|
+
|
|
148
|
+
### Available Tools
|
|
149
|
+
|
|
150
|
+
| Tool | Description |
|
|
151
|
+
|------|-------------|
|
|
152
|
+
| `tspec_run` | Execute test cases and report results |
|
|
153
|
+
| `tspec_validate` | Validate .tspec files for schema correctness |
|
|
154
|
+
| `tspec_parse` | Parse and display test case information |
|
|
155
|
+
| `tspec_list` | List supported protocols |
|
|
156
|
+
|
|
157
|
+
### Claude Desktop Configuration
|
|
158
|
+
|
|
159
|
+
Add the following to your Claude Desktop configuration file:
|
|
160
|
+
|
|
161
|
+
**macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
162
|
+
**Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
|
|
163
|
+
|
|
164
|
+
```json
|
|
165
|
+
{
|
|
166
|
+
"mcpServers": {
|
|
167
|
+
"tspec": {
|
|
168
|
+
"command": "npx",
|
|
169
|
+
"args": ["-y", "@boolesai/tspec-cli", "mcp"]
|
|
170
|
+
}
|
|
171
|
+
}
|
|
172
|
+
}
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
Or if installed globally:
|
|
176
|
+
|
|
177
|
+
```json
|
|
178
|
+
{
|
|
179
|
+
"mcpServers": {
|
|
180
|
+
"tspec": {
|
|
181
|
+
"command": "tspec",
|
|
182
|
+
"args": ["mcp"]
|
|
183
|
+
}
|
|
184
|
+
}
|
|
185
|
+
}
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
### Tool Parameters
|
|
189
|
+
|
|
190
|
+
#### tspec_run
|
|
191
|
+
|
|
192
|
+
```json
|
|
193
|
+
{
|
|
194
|
+
"files": ["tests/*.tspec"],
|
|
195
|
+
"concurrency": 5,
|
|
196
|
+
"env": { "API_HOST": "localhost" },
|
|
197
|
+
"params": { "timeout": "5000" },
|
|
198
|
+
"failFast": false,
|
|
199
|
+
"output": "text"
|
|
200
|
+
}
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
#### tspec_validate
|
|
204
|
+
|
|
205
|
+
```json
|
|
206
|
+
{
|
|
207
|
+
"files": ["tests/*.tspec"],
|
|
208
|
+
"output": "text"
|
|
209
|
+
}
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
#### tspec_parse
|
|
213
|
+
|
|
214
|
+
```json
|
|
215
|
+
{
|
|
216
|
+
"files": ["tests/*.tspec"],
|
|
217
|
+
"env": { "API_HOST": "localhost" },
|
|
218
|
+
"params": { "timeout": "5000" },
|
|
219
|
+
"verbose": true,
|
|
220
|
+
"output": "text"
|
|
221
|
+
}
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
#### tspec_list
|
|
225
|
+
|
|
226
|
+
```json
|
|
227
|
+
{
|
|
228
|
+
"output": "text"
|
|
229
|
+
}
|
|
230
|
+
```
|
|
231
|
+
|
|
134
232
|
## Exit Codes
|
|
135
233
|
|
|
136
234
|
| Code | Description |
|