Skip to content

Commit 221f2cc

Browse files
committed
update mcp readme
1 parent a8f4ee0 commit 221f2cc

File tree

1 file changed

+57
-32
lines changed

1 file changed

+57
-32
lines changed

packages/magnitude-mcp/README.md

Lines changed: 57 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
# Magnitude MCP
22

3-
A Model Context Protocol (MCP) server that gives agents the ability to interact with the browser using the [Magnitude](https://github.com/sagekit/magnitude) framework.
3+
A Model Context Protocol (MCP) server that gives agents the ability to interact with a browser using the [Magnitude](https://github.com/sagekit/magnitude) framework.
44

55
## Requirements
6-
The agent using this MCP must be **visually grounded**. Generally this means Claude (Sonnet 3.7/4, Opus 4) or Qwen VL series. See [docs](https://docs.magnitude.run/core-concepts/compatible-llms) for more info.
6+
Since Magnitude relies on vision-based browser interaction, the agent using this MCP must be **visually grounded**. Generally this means Claude (Sonnet 3.7/4, Opus 4) or Qwen VL series. See [docs](https://docs.magnitude.run/core-concepts/compatible-llms) for more info.
77

8-
If the agent model is not Claude Sonnet 4, Sonnet 3.7, Opus 4, Qwen 2.5 VL, or Qwen 3 VL, it will probably not work with this MCP - because the vast majority of models cannot click accurately based on an image alone.
8+
## Capabilities
9+
10+
Magnitude MCP enables the same browser actions as the Magnitude agent but for any MCP-compatible agent instead:
11+
- 🖥️ Open a browser with a persistent profile
12+
- 🖱️ Click, type, drag, etc. using pixel-based coordinates
13+
- 👁️ Automatically see screenshot after each interaction
14+
- ⚡ Take multiple actions at once for efficiency
915

1016
## Installation
1117
```sh
@@ -26,40 +32,16 @@ MCP Configuration:
2632
}
2733
```
2834

29-
MCP configuration options (optional):
30-
```json
31-
{
32-
"mcpServers": {
33-
"magnitude": {
34-
"command": "npx",
35-
"args": [
36-
"magnitude-mcp"
37-
],
38-
"env": {
39-
"MAGNITUDE_MCP_PROFILE_DIR": "/Users/myuser/.magnitude/profiles/default",
40-
"MAGNITUDE_MCP_STEALTH": "true",
41-
"MAGNITUDE_MCP_VIEWPORT_WIDTH": "1024",
42-
"MAGNITUDE_MCP_VIEWPORT_HEIGHT": "728"
43-
}
44-
}
45-
}
46-
}
47-
```
48-
- `MAGNITUDE_MCP_PROFILE_DIR`: Stores cookies and local storage so that credentials can be re-used across agents using the MCP (default: `~/.magnitude/profiles/default`)
49-
- `MAGNITUDE_MCP_STEALTH`: Add extra stealth settings to help with anti-bot detection (default: disabled)
50-
- `MAGNITUDE_MCP_VIEWPORT_WIDTH`: Override viewport width (default: 1024)
51-
- `MAGNITUDE_MCP_VIEWPORT_WIDTH`: Override viewport width (default: 728)
52-
53-
## Claude Code Installation
35+
## Claude Code Setup
5436
```sh
5537
claude mcp add magnitude -- npx magnitude-mcp
5638
```
5739

58-
## Cline Installation
40+
## Cline Setup
5941

6042
Go to `MCP Servers -> Marketplace`, search for `Magnitude`, click `Install`
6143

62-
## Cursor Installation
44+
## Cursor Setup
6345

6446
1. Open Cursor Settings
6547
2. Go to Features > MCP Servers
@@ -78,7 +60,7 @@ Go to `MCP Servers -> Marketplace`, search for `Magnitude`, click `Install`
7860
}
7961
```
8062

81-
## Windsurf Installation
63+
## Windsurf Setup
8264
Add this to your `./codeium/windsurf/model_config.json`:
8365
```json
8466
{
@@ -91,4 +73,47 @@ Add this to your `./codeium/windsurf/model_config.json`:
9173
}
9274
}
9375
}
94-
```
76+
```
77+
78+
79+
## Configuration Options
80+
81+
The MCP can optionally be configured with a different persistent profile directory (for example if you want different projects to use their own browser cookies and local storage), to use stealth mode, or to change the default viewport dimensions.
82+
83+
```json
84+
{
85+
"mcpServers": {
86+
"magnitude": {
87+
"command": "npx",
88+
"args": [
89+
"magnitude-mcp"
90+
],
91+
"env": {
92+
"MAGNITUDE_MCP_PROFILE_DIR": "/Users/myuser/.magnitude/profiles/default",
93+
"MAGNITUDE_MCP_STEALTH": "true",
94+
"MAGNITUDE_MCP_VIEWPORT_WIDTH": "1024",
95+
"MAGNITUDE_MCP_VIEWPORT_HEIGHT": "728"
96+
}
97+
}
98+
}
99+
}
100+
```
101+
- `MAGNITUDE_MCP_PROFILE_DIR`: Stores cookies and local storage so that credentials can be re-used across agents using the MCP (default: `~/.magnitude/profiles/default`)
102+
- `MAGNITUDE_MCP_STEALTH`: Add extra stealth settings to help with anti-bot detection (default: disabled)
103+
- `MAGNITUDE_MCP_VIEWPORT_WIDTH`: Override viewport width (default: 1024)
104+
- `MAGNITUDE_MCP_VIEWPORT_WIDTH`: Override viewport width (default: 728)
105+
106+
## Examples
107+
108+
Why connect your agent to a browser?
109+
- Enable coding agents to see and interact with web apps as they build
110+
- Interact with sites that don't have APIs
111+
- Browse documentation that isn't accessible with fetch
112+
- Improvised testing
113+
- Or whatever else you find use for!
114+
115+
It's even suitable for non-engineering tasks if you just want an easily accessible browser agent.
116+
117+
## Troubleshooting
118+
119+
If the agent model is not Claude Sonnet 4, Sonnet 3.7, Opus 4, Qwen 2.5 VL, or Qwen 3 VL, it will probably not work with this MCP - because the vast majority of models cannot click accurately based on an image alone.

0 commit comments

Comments
 (0)