Skip to content

Commit 0993aeb

Browse files
authored
Merge pull request #19 from verisoft-ai/fix/mcp-naming
fix(mcp): change mcp naming to match new Desktop Driver convention
2 parents 8a7a3cf + e77a7b0 commit 0993aeb

File tree

4 files changed

+21
-21
lines changed

4 files changed

+21
-21
lines changed

MCP_README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Appium Desktop MCP Server
22

3-
The `appium-novawindows-driver` package ships a built-in **Model Context Protocol (MCP)** server that lets AI agents (Claude, Cursor, Copilot, etc.) automate Windows desktop applications via natural language — no test-framework code required.
3+
The `appium-desktop-driver` package ships a built-in **Model Context Protocol (MCP)** server that lets AI agents (Claude, Cursor, Copilot, etc.) automate Windows desktop applications via natural language — no test-framework code required.
44

55
---
66

@@ -50,7 +50,7 @@ AI Client (Claude / Cursor / etc.)
5050
│ stdio (MCP protocol)
5151
5252
┌──────────────────────────────────────────┐
53-
novawindows-mcp server │
53+
desktop-driver-mcp server │
5454
│ lib/mcp/index.ts │
5555
│ ┌─────────────┐ ┌──────────────────┐ │
5656
│ │AppiumManager│ │ AppiumSession │ │
@@ -95,7 +95,7 @@ Windows UI Automation (UIA3)
9595
- **Appium 3.x** with the Appium Desktop driver installed:
9696
```bash
9797
npm install -g appium
98-
appium driver install novawindows
98+
appium driver install --source=npm appium-desktop-driver
9999
```
100100
- An MCP-capable AI client (Claude Desktop, Cursor, VS Code with MCP extension, etc.)
101101

@@ -106,20 +106,20 @@ Windows UI Automation (UIA3)
106106
### From npm (recommended)
107107

108108
```bash
109-
npm install appium-novawindows-driver
109+
npm install appium-desktop-driver
110110
```
111111

112112
The MCP entry point is automatically registered as a `bin` command:
113113

114114
```
115-
novawindows-mcp → build/lib/mcp/index.js
115+
desktop-driver-mcp → build/lib/mcp/index.js
116116
```
117117

118118
### From source
119119

120120
```bash
121-
git clone https://github.com/AutomateThePlanet/appium-novawindows-driver.git
122-
cd appium-novawindows-driver
121+
git clone https://github.com/AutomateThePlanet/appium-desktop-driver.git
122+
cd appium-desktop-driver
123123
npm install
124124
npm run build
125125
```
@@ -156,16 +156,16 @@ When `APPIUM_AUTO_START=true` and Appium is not already running, the server reso
156156
npm run mcp:start
157157

158158
# Using npx (after npm install)
159-
npx novawindows-mcp
159+
npx desktop-driver-mcp
160160

161161
# After global install
162-
novawindows-mcp
162+
desktop-driver-mcp
163163
```
164164

165165
### With custom configuration
166166

167167
```bash
168-
APPIUM_PORT=4724 APPIUM_AUTO_START=false novawindows-mcp
168+
APPIUM_PORT=4724 APPIUM_AUTO_START=false desktop-driver-mcp
169169
```
170170

171171
---
@@ -179,9 +179,9 @@ Add to `claude_desktop_config.json` (usually at `%APPDATA%\Claude\claude_desktop
179179
```json
180180
{
181181
"mcpServers": {
182-
"novawindows": {
182+
"appium-desktop-driver": {
183183
"command": "npx",
184-
"args": ["novawindows-mcp"],
184+
"args": ["desktop-driver-mcp"],
185185
"env": {
186186
"APPIUM_AUTO_START": "true"
187187
}
@@ -195,9 +195,9 @@ Or, if using a local build:
195195
```json
196196
{
197197
"mcpServers": {
198-
"novawindows": {
198+
"appium-desktop-driver": {
199199
"command": "node",
200-
"args": ["C:/path/to/appium-novawindows-driver/build/lib/mcp/index.js"],
200+
"args": ["C:/path/to/appium-desktop-driver/build/lib/mcp/index.js"],
201201
"env": {
202202
"APPIUM_AUTO_START": "true"
203203
}
@@ -212,10 +212,10 @@ Or, if using a local build:
212212
{
213213
"mcp": {
214214
"servers": {
215-
"novawindows": {
215+
"appium-desktop-driver": {
216216
"type": "stdio",
217217
"command": "npx",
218-
"args": ["novawindows-mcp"]
218+
"args": ["desktop-driver-mcp"]
219219
}
220220
}
221221
}
@@ -234,7 +234,7 @@ When the server starts it performs these steps in order:
234234
- If not running and `APPIUM_AUTO_START=true`: spawns the Appium process and polls until ready (30 s timeout).
235235
- If not running and `APPIUM_AUTO_START=false`: exits with an error.
236236
3. **Create session holder**`AppiumSession` object is initialized but no app is launched yet.
237-
4. **Create MCP server**`McpServer` from `@modelcontextprotocol/sdk` with name `novawindows-mcp` and version `1.3.0`.
237+
4. **Create MCP server**`McpServer` from `@modelcontextprotocol/sdk` with name `desktop-driver-mcp` and version `1.3.0`.
238238
5. **Register tools** — all 30+ tools are registered (see [Tool Reference](#tool-reference)).
239239
6. **Register shutdown handlers**`SIGINT`, `SIGTERM`, and `stdin close` all trigger graceful shutdown (session delete + Appium stop, with a 10 s session-delete timeout).
240240
7. **Connect stdio transport** — the server is now ready for the AI client.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ It’s designed to handle real-world scenarios where traditional drivers fall sh
1313
>
1414
> This driver is built for Appium 2/3 and is not compatible with Appium 1. To install
1515
> the driver, simply run:
16-
> `appium driver install --source=npm appium-novawindows-driver`
16+
> `appium driver install --source=npm appium-desktop-driver`
1717
1818

1919
## Usage

lib/mcp/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ async function main() {
5050

5151
// Step 4: Create and configure MCP server
5252
const server = new McpServer({
53-
name: 'novawindows-mcp',
53+
name: 'desktop-driver-mcp',
5454
version: '1.3.0',
5555
});
5656

@@ -81,7 +81,7 @@ async function main() {
8181
// Step 7: Connect transport (stdout is owned by MCP protocol — all logs go to stderr)
8282
const transport = new StdioServerTransport();
8383
await server.connect(transport);
84-
process.stderr.write('[MCP] novawindows-mcp server ready. Call create_session to launch an app.\n');
84+
process.stderr.write('[MCP] desktop-driver-mcp server ready. Call create_session to launch an app.\n');
8585
}
8686

8787
main();

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
],
1414
"main": "build/lib/driver.js",
1515
"bin": {
16-
"novawindows-mcp": "build/lib/mcp/index.js"
16+
"desktop-driver-mcp": "build/lib/mcp/index.js"
1717
},
1818
"scripts": {
1919
"build": "tsc -b",

0 commit comments

Comments
 (0)