@se-studio/contentful-cms 1.0.27 → 1.0.28
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/INSTALL.md +132 -0
- package/package.json +1 -1
package/INSTALL.md
ADDED
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
# Installing the Contentful CMS Editor for Claude Desktop
|
|
2
|
+
|
|
3
|
+
This guide sets up Claude Desktop so it can read and edit your Contentful content.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## What you'll need
|
|
8
|
+
|
|
9
|
+
- **Contentful Space ID** — a short code that identifies your project in Contentful
|
|
10
|
+
- **Contentful Management Token** — a secret key that gives Claude permission to edit content
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Step 1 — Get your Contentful details
|
|
15
|
+
|
|
16
|
+
### Space ID
|
|
17
|
+
|
|
18
|
+
1. Log in to [contentful.com](https://app.contentful.com)
|
|
19
|
+
2. Click **Settings** in the top menu, then **General settings**
|
|
20
|
+
3. Copy the **Space ID** — it looks like `abc123xyz`
|
|
21
|
+
|
|
22
|
+
### Management Token
|
|
23
|
+
|
|
24
|
+
1. Click **Settings** → **API keys**
|
|
25
|
+
2. Click the **Content management tokens** tab
|
|
26
|
+
3. Click **Generate personal token**
|
|
27
|
+
4. Give it a name (e.g. `Claude Desktop`) and click **Generate**
|
|
28
|
+
5. **Copy the token now** — you won't be able to see it again
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## Step 2 — Create your config file
|
|
33
|
+
|
|
34
|
+
You need to create a file called `.contentful-cms.json` in your home folder.
|
|
35
|
+
|
|
36
|
+
> Your home folder is `C:\Users\YourName` on Windows, or `/Users/YourName` on Mac.
|
|
37
|
+
|
|
38
|
+
Create the file with this content, replacing the placeholder values:
|
|
39
|
+
|
|
40
|
+
```json
|
|
41
|
+
{
|
|
42
|
+
"defaultSpace": "my-project",
|
|
43
|
+
"spaces": {
|
|
44
|
+
"my-project": {
|
|
45
|
+
"spaceId": "YOUR_SPACE_ID",
|
|
46
|
+
"environment": "master",
|
|
47
|
+
"managementToken": "YOUR_MANAGEMENT_TOKEN",
|
|
48
|
+
"defaultLocale": "en-US"
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Replace:
|
|
55
|
+
- `YOUR_SPACE_ID` with the Space ID from Step 1
|
|
56
|
+
- `YOUR_MANAGEMENT_TOKEN` with the token from Step 1
|
|
57
|
+
- `my-project` (in both places) with a short name for your project — no spaces, e.g. `om1` or `brightline`
|
|
58
|
+
|
|
59
|
+
**On Windows:** Open Notepad, paste the content above, then save as `C:\Users\YourName\.contentful-cms.json`
|
|
60
|
+
- In the Save dialog, set "Save as type" to **All Files** so it doesn't add `.txt`
|
|
61
|
+
|
|
62
|
+
**On Mac:** Open TextEdit, switch to plain text mode (Format → Make Plain Text), paste the content, then save as `/Users/YourName/.contentful-cms.json`
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
## Step 3 — Configure Claude Desktop
|
|
67
|
+
|
|
68
|
+
You need to tell Claude Desktop to load the CMS editor tool.
|
|
69
|
+
|
|
70
|
+
### Find the Claude Desktop config file
|
|
71
|
+
|
|
72
|
+
**Windows:** `C:\Users\YourName\AppData\Roaming\Claude\claude_desktop_config.json`
|
|
73
|
+
|
|
74
|
+
**Mac:** `/Users/YourName/Library/Application Support/Claude/claude_desktop_config.json`
|
|
75
|
+
|
|
76
|
+
> On Mac, the `Library` folder is hidden. In Finder, click **Go** in the menu bar, hold **Option**, and click **Library**.
|
|
77
|
+
|
|
78
|
+
### Edit the config file
|
|
79
|
+
|
|
80
|
+
Open the file in a text editor. If it's empty or doesn't exist, start with `{}`.
|
|
81
|
+
|
|
82
|
+
Add the `mcpServers` section shown below. If the file already has content, you'll need to merge carefully — ask for help if unsure.
|
|
83
|
+
|
|
84
|
+
**Windows:**
|
|
85
|
+
```json
|
|
86
|
+
{
|
|
87
|
+
"mcpServers": {
|
|
88
|
+
"cms-edit": {
|
|
89
|
+
"command": "npx",
|
|
90
|
+
"args": ["-y", "@se-studio/contentful-cms"],
|
|
91
|
+
"cwd": "C:\\Users\\YourName"
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
**Mac:**
|
|
98
|
+
```json
|
|
99
|
+
{
|
|
100
|
+
"mcpServers": {
|
|
101
|
+
"cms-edit": {
|
|
102
|
+
"command": "npx",
|
|
103
|
+
"args": ["-y", "@se-studio/contentful-cms"],
|
|
104
|
+
"cwd": "/Users/YourName"
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
Replace `YourName` with your actual username in both `cwd` and the file path.
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
|
|
114
|
+
## Step 4 — Restart Claude Desktop
|
|
115
|
+
|
|
116
|
+
Fully quit Claude Desktop and reopen it. On Mac, right-click the Dock icon and choose **Quit** (just closing the window isn't enough).
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
|
|
120
|
+
## Step 5 — Test it
|
|
121
|
+
|
|
122
|
+
In a new Claude conversation, type:
|
|
123
|
+
|
|
124
|
+
> What Contentful spaces do you have access to?
|
|
125
|
+
|
|
126
|
+
Claude should respond with the space name you configured (e.g. `my-project`). If it does, you're all set.
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
## Something not working?
|
|
131
|
+
|
|
132
|
+
Get in touch and we'll sort it out together.
|