Skip to content

Commit 1aad34c

Browse files
anbeckhamclaude
andcommitted
Add privacy policy and expand usage examples
- Add Privacy Policy section (required for MCP marketplace) - Expand examples to 4 detailed scenarios demonstrating: - Browser navigation (Firefox) - File operations (LibreOffice) - Code search (VS Code) - Multi-window targeting workflow Prepares README for Anthropic MCP Directory submission requirements. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 5194bde commit 1aad34c

1 file changed

Lines changed: 96 additions & 10 deletions

File tree

README.md

Lines changed: 96 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -156,21 +156,93 @@ Check available automation capabilities.
156156

157157
## Example Usage
158158

159+
### Example 1: Navigating to a Website in Firefox
160+
161+
```
162+
User: "Open GitHub in Firefox"
163+
164+
Claude uses:
165+
1. desktop_snapshot(app_name="Firefox")
166+
→ Returns UI tree with elements like:
167+
- ref_5: [entry] "Search or enter address" (editable, focused)
168+
- ref_12: [button] "Go" (clickable)
169+
170+
2. desktop_click(ref="ref_5", element="URL bar")
171+
→ Clicks to focus the address bar
172+
173+
3. desktop_type(text="https://github.com", ref="ref_5", clear_first=True, submit=True)
174+
→ Types the URL and presses Enter
175+
176+
Result: Firefox navigates to GitHub
177+
```
178+
179+
### Example 2: Saving a File in LibreOffice
180+
181+
```
182+
User: "Save this document as 'report.odt'"
183+
184+
Claude uses:
185+
1. desktop_key(key="s", modifiers=["ctrl"])
186+
→ Opens the Save dialog
187+
188+
2. desktop_snapshot(app_name="LibreOffice")
189+
→ Returns dialog elements including:
190+
- ref_8: [entry] "File name:" (editable)
191+
- ref_15: [button] "Save" (clickable)
192+
193+
3. desktop_type(text="report.odt", ref="ref_8", clear_first=True)
194+
→ Types the filename
195+
196+
4. desktop_click(ref="ref_15", element="Save button")
197+
→ Clicks Save
198+
199+
Result: Document saved as report.odt
200+
```
201+
202+
### Example 3: Searching in a Code Editor
203+
159204
```
160-
# 1. Take a snapshot to see available elements
161-
desktop_snapshot(app_name="Firefox")
205+
User: "Search for 'TODO' comments in VS Code"
206+
207+
Claude uses:
208+
1. desktop_find(query="search", app_name="Code")
209+
→ Finds search-related elements
210+
211+
2. desktop_key(key="f", modifiers=["ctrl", "shift"])
212+
→ Opens global search panel
162213
163-
# 2. Find a specific element
164-
desktop_find(query="search bar")
214+
3. desktop_snapshot(app_name="Code")
215+
→ Returns search panel elements:
216+
- ref_22: [entry] "Search" (editable, focused)
217+
- ref_25: [checkbox] "Match Case"
165218
166-
# 3. Click the element
167-
desktop_click(ref="ref_5", element="URL bar")
219+
4. desktop_type(text="TODO", ref="ref_22", submit=True)
220+
→ Types search query and executes search
221+
222+
Result: VS Code shows all TODO comments across the project
223+
```
168224

169-
# 4. Type into it
170-
desktop_type(text="https://github.com", ref="ref_5", submit=True)
225+
### Example 4: Window Targeting for Multi-Window Automation
171226

172-
# 5. Use keyboard shortcuts
173-
desktop_key(key="t", modifiers=["ctrl"]) # New tab
227+
```
228+
User: "Help me copy data from the spreadsheet to the email"
229+
230+
Claude uses:
231+
1. desktop_context(list_available=True)
232+
→ Lists all available windows
233+
234+
2. desktop_target_window(app_name="LibreOffice Calc", color="green")
235+
→ Targets spreadsheet with green border
236+
237+
3. desktop_target_window(app_name="Thunderbird", color="blue")
238+
→ Targets email client with blue border
239+
240+
4. desktop_snapshot()
241+
→ Only shows elements from targeted windows (reduced context)
242+
243+
5. [Proceeds with copy/paste operations between windows]
244+
245+
Result: Claude can efficiently work across multiple applications
174246
```
175247

176248
## Platform Support
@@ -238,6 +310,20 @@ This project was created with Claude Code and we warmly welcome contributions! W
238310

239311
We're very open to help and collaboration. See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
240312

313+
## Privacy Policy
314+
315+
Linux Desktop MCP is a local desktop automation tool that:
316+
317+
- **Runs entirely on your local machine** - No data is transmitted to external servers
318+
- **Does not collect any personal data** - No analytics, telemetry, or usage tracking
319+
- **Does not store credentials** - All authentication and authorization is handled by your local system
320+
- **Accesses only what you explicitly target** - The accessibility tree is read only for windows/applications you interact with
321+
- **No network connectivity required** - The MCP server operates completely offline
322+
323+
The only data accessed is the accessibility tree information exposed by your desktop applications (UI element names, roles, and states), which is used solely for local automation and is not persisted or transmitted anywhere.
324+
325+
**Contact:** For privacy-related questions, open an issue on [GitHub](https://github.com/BeckhamLabsLLC/linux-desktop-mcp/issues).
326+
241327
## License
242328

243329
MIT - See [LICENSE](LICENSE) for details.

0 commit comments

Comments
 (0)