@editsquare/mcp 0.0.0-stage → 0.1.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 +87 -2
- package/cli.js +2422 -0
- package/harness/assets/__vite-browser-external-BIHI7g3E.js +1 -0
- package/harness/assets/index-C5KTTkmq.js +6451 -0
- package/harness/index.html +16 -0
- package/package.json +20 -4
package/README.md
CHANGED
|
@@ -1,3 +1,88 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Edit Square MCP server
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Make and edit motion graphics in your [Edit Square](https://editsquare.com) projects from your AI assistant: text, shapes, media, animation presets, effects and cameras. Your assistant checks its own work by rendering frames as it goes, and you watch each change land in the editor.
|
|
4
|
+
|
|
5
|
+
It is a standard local MCP server, so it works with any app that runs one: Claude Code, the Claude desktop app, Cursor, VS Code, Codex, Windsurf, Zed, Gemini CLI and others. More at [editsquare.com/mcp](https://editsquare.com/mcp).
|
|
6
|
+
|
|
7
|
+
## What you need
|
|
8
|
+
|
|
9
|
+
- **An Edit Square Premium plan.** The server works through the Edit Square API, which comes with [Premium](https://editsquare.com/pricing).
|
|
10
|
+
- **An API key.** In the [dashboard](https://dashboard.editsquare.com), click your avatar, choose **API Keys**, then **Create**.
|
|
11
|
+
- **Node.js 20 or later.** The Claude desktop download doesn't need it.
|
|
12
|
+
- **Google Chrome or Microsoft Edge**, so your assistant can look at the frames it makes. Everything else works without one.
|
|
13
|
+
|
|
14
|
+
## Install
|
|
15
|
+
|
|
16
|
+
Every client runs the same command, `npx -y @editsquare/mcp`, with your key in `EDITSQUARE_API_KEY`. Keep the key in the environment like this rather than on the command line.
|
|
17
|
+
|
|
18
|
+
**Add it to your user settings, not a project.** Most clients keep the key as plain text in their config file. A project-level file (`.mcp.json`, `.cursor/mcp.json`) can end up committed to a repository; a user-level one stays in your home directory.
|
|
19
|
+
|
|
20
|
+
**Claude Code**
|
|
21
|
+
|
|
22
|
+
```sh
|
|
23
|
+
claude mcp add --scope user editsquare --env EDITSQUARE_API_KEY=sk_your_key -- npx -y @editsquare/mcp
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
**Claude desktop app:** download [editsquare-latest.mcpb](https://downloads.editsquare.com/mcp/editsquare-latest.mcpb) and open it. The app asks for your API key.
|
|
27
|
+
|
|
28
|
+
**Cursor** (`~/.cursor/mcp.json`, not a project's `.cursor` folder) and most other clients:
|
|
29
|
+
|
|
30
|
+
```json
|
|
31
|
+
{
|
|
32
|
+
"mcpServers": {
|
|
33
|
+
"editsquare": {
|
|
34
|
+
"command": "npx",
|
|
35
|
+
"args": ["-y", "@editsquare/mcp"],
|
|
36
|
+
"env": { "EDITSQUARE_API_KEY": "sk_your_key" }
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
**VS Code** (`.vscode/mcp.json` or your user MCP configuration), which prompts for the key and keeps it in its secret storage, so the file holds no key:
|
|
43
|
+
|
|
44
|
+
```json
|
|
45
|
+
{
|
|
46
|
+
"inputs": [
|
|
47
|
+
{ "type": "promptString", "id": "editsquare-key", "description": "Edit Square API key", "password": true }
|
|
48
|
+
],
|
|
49
|
+
"servers": {
|
|
50
|
+
"editsquare": {
|
|
51
|
+
"type": "stdio",
|
|
52
|
+
"command": "npx",
|
|
53
|
+
"args": ["-y", "@editsquare/mcp"],
|
|
54
|
+
"env": { "EDITSQUARE_API_KEY": "${input:editsquare-key}" }
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
**Codex** (`~/.codex/config.toml`):
|
|
61
|
+
|
|
62
|
+
```toml
|
|
63
|
+
[mcp_servers.editsquare]
|
|
64
|
+
command = "npx"
|
|
65
|
+
args = ["-y", "@editsquare/mcp"]
|
|
66
|
+
env = { EDITSQUARE_API_KEY = "sk_your_key" }
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Browser-based chat apps (ChatGPT or Claude on the web) only connect to hosted MCP servers, so they can't run this one yet.
|
|
70
|
+
|
|
71
|
+
## Using it
|
|
72
|
+
|
|
73
|
+
Ask for what you want, like *"Make a 10-second vertical promo for our summer sale"* or *"Open my Launch project and make the title bigger"*. You can also paste a project's link from the editor. Your assistant lists, opens or creates the project itself, in your Edit Square account.
|
|
74
|
+
|
|
75
|
+
It opens the project in the editor so you can watch each change land, and undo reverts its changes like your own, one request at a time. It can search stock photos and video for you; there's nothing extra to set up.
|
|
76
|
+
|
|
77
|
+
## Settings
|
|
78
|
+
|
|
79
|
+
| Environment variable | What it does |
|
|
80
|
+
| --- | --- |
|
|
81
|
+
| `EDITSQUARE_API_KEY` | Your API key. Required. |
|
|
82
|
+
| `EDITSQUARE_BROWSER` | Path to a Chromium-based browser, if Chrome and Edge aren't installed where they usually are. |
|
|
83
|
+
|
|
84
|
+
On a computer without a graphics card (a cloud or Linux server, say), frames still render correctly but more slowly.
|
|
85
|
+
|
|
86
|
+
## Privacy
|
|
87
|
+
|
|
88
|
+
The server runs on your computer and never prints your key. Your assistant's changes go to your project the same way your own edits in the editor do.
|