terminator-mcp-agent 0.9.0 → 0.9.2
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 +194 -5
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
<!-- BADGES:START -->
|
|
4
4
|
|
|
5
|
-
[<img alt="Install in VS Code" src="https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install%20Server&color=0098FF">](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%257B%2522terminator-mcp-agent%2522%253A%257B%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522-y%2522%252C%2522terminator-mcp-agent%2522%255D%257D%257D)
|
|
6
|
-
[<img alt="Install in VS Code Insiders" src="https://img.shields.io/badge/VS_Code_Insiders-VS_Code_Insiders?style=flat-square&label=Install%20Server&color=24bfa5">](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Amcp%2Finstall%3F%257B%2522terminator-mcp-agent%2522%253A%257B%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522-y%2522%252C%2522terminator-mcp-agent%2522%255D%257D%257D)
|
|
7
|
-
[<img alt="Install in Cursor" src="https://img.shields.io/badge/Cursor-Cursor?style=flat-square&label=Install%20Server&color=22272e">](https://cursor.com/install-mcp?name=terminator-mcp-agent&config=
|
|
5
|
+
[<img alt="Install in VS Code" src="https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install%20Server&color=0098FF">](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%257B%2522terminator-mcp-agent%2522%253A%257B%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522-y%2522%252C%2522terminator-mcp-agent%2540latest%2522%255D%257D%257D)
|
|
6
|
+
[<img alt="Install in VS Code Insiders" src="https://img.shields.io/badge/VS_Code_Insiders-VS_Code_Insiders?style=flat-square&label=Install%20Server&color=24bfa5">](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Amcp%2Finstall%3F%257B%2522terminator-mcp-agent%2522%253A%257B%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522-y%2522%252C%2522terminator-mcp-agent%2540latest%2522%255D%257D%257D)
|
|
7
|
+
[<img alt="Install in Cursor" src="https://img.shields.io/badge/Cursor-Cursor?style=flat-square&label=Install%20Server&color=22272e">](https://cursor.com/install-mcp?name=terminator-mcp-agent&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsInRlcm1pbmF0b3ItbWNwLWFnZW50QGxhdGVzdCJdfQ%3D%3D)
|
|
8
8
|
|
|
9
9
|
<!-- BADGES:END -->
|
|
10
10
|
|
|
@@ -20,7 +20,7 @@ Alternatively, you can install and configure the agent from your command line.
|
|
|
20
20
|
Run the following command and select your MCP client from the list:
|
|
21
21
|
|
|
22
22
|
```sh
|
|
23
|
-
npx -y terminator-mcp-agent --add-to-app
|
|
23
|
+
npx -y terminator-mcp-agent@latest --add-to-app
|
|
24
24
|
```
|
|
25
25
|
|
|
26
26
|
**2. Manual Configuration**
|
|
@@ -31,12 +31,94 @@ If you prefer, you can add the following to your MCP client's settings file:
|
|
|
31
31
|
"mcpServers": {
|
|
32
32
|
"terminator-mcp-agent": {
|
|
33
33
|
"command": "npx",
|
|
34
|
-
"args": ["-y", "terminator-mcp-agent"]
|
|
34
|
+
"args": ["-y", "terminator-mcp-agent@latest"]
|
|
35
35
|
}
|
|
36
36
|
}
|
|
37
37
|
}
|
|
38
38
|
```
|
|
39
39
|
|
|
40
|
+
### Command Line Interface (CLI) Execution
|
|
41
|
+
|
|
42
|
+
For automation workflows and CI/CD pipelines, you can execute workflows directly from the command line using the [Terminator CLI](../terminator-cli/README.md):
|
|
43
|
+
|
|
44
|
+
**Quick Start:**
|
|
45
|
+
```bash
|
|
46
|
+
# Execute a workflow file
|
|
47
|
+
terminator mcp run workflow.yml
|
|
48
|
+
|
|
49
|
+
# With verbose logging
|
|
50
|
+
terminator mcp run workflow.yml --verbose
|
|
51
|
+
|
|
52
|
+
# Dry run (validate without executing)
|
|
53
|
+
terminator mcp run workflow.yml --dry-run
|
|
54
|
+
|
|
55
|
+
# Use specific MCP server version
|
|
56
|
+
terminator mcp run workflow.yml --command "npx -y terminator-mcp-agent@latest"
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
**Workflow File Formats:**
|
|
60
|
+
|
|
61
|
+
Direct workflow format (`workflow.yml`):
|
|
62
|
+
```yaml
|
|
63
|
+
steps:
|
|
64
|
+
- tool_name: navigate_browser
|
|
65
|
+
arguments:
|
|
66
|
+
url: "https://example.com"
|
|
67
|
+
- tool_name: click_element
|
|
68
|
+
arguments:
|
|
69
|
+
selector: "role:Button|name:Submit"
|
|
70
|
+
stop_on_error: true
|
|
71
|
+
include_detailed_results: true
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
Tool call wrapper format (`workflow.json`):
|
|
75
|
+
```json
|
|
76
|
+
{
|
|
77
|
+
"tool_name": "execute_sequence",
|
|
78
|
+
"arguments": {
|
|
79
|
+
"steps": [
|
|
80
|
+
{
|
|
81
|
+
"tool_name": "navigate_browser",
|
|
82
|
+
"arguments": {
|
|
83
|
+
"url": "https://example.com"
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
]
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
**JavaScript Execution in Workflows:**
|
|
92
|
+
|
|
93
|
+
Execute custom JavaScript code with access to desktop automation APIs:
|
|
94
|
+
|
|
95
|
+
```yaml
|
|
96
|
+
steps:
|
|
97
|
+
- tool_name: run_javascript
|
|
98
|
+
arguments:
|
|
99
|
+
engine: "nodejs"
|
|
100
|
+
script: |
|
|
101
|
+
// Access desktop automation APIs
|
|
102
|
+
const elements = await desktop.locator('role:button').all();
|
|
103
|
+
log(`Found ${elements.length} buttons`);
|
|
104
|
+
|
|
105
|
+
// Conditional logic and bulk operations
|
|
106
|
+
for (const element of elements) {
|
|
107
|
+
const name = await element.name();
|
|
108
|
+
if (name.includes('Submit')) {
|
|
109
|
+
await element.click();
|
|
110
|
+
break;
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
return {
|
|
115
|
+
buttons_found: elements.length,
|
|
116
|
+
action: 'clicked_submit'
|
|
117
|
+
};
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
For complete CLI documentation, see [Terminator CLI README](../terminator-cli/README.md).
|
|
121
|
+
|
|
40
122
|
### Core Workflows: From Interaction to Structured Data
|
|
41
123
|
|
|
42
124
|
The Terminator MCP agent offers two primary workflows for automating desktop tasks. Both paths lead to the same goal: creating a >95% accuracy, 10000x faster than humans, automation.
|
|
@@ -115,6 +197,113 @@ Now, when your MCP client runs `terminator-mcp-agent`, it will use your local bu
|
|
|
115
197
|
- For VS Code/Insiders, ensure the CLI (`code` or `code-insiders`) is available in your PATH.
|
|
116
198
|
- If you encounter issues, try running with elevated permissions.
|
|
117
199
|
|
|
200
|
+
### Version Compatibility Issues
|
|
201
|
+
|
|
202
|
+
**Problem**: "missing field `items`" or schema mismatch errors
|
|
203
|
+
|
|
204
|
+
**Solution**: Ensure you're using the latest MCP server version:
|
|
205
|
+
```bash
|
|
206
|
+
# Force latest version in CLI
|
|
207
|
+
terminator mcp run workflow.yml --command "npx -y terminator-mcp-agent@latest"
|
|
208
|
+
|
|
209
|
+
# Update MCP client configuration to use @latest
|
|
210
|
+
{
|
|
211
|
+
"mcpServers": {
|
|
212
|
+
"terminator-mcp-agent": {
|
|
213
|
+
"command": "npx",
|
|
214
|
+
"args": ["-y", "terminator-mcp-agent@latest"]
|
|
215
|
+
}
|
|
216
|
+
}
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
# Clear npm cache if needed
|
|
220
|
+
npm cache clean --force
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
### CLI Integration Issues
|
|
224
|
+
|
|
225
|
+
**Problem**: CLI commands not working or connection errors
|
|
226
|
+
|
|
227
|
+
**Solution**: Test MCP connectivity step by step:
|
|
228
|
+
```bash
|
|
229
|
+
# Test basic connectivity
|
|
230
|
+
terminator mcp exec get_applications
|
|
231
|
+
|
|
232
|
+
# Test with verbose logging
|
|
233
|
+
terminator mcp run workflow.yml --verbose
|
|
234
|
+
|
|
235
|
+
# Test with dry run first
|
|
236
|
+
terminator mcp run workflow.yml --dry-run
|
|
237
|
+
|
|
238
|
+
# Use HTTP connection for debugging
|
|
239
|
+
terminator mcp run workflow.yml --url http://localhost:3000/mcp
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
### JavaScript Execution Issues
|
|
243
|
+
|
|
244
|
+
**Problem**: JavaScript code fails or can't access desktop APIs
|
|
245
|
+
|
|
246
|
+
**Solution**: Verify JavaScript execution and API access:
|
|
247
|
+
```bash
|
|
248
|
+
# Test basic JavaScript execution
|
|
249
|
+
terminator mcp exec run_javascript '{"script": "return {test: true};"}'
|
|
250
|
+
|
|
251
|
+
# Test desktop API access with nodejs engine
|
|
252
|
+
terminator mcp exec run_javascript '{"engine": "nodejs", "script": "const elements = await desktop.locator(\"role:button\").all(); return {count: elements.length};"}'
|
|
253
|
+
|
|
254
|
+
# Debug with verbose logging
|
|
255
|
+
terminator mcp run workflow.yml --verbose
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
### Workflow File Issues
|
|
259
|
+
|
|
260
|
+
**Problem**: Workflow parsing errors or unexpected behavior
|
|
261
|
+
|
|
262
|
+
**Solution**: Validate workflow structure:
|
|
263
|
+
```bash
|
|
264
|
+
# Validate workflow syntax
|
|
265
|
+
terminator mcp run workflow.yml --dry-run
|
|
266
|
+
|
|
267
|
+
# Test with minimal workflow first
|
|
268
|
+
echo 'steps: [{tool_name: get_applications}]' > test.yml
|
|
269
|
+
terminator mcp run test.yml
|
|
270
|
+
|
|
271
|
+
# Check both YAML and JSON formats work
|
|
272
|
+
terminator mcp run workflow.yml # YAML
|
|
273
|
+
terminator mcp run workflow.json # JSON
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
### Platform-Specific Issues
|
|
277
|
+
|
|
278
|
+
**Windows**:
|
|
279
|
+
- Ensure Windows UI Automation APIs are available
|
|
280
|
+
- Run with administrator privileges if accessibility features are restricted
|
|
281
|
+
- Check Windows Defender/antivirus isn't blocking automation
|
|
282
|
+
|
|
283
|
+
**macOS**:
|
|
284
|
+
- Grant accessibility permissions in System Preferences > Security & Privacy
|
|
285
|
+
- Ensure the terminal/IDE has accessibility access
|
|
286
|
+
- Check macOS version compatibility (10.14+ recommended)
|
|
287
|
+
|
|
288
|
+
**Linux**:
|
|
289
|
+
- Ensure AT-SPI (assistive technology) is enabled
|
|
290
|
+
- Install required packages: `sudo apt-get install at-spi2-core`
|
|
291
|
+
- Check desktop environment compatibility (GNOME, KDE, XFCE supported)
|
|
292
|
+
|
|
293
|
+
### Performance Optimization
|
|
294
|
+
|
|
295
|
+
**Large UI Trees**:
|
|
296
|
+
- Use specific selectors instead of broad element searches
|
|
297
|
+
- Implement delays between rapid operations
|
|
298
|
+
- Consider using `include_tree: false` for intermediate steps
|
|
299
|
+
|
|
300
|
+
**JavaScript Performance**:
|
|
301
|
+
- Use `quickjs` engine for lightweight operations
|
|
302
|
+
- Use `nodejs` engine only when full APIs are needed
|
|
303
|
+
- Implement `sleep()` delays in loops to prevent overwhelming the UI
|
|
304
|
+
|
|
305
|
+
For additional help, see the [Terminator CLI documentation](../terminator-cli/README.md) or open an issue on GitHub.
|
|
306
|
+
|
|
118
307
|
---
|
|
119
308
|
|
|
120
309
|
## 📚 Full `execute_sequence` Reference & Sample Workflow
|
package/package.json
CHANGED
|
@@ -12,10 +12,10 @@
|
|
|
12
12
|
],
|
|
13
13
|
"name": "terminator-mcp-agent",
|
|
14
14
|
"optionalDependencies": {
|
|
15
|
-
"terminator-mcp-darwin-arm64": "0.9.
|
|
16
|
-
"terminator-mcp-darwin-x64": "0.9.
|
|
17
|
-
"terminator-mcp-linux-x64-gnu": "0.9.
|
|
18
|
-
"terminator-mcp-win32-x64-msvc": "0.9.
|
|
15
|
+
"terminator-mcp-darwin-arm64": "0.9.2",
|
|
16
|
+
"terminator-mcp-darwin-x64": "0.9.2",
|
|
17
|
+
"terminator-mcp-linux-x64-gnu": "0.9.2",
|
|
18
|
+
"terminator-mcp-win32-x64-msvc": "0.9.2"
|
|
19
19
|
},
|
|
20
20
|
"repository": {
|
|
21
21
|
"type": "git",
|
|
@@ -27,5 +27,5 @@
|
|
|
27
27
|
"sync-version": "node ./utils/sync-version.js",
|
|
28
28
|
"update-badges": "node ./utils/update-badges.js"
|
|
29
29
|
},
|
|
30
|
-
"version": "0.9.
|
|
30
|
+
"version": "0.9.2"
|
|
31
31
|
}
|