screenpipe-mcp 0.2.0
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 +103 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +717 -0
- package/manifest.json +58 -0
- package/package.json +38 -0
- package/src/index.ts +799 -0
- package/tsconfig.json +17 -0
package/README.md
ADDED
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
# Screenpipe MCP Server
|
|
2
|
+
|
|
3
|
+
<a href="https://www.pulsemcp.com/servers/mediar-ai-screenpipe"><img src="https://www.pulsemcp.com/badge/top-pick/mediar-ai-screenpipe" width="400" alt="PulseMCP Badge"></a>
|
|
4
|
+
|
|
5
|
+
<br/>
|
|
6
|
+
|
|
7
|
+
https://github.com/user-attachments/assets/7466a689-7703-4f0b-b3e1-b1cb9ed70cff
|
|
8
|
+
|
|
9
|
+
MCP server for screenpipe - search your screen recordings, audio transcriptions, and control your computer with AI.
|
|
10
|
+
|
|
11
|
+
## Installation
|
|
12
|
+
|
|
13
|
+
### Option 1: NPX (Recommended)
|
|
14
|
+
|
|
15
|
+
The easiest way to use screenpipe-mcp is with npx. Edit your Claude Desktop config:
|
|
16
|
+
|
|
17
|
+
- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
18
|
+
- **Windows**: `%AppData%\Claude\claude_desktop_config.json`
|
|
19
|
+
|
|
20
|
+
```json
|
|
21
|
+
{
|
|
22
|
+
"mcpServers": {
|
|
23
|
+
"screenpipe": {
|
|
24
|
+
"command": "npx",
|
|
25
|
+
"args": ["-y", "screenpipe-mcp"]
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### Option 2: From Source
|
|
32
|
+
|
|
33
|
+
Clone and build from source:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
git clone https://github.com/mediar-ai/screenpipe
|
|
37
|
+
cd screenpipe/screenpipe-integrations/screenpipe-mcp
|
|
38
|
+
npm install
|
|
39
|
+
npm run build
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Then configure Claude Desktop:
|
|
43
|
+
|
|
44
|
+
```json
|
|
45
|
+
{
|
|
46
|
+
"mcpServers": {
|
|
47
|
+
"screenpipe": {
|
|
48
|
+
"command": "node",
|
|
49
|
+
"args": ["/absolute/path/to/screenpipe-mcp/dist/index.js"]
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
**Note:** Restart Claude Desktop after making changes.
|
|
56
|
+
|
|
57
|
+
## Testing
|
|
58
|
+
|
|
59
|
+
Test with MCP Inspector:
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
npx @modelcontextprotocol/inspector npx screenpipe-mcp
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## Available Tools
|
|
66
|
+
|
|
67
|
+
### Cross-Platform
|
|
68
|
+
|
|
69
|
+
- **search-content** - Search through recorded screen content, audio transcriptions, and UI elements
|
|
70
|
+
- Full text search with content type filtering (OCR/Audio/UI)
|
|
71
|
+
- Time range and app/window filtering
|
|
72
|
+
- Pagination support
|
|
73
|
+
|
|
74
|
+
- **pixel-control** - Control mouse and keyboard
|
|
75
|
+
- Type text, press keys, move mouse, click
|
|
76
|
+
|
|
77
|
+
### macOS Only
|
|
78
|
+
|
|
79
|
+
- **find-elements** - Find UI elements in applications by role
|
|
80
|
+
- **click-element** - Click UI elements by accessibility ID
|
|
81
|
+
- **fill-element** - Type text into UI elements
|
|
82
|
+
- **scroll-element** - Scroll UI elements
|
|
83
|
+
- **open-application** - Open applications by name
|
|
84
|
+
- **open-url** - Open URLs in default browser
|
|
85
|
+
|
|
86
|
+
## Example Queries in Claude
|
|
87
|
+
|
|
88
|
+
- "Search for any mentions of 'rust' in my screen recordings"
|
|
89
|
+
- "Find audio transcriptions from the last hour"
|
|
90
|
+
- "Show me what was on my screen in VSCode yesterday"
|
|
91
|
+
- "Open Safari and go to github.com"
|
|
92
|
+
- "Find the search button in Chrome and click it"
|
|
93
|
+
|
|
94
|
+
## Requirements
|
|
95
|
+
|
|
96
|
+
- screenpipe must be running on localhost:3030
|
|
97
|
+
- Node.js >= 18.0.0
|
|
98
|
+
|
|
99
|
+
## Notes
|
|
100
|
+
|
|
101
|
+
- All timestamps are handled in UTC
|
|
102
|
+
- Results are formatted for readability in Claude's interface
|
|
103
|
+
- macOS automation features require accessibility permissions
|
package/dist/index.d.ts
ADDED