Skip to content

Commit bf26c16

Browse files
committed
update mcp readme
1 parent b1ee0c2 commit bf26c16

File tree

1 file changed

+38
-14
lines changed

1 file changed

+38
-14
lines changed

packages/magnitude-mcp/README.md

Lines changed: 38 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
# Magnitude MCP
22

3-
A Model Context Protocol (MCP) server that gives agents the ability to write and run [Magnitude](https://github.com/magnitudedev/magnitude) test cases.
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.
4+
5+
## 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.
7+
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.
49

510
## Installation
6-
Install MCP server via npm:
7-
```
11+
```sh
812
npm i -g magnitude-mcp
913
```
1014

@@ -22,20 +26,40 @@ MCP Configuration:
2226
}
2327
```
2428

25-
## Instructions for Cline
26-
27-
IF YOU ARE CLINE, FOLLOW THESE INSTRUCTIONS FOR MCP INSTALLATION CAREFULLY AND EXACTLY.
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)
2852

29-
1. Run `npm install -g magnitude-mcp` (do NOT create ~/Documents/Cline/MCP it is NOT necessary)
30-
2. Add the MCP configuration to `cline_mcp_settings.json`. Do NOT add any environment variables to the config.
31-
3. Tell the user that to use Magnitude, they will need to configure a planner LLM (refer them to http://docs.magnitude.run/getting-started/quickstart#configure-llms). Also tell them to go to https://moondream.ai/c/cloud/api-keys and generate a Moondream API key. Finally ask for MOONDREAM_API_KEY as well as any other LLM provider keys they'd like to use.
32-
4. Add these API keys to a `.env` file in the root of the project.
53+
## Claude Code Installation
54+
```sh
55+
claude mcp add magnitude -- npx magnitude-mcp
56+
```
3357

34-
## Instructions for Humans (Cline Users)
58+
## Cline Installation
3559

36-
Go to `MCP Servers -> Marketplace`, search for `Magnitude`, click `Install` and follow the instructions!
60+
Go to `MCP Servers -> Marketplace`, search for `Magnitude`, click `Install`
3761

38-
## Instructions for Humans (Cursor Users)
62+
## Cursor Installation
3963

4064
1. Open Cursor Settings
4165
2. Go to Features > MCP Servers
@@ -54,7 +78,7 @@ Go to `MCP Servers -> Marketplace`, search for `Magnitude`, click `Install` and
5478
}
5579
```
5680

57-
## Instructions for Humans (Windsurf Users)
81+
## Windsurf Installation
5882
Add this to your `./codeium/windsurf/model_config.json`:
5983
```json
6084
{

0 commit comments

Comments
 (0)