@avocadostudio-ai/mcp-server 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/LICENSE +201 -0
- package/README.md +128 -0
- package/dist/capabilities.d.ts +63 -0
- package/dist/capabilities.js +116 -0
- package/dist/config.d.ts +15 -0
- package/dist/config.js +17 -0
- package/dist/http-auth.d.ts +14 -0
- package/dist/http-auth.js +26 -0
- package/dist/http.d.ts +13 -0
- package/dist/http.js +132 -0
- package/dist/index.d.ts +10 -0
- package/dist/index.js +32 -0
- package/dist/orchestrator-client.d.ts +93 -0
- package/dist/orchestrator-client.js +64 -0
- package/dist/tools/_helpers.d.ts +33 -0
- package/dist/tools/_helpers.js +58 -0
- package/dist/tools/blocks.d.ts +4 -0
- package/dist/tools/blocks.js +256 -0
- package/dist/tools/chat.d.ts +3 -0
- package/dist/tools/chat.js +52 -0
- package/dist/tools/discovery.d.ts +4 -0
- package/dist/tools/discovery.js +105 -0
- package/dist/tools/history.d.ts +3 -0
- package/dist/tools/history.js +37 -0
- package/dist/tools/index.d.ts +10 -0
- package/dist/tools/index.js +28 -0
- package/dist/tools/media.d.ts +3 -0
- package/dist/tools/media.js +84 -0
- package/dist/tools/pages.d.ts +4 -0
- package/dist/tools/pages.js +131 -0
- package/dist/tools/preview.d.ts +3 -0
- package/dist/tools/preview.js +32 -0
- package/dist/tools/publishing.d.ts +3 -0
- package/dist/tools/publishing.js +67 -0
- package/dist/tools/sessions.d.ts +8 -0
- package/dist/tools/sessions.js +39 -0
- package/dist/tools/sites.d.ts +3 -0
- package/dist/tools/sites.js +90 -0
- package/dist/version.d.ts +1 -0
- package/dist/version.js +16 -0
- package/package.json +68 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for describing the origin of the Work and
|
|
141
|
+
reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Support. While redistributing the Work or
|
|
166
|
+
Derivative Works thereof, You may choose to offer, and charge a
|
|
167
|
+
fee for, acceptance of support, warranty, indemnity, or other
|
|
168
|
+
liability obligations and/or rights consistent with this License.
|
|
169
|
+
However, in accepting such obligations, You may act only on Your
|
|
170
|
+
own behalf and on Your sole responsibility, not on behalf of any
|
|
171
|
+
other Contributor, and only if You agree to indemnify, defend,
|
|
172
|
+
and hold each Contributor harmless for any liability incurred by,
|
|
173
|
+
or claims asserted against, such Contributor by reason of your
|
|
174
|
+
accepting any such warranty or support.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 Avocado Studio Contributors
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
# Avocado Studio MCP Server
|
|
2
|
+
|
|
3
|
+
Exposes Avocado Studio's page, block, and discovery tools over the [Model Context Protocol](https://modelcontextprotocol.io/) so MCP hosts (Claude Desktop, Claude Code, etc.) can drive a site the same way a human does in the editor.
|
|
4
|
+
|
|
5
|
+
Each install is scoped to **one site**: `(session, siteId)` are bound at launch via env vars. The server is a thin wrapper over the orchestrator HTTP API — the orchestrator remains the source of truth for validation, persistence, undo history, and demo-mode gating.
|
|
6
|
+
|
|
7
|
+
## Tool catalog (47 tools)
|
|
8
|
+
|
|
9
|
+
| Group | Tools |
|
|
10
|
+
|------|-------|
|
|
11
|
+
| Discovery | `avocado-list-block-types`, `avocado-get-block-schema` |
|
|
12
|
+
| Pages | `avocado-get-page`, `avocado-list-pages`, `avocado-create-page`, `avocado-rename-page`, `avocado-duplicate-page`, `avocado-remove-page`, `avocado-update-page-meta` |
|
|
13
|
+
| Blocks | `avocado-add-block`, `avocado-update-block-props`, `avocado-remove-block`, `avocado-move-block`, `avocado-duplicate-block`, `avocado-add-list-item`, `avocado-update-list-item`, `avocado-remove-list-item`, `avocado-move-list-item` |
|
|
14
|
+
| Sites | `avocado-register-site`, `avocado-list-sites`, `avocado-get-site-config`, `avocado-update-site-config` |
|
|
15
|
+
| Media | `avocado-upload-image`, `avocado-generate-image`, `avocado-search-unsplash`, `avocado-transcribe-audio`, `avocado-interpret-image` |
|
|
16
|
+
| Publishing | `avocado-compute-publish-diff`, `avocado-publish-content`, `avocado-get-publish-status`, `avocado-list-snapshots`, `avocado-restore-snapshot` |
|
|
17
|
+
| History | `avocado-undo-edit`, `avocado-redo-edit`, `avocado-restore-version` |
|
|
18
|
+
| Planner | `avocado-chat-plan`, `avocado-preview-plan`, `avocado-approve-pending-plan`, `avocado-discard-pending-plan` |
|
|
19
|
+
| Preview | `avocado-screenshot-page` — returns a full-page JPEG inline (visual feedback channel for chat-only hosts like Claude Desktop) |
|
|
20
|
+
|
|
21
|
+
Two transports, same tool registry:
|
|
22
|
+
- **stdio** — `src/index.ts`. MCP host spawns the server as a subprocess. Best for local dev / Claude Code.
|
|
23
|
+
- **HTTP (streamable)** — `src/http.ts`. Runs on a port; MCP hosts connect via URL + bearer token. Required for Claude Desktop's "Add custom connector" flow and remote deployments.
|
|
24
|
+
|
|
25
|
+
## Install — Claude Code
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
claude mcp add avocado \
|
|
29
|
+
--env ORCHESTRATOR_URL=http://localhost:4200 \
|
|
30
|
+
--env AVOCADO_SESSION=dev \
|
|
31
|
+
--env AVOCADO_SITE_ID=avocado-stories \
|
|
32
|
+
-- npx -y @avocadostudio-ai/mcp-server
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Install — Claude Desktop
|
|
36
|
+
|
|
37
|
+
Edit `~/Library/Application Support/Claude/claude_desktop_config.json`:
|
|
38
|
+
|
|
39
|
+
```json
|
|
40
|
+
{
|
|
41
|
+
"mcpServers": {
|
|
42
|
+
"avocado-studio": {
|
|
43
|
+
"command": "npx",
|
|
44
|
+
"args": ["-y", "@avocadostudio-ai/mcp-server"],
|
|
45
|
+
"env": {
|
|
46
|
+
"ORCHESTRATOR_URL": "http://localhost:4200",
|
|
47
|
+
"AVOCADO_SESSION": "dev",
|
|
48
|
+
"AVOCADO_SITE_ID": "avocado-stories"
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
Restart Claude Desktop. Tools appear under `avocado-studio` and can be individually set to **Always allow / Ask / Never allow**.
|
|
56
|
+
|
|
57
|
+
## Install — HTTP / custom connector
|
|
58
|
+
|
|
59
|
+
Start the HTTP server:
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
AVOCADO_SITE_ID=avocado-stories \
|
|
63
|
+
AVOCADO_MCP_BEARER_TOKEN=$(openssl rand -hex 32) \
|
|
64
|
+
npx -y -p @avocadostudio-ai/mcp-server avocado-mcp-http
|
|
65
|
+
# → avocado-studio MCP server listening on http://localhost:4300/mcp
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Health probe (no auth): `curl http://localhost:4300/healthz`
|
|
69
|
+
|
|
70
|
+
In Claude Desktop → **Settings → Connectors → Add custom connector**:
|
|
71
|
+
|
|
72
|
+
- **URL:** `http://localhost:4300/mcp` (or a public HTTPS URL once deployed)
|
|
73
|
+
- **Auth:** Bearer — paste the token you generated above
|
|
74
|
+
|
|
75
|
+
Raw JSON-RPC example:
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
curl -X POST http://localhost:4300/mcp \
|
|
79
|
+
-H "Authorization: Bearer $TOKEN" \
|
|
80
|
+
-H "content-type: application/json" \
|
|
81
|
+
-H "accept: application/json, text/event-stream" \
|
|
82
|
+
-d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
The HTTP transport runs in **stateless mode** — each request is independent, no session state on the server. POST only (GET/DELETE return 405).
|
|
86
|
+
|
|
87
|
+
## Env vars
|
|
88
|
+
|
|
89
|
+
| Var | Required | Default | Notes |
|
|
90
|
+
|-----|----------|---------|-------|
|
|
91
|
+
| `AVOCADO_SITE_ID` | **yes** | — | Which site this install edits (e.g. `avocado-stories`). |
|
|
92
|
+
| `ORCHESTRATOR_URL` | no | `http://localhost:4200` | Points at the Avocado Studio orchestrator. |
|
|
93
|
+
| `AVOCADO_SESSION` | no | `dev` | Session key that scopes draft state. |
|
|
94
|
+
| `AVOCADO_PUBLISH_TOKEN` | no | — | Required only for `avocado-publish-content`. Must match the orchestrator's `DRAFT_MODE_SECRET`. Omit to disable publish through MCP. |
|
|
95
|
+
| `AVOCADO_MCP_BEARER_TOKEN` | **yes (HTTP mode)** | — | Shared secret clients must send as `Authorization: Bearer <token>`. Generate with `openssl rand -hex 32`. Only read by `src/http.ts`. |
|
|
96
|
+
| `AVOCADO_MCP_PORT` | no | `4300` | Port for HTTP mode. |
|
|
97
|
+
|
|
98
|
+
## Design notes
|
|
99
|
+
|
|
100
|
+
- **Thin wrapper, single source of truth.** Every mutation goes through `POST /ops`, which runs the existing Zod validation, ops-engine, undo stack, version log, and demo-mode gate. The MCP server never mutates state directly.
|
|
101
|
+
- **Discovery before mutation.** `avocado-list-block-types` + `avocado-get-block-schema` are the intended entry points for agents. Calling `avocado-add-block` without first fetching the schema risks invalid prop shapes → 400 from the orchestrator.
|
|
102
|
+
- **Read-only vs. destructive.** Discovery and `avocado-get-page` / `avocado-list-pages` are safe to mark **Always allow**. Mutations should stay on **Ask**.
|
|
103
|
+
- **Block registration.** Importing the `@avocadostudio-ai/shared` package root is enough to trigger every block's `registerBlock()` side effect — its barrel re-exports `./blocks/index.ts`. Do **not** deep-import `@avocadostudio-ai/shared/src/...`: the published tarball ships `dist/` only, and the package now declares an `exports` map that closes that path off.
|
|
104
|
+
|
|
105
|
+
## Tests
|
|
106
|
+
|
|
107
|
+
```bash
|
|
108
|
+
pnpm --filter @avocadostudio-ai/mcp-server test
|
|
109
|
+
pnpm --filter @avocadostudio-ai/mcp-server typecheck
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
Tests stub `fetch` to assert HTTP call shape. They don't start a real orchestrator.
|
|
113
|
+
|
|
114
|
+
## Forward plan
|
|
115
|
+
|
|
116
|
+
### Phase 3a — HTTP transport ✅ shipped
|
|
117
|
+
`StreamableHTTPServerTransport` mounted in `src/http.ts` with bearer auth (`AVOCADO_MCP_BEARER_TOKEN`). Stateless mode, POST-only, `/healthz` probe. Testable locally; ready to deploy.
|
|
118
|
+
|
|
119
|
+
### Phase 3b — hosted deployment + OAuth
|
|
120
|
+
1. **Deploy** the `avocado-mcp-http` process to Render alongside the orchestrator. Public HTTPS URL required by Claude Desktop's connector flow.
|
|
121
|
+
2. **OAuth gateway** — AEM uses "Complete the Adobe login flow". Add OAuth 2.1 with PKCE in front of `/mcp` so bearer tokens are minted via an auth code exchange rather than shared-secret copy/paste. Token claims encode `siteId` (keeps per-site scoping).
|
|
122
|
+
3. **Claude connector directory submission** — public HTTPS URL, OAuth endpoints, logo, description, per-tool permission matrix screenshot. Lands "Avocado Studio Content MCP Service" in Claude Desktop's built-in connector list.
|
|
123
|
+
4. **Safety** — per-tool `readOnlyHint` annotations so Claude auto-allows reads; audit log piggybacking on existing orchestrator telemetry; rate limit on `/mcp` (reuse demo-mode's per-IP limiter).
|
|
124
|
+
|
|
125
|
+
### Phase 4 — nice-to-haves
|
|
126
|
+
- MCP resources (not just tools) for page + site-config, so hosts can pin them as context without a tool call.
|
|
127
|
+
- MCP prompts (slash-command templates) for common flows: "draft a pricing page", "refresh hero copy site-wide".
|
|
128
|
+
- Typed client SDK generated from the orchestrator's OpenAPI so the wrapper stays auto-synced.
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* What the site behind this install will actually honour.
|
|
3
|
+
*
|
|
4
|
+
* All ~47 tools register unconditionally, whatever the adapter behind them
|
|
5
|
+
* supports. On a CMS-routed site `avocado-create-page` applies cleanly,
|
|
6
|
+
* previews correctly and reports success — then produces a page that can never
|
|
7
|
+
* be published, and that fails the entire publish transaction when tried. An
|
|
8
|
+
* agent told "this site cannot create pages" is strictly more useful than one
|
|
9
|
+
* that can create a broken one.
|
|
10
|
+
*
|
|
11
|
+
* Three properties this has to have, and they are what the design is for:
|
|
12
|
+
*
|
|
13
|
+
* 1. **Registration must never wait on the network.** In stdio, tools are
|
|
14
|
+
* registered before the transport is even connected; making that block on
|
|
15
|
+
* an HTTP call means the MCP server fails to start whenever the site is
|
|
16
|
+
* down. So everything registers, and gated tools are disabled afterwards,
|
|
17
|
+
* asynchronously, once the site has answered.
|
|
18
|
+
*
|
|
19
|
+
* 2. **Silence is permission.** An orchestrator that is unreachable, in demo
|
|
20
|
+
* mode, or simply older than this field all produce the same answer as an
|
|
21
|
+
* adapter that declared nothing: unknown, and unknown permits. A
|
|
22
|
+
* restrictive default would withdraw working tools from every existing
|
|
23
|
+
* install the moment the network hiccuped.
|
|
24
|
+
*
|
|
25
|
+
* 3. **Hiding is not enough.** Some hosts cache the tool list and ignore
|
|
26
|
+
* `notifications/tools/list_changed`, and the SDK's own refusal for a
|
|
27
|
+
* disabled tool ("Tool X disabled") carries no reason. Gated handlers
|
|
28
|
+
* therefore also refuse at call time, with text that says why.
|
|
29
|
+
*/
|
|
30
|
+
import type { OrchestratorClient } from "./orchestrator-client.ts";
|
|
31
|
+
export type CapabilityKey = "createPages" | "deletePages" | "structuralEdits";
|
|
32
|
+
export type CapabilitySnapshot = {
|
|
33
|
+
createPages: boolean;
|
|
34
|
+
deletePages: boolean;
|
|
35
|
+
structuralEdits: boolean;
|
|
36
|
+
/** Where the answer came from. `unknown` is the permissive default. */
|
|
37
|
+
source: "orchestrator" | "unknown";
|
|
38
|
+
/** Present when `source` is "unknown" and we tried — why we could not tell. */
|
|
39
|
+
reason?: string;
|
|
40
|
+
};
|
|
41
|
+
/** A tool handle, narrowed to the two methods we use. Avoids importing the SDK's internals. */
|
|
42
|
+
type ToolHandle = {
|
|
43
|
+
enable(): void;
|
|
44
|
+
disable(): void;
|
|
45
|
+
};
|
|
46
|
+
export interface CapabilityGate {
|
|
47
|
+
/** Refusal text when the site has explicitly said no, else null. */
|
|
48
|
+
refuse(key: CapabilityKey): string | null;
|
|
49
|
+
/** Hand the gate a registered tool so it can hide it once the site answers. */
|
|
50
|
+
track(key: CapabilityKey, tool: ToolHandle): void;
|
|
51
|
+
/** Ask the orchestrator and apply the answer to every tracked tool. */
|
|
52
|
+
refresh(): Promise<CapabilitySnapshot>;
|
|
53
|
+
/** The current answer, without asking. */
|
|
54
|
+
snapshot(): CapabilitySnapshot;
|
|
55
|
+
}
|
|
56
|
+
export type CapabilityGateOptions = {
|
|
57
|
+
/** How long an answer stays good. Default 60s. */
|
|
58
|
+
ttlMs?: number;
|
|
59
|
+
/** How long to wait for the probe. Default 2s — this must never delay a tool call much. */
|
|
60
|
+
timeoutMs?: number;
|
|
61
|
+
};
|
|
62
|
+
export declare function createCapabilityGate(client: OrchestratorClient, options?: CapabilityGateOptions): CapabilityGate;
|
|
63
|
+
export {};
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* What the site behind this install will actually honour.
|
|
3
|
+
*
|
|
4
|
+
* All ~47 tools register unconditionally, whatever the adapter behind them
|
|
5
|
+
* supports. On a CMS-routed site `avocado-create-page` applies cleanly,
|
|
6
|
+
* previews correctly and reports success — then produces a page that can never
|
|
7
|
+
* be published, and that fails the entire publish transaction when tried. An
|
|
8
|
+
* agent told "this site cannot create pages" is strictly more useful than one
|
|
9
|
+
* that can create a broken one.
|
|
10
|
+
*
|
|
11
|
+
* Three properties this has to have, and they are what the design is for:
|
|
12
|
+
*
|
|
13
|
+
* 1. **Registration must never wait on the network.** In stdio, tools are
|
|
14
|
+
* registered before the transport is even connected; making that block on
|
|
15
|
+
* an HTTP call means the MCP server fails to start whenever the site is
|
|
16
|
+
* down. So everything registers, and gated tools are disabled afterwards,
|
|
17
|
+
* asynchronously, once the site has answered.
|
|
18
|
+
*
|
|
19
|
+
* 2. **Silence is permission.** An orchestrator that is unreachable, in demo
|
|
20
|
+
* mode, or simply older than this field all produce the same answer as an
|
|
21
|
+
* adapter that declared nothing: unknown, and unknown permits. A
|
|
22
|
+
* restrictive default would withdraw working tools from every existing
|
|
23
|
+
* install the moment the network hiccuped.
|
|
24
|
+
*
|
|
25
|
+
* 3. **Hiding is not enough.** Some hosts cache the tool list and ignore
|
|
26
|
+
* `notifications/tools/list_changed`, and the SDK's own refusal for a
|
|
27
|
+
* disabled tool ("Tool X disabled") carries no reason. Gated handlers
|
|
28
|
+
* therefore also refuse at call time, with text that says why.
|
|
29
|
+
*/
|
|
30
|
+
const PERMISSIVE = {
|
|
31
|
+
createPages: true,
|
|
32
|
+
deletePages: true,
|
|
33
|
+
structuralEdits: true,
|
|
34
|
+
source: "unknown"
|
|
35
|
+
};
|
|
36
|
+
/** Human-readable name for each capability, used in refusal text. */
|
|
37
|
+
const WHAT = {
|
|
38
|
+
createPages: "create pages",
|
|
39
|
+
deletePages: "delete pages",
|
|
40
|
+
structuralEdits: "add, remove, move or duplicate blocks"
|
|
41
|
+
};
|
|
42
|
+
export function createCapabilityGate(client, options = {}) {
|
|
43
|
+
const ttlMs = options.ttlMs ?? 60_000;
|
|
44
|
+
const timeoutMs = options.timeoutMs ?? 2_000;
|
|
45
|
+
let current = PERMISSIVE;
|
|
46
|
+
let fetchedAt = 0;
|
|
47
|
+
let inFlight = null;
|
|
48
|
+
const tracked = [];
|
|
49
|
+
function apply(next) {
|
|
50
|
+
current = next;
|
|
51
|
+
for (const { key, tool } of tracked) {
|
|
52
|
+
// enable()/disable() are idempotent, so this needs no diffing.
|
|
53
|
+
if (next[key])
|
|
54
|
+
tool.enable();
|
|
55
|
+
else
|
|
56
|
+
tool.disable();
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
async function probe() {
|
|
60
|
+
/*
|
|
61
|
+
* `/status/planner`, not `/whoami`: whoami awaits the adapter bootstrap —
|
|
62
|
+
* the cold CMS read that can take minutes on a large site — and asking
|
|
63
|
+
* "what may I do?" must not be made to wait on "what is in the draft?".
|
|
64
|
+
* It is also not blocked in demo mode, where /whoami is.
|
|
65
|
+
*/
|
|
66
|
+
try {
|
|
67
|
+
const status = await client.request("GET", "/status/planner", {
|
|
68
|
+
signal: AbortSignal.timeout(timeoutMs)
|
|
69
|
+
});
|
|
70
|
+
const caps = status?.capabilities;
|
|
71
|
+
if (!caps) {
|
|
72
|
+
// An orchestrator older than this field. Not an error, and not a "no".
|
|
73
|
+
return { ...PERMISSIVE, reason: "this orchestrator does not report capabilities" };
|
|
74
|
+
}
|
|
75
|
+
return {
|
|
76
|
+
createPages: caps.createPages !== false,
|
|
77
|
+
deletePages: caps.deletePages !== false,
|
|
78
|
+
structuralEdits: caps.structuralEdits !== false,
|
|
79
|
+
source: "orchestrator"
|
|
80
|
+
};
|
|
81
|
+
}
|
|
82
|
+
catch (err) {
|
|
83
|
+
return { ...PERMISSIVE, reason: err instanceof Error ? err.message : String(err) };
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
return {
|
|
87
|
+
snapshot: () => current,
|
|
88
|
+
refuse(key) {
|
|
89
|
+
if (current[key])
|
|
90
|
+
return null;
|
|
91
|
+
return (`This site cannot ${WHAT[key]}. Its content adapter has declared the capability ` +
|
|
92
|
+
`unavailable, so the change would apply to the draft and then fail to publish. ` +
|
|
93
|
+
`Call avocado-whoami to see what this site does support.`);
|
|
94
|
+
},
|
|
95
|
+
track(key, tool) {
|
|
96
|
+
tracked.push({ key, tool });
|
|
97
|
+
if (!current[key])
|
|
98
|
+
tool.disable();
|
|
99
|
+
},
|
|
100
|
+
async refresh() {
|
|
101
|
+
const now = Date.now();
|
|
102
|
+
if (inFlight)
|
|
103
|
+
return inFlight;
|
|
104
|
+
if (current.source === "orchestrator" && now - fetchedAt < ttlMs)
|
|
105
|
+
return current;
|
|
106
|
+
inFlight = probe()
|
|
107
|
+
.then((next) => {
|
|
108
|
+
fetchedAt = Date.now();
|
|
109
|
+
apply(next);
|
|
110
|
+
return next;
|
|
111
|
+
})
|
|
112
|
+
.finally(() => { inFlight = null; });
|
|
113
|
+
return inFlight;
|
|
114
|
+
}
|
|
115
|
+
};
|
|
116
|
+
}
|
package/dist/config.d.ts
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Install-time configuration bound via environment variables.
|
|
3
|
+
*
|
|
4
|
+
* Each MCP install is scoped to exactly one (session, siteId) pair. The client
|
|
5
|
+
* (Claude Desktop / Claude Code) passes these through when it spawns the stdio
|
|
6
|
+
* server, so tool calls don't need to accept session/siteId as arguments.
|
|
7
|
+
*/
|
|
8
|
+
export type McpConfig = {
|
|
9
|
+
orchestratorUrl: string;
|
|
10
|
+
session: string;
|
|
11
|
+
siteId: string;
|
|
12
|
+
/** Optional bearer token for /publish. Falls back to env DRAFT_MODE_SECRET if not set. */
|
|
13
|
+
publishToken?: string;
|
|
14
|
+
};
|
|
15
|
+
export declare function loadConfig(env?: NodeJS.ProcessEnv): McpConfig;
|
package/dist/config.js
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Install-time configuration bound via environment variables.
|
|
3
|
+
*
|
|
4
|
+
* Each MCP install is scoped to exactly one (session, siteId) pair. The client
|
|
5
|
+
* (Claude Desktop / Claude Code) passes these through when it spawns the stdio
|
|
6
|
+
* server, so tool calls don't need to accept session/siteId as arguments.
|
|
7
|
+
*/
|
|
8
|
+
export function loadConfig(env = process.env) {
|
|
9
|
+
const orchestratorUrl = (env.ORCHESTRATOR_URL ?? "http://localhost:4200").replace(/\/+$/, "");
|
|
10
|
+
const session = env.AVOCADO_SESSION?.trim() || "dev";
|
|
11
|
+
const siteId = env.AVOCADO_SITE_ID?.trim() || "";
|
|
12
|
+
if (!siteId) {
|
|
13
|
+
throw new Error("AVOCADO_SITE_ID is required. Set it to the site this MCP install should edit (e.g. 'avocado-stories').");
|
|
14
|
+
}
|
|
15
|
+
const publishToken = env.AVOCADO_PUBLISH_TOKEN?.trim() || undefined;
|
|
16
|
+
return { orchestratorUrl, session, siteId, publishToken };
|
|
17
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type { IncomingMessage } from "node:http";
|
|
2
|
+
export type AuthResult = {
|
|
3
|
+
ok: true;
|
|
4
|
+
} | {
|
|
5
|
+
ok: false;
|
|
6
|
+
status: 401 | 403;
|
|
7
|
+
message: string;
|
|
8
|
+
};
|
|
9
|
+
/**
|
|
10
|
+
* Validate a bearer token on an incoming HTTP request. Returns a result object
|
|
11
|
+
* instead of throwing so the caller can still reply with a clean JSON-RPC error.
|
|
12
|
+
* Uses a constant-time compare to resist timing attacks.
|
|
13
|
+
*/
|
|
14
|
+
export declare function checkBearer(req: IncomingMessage, expected: string): AuthResult;
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Validate a bearer token on an incoming HTTP request. Returns a result object
|
|
3
|
+
* instead of throwing so the caller can still reply with a clean JSON-RPC error.
|
|
4
|
+
* Uses a constant-time compare to resist timing attacks.
|
|
5
|
+
*/
|
|
6
|
+
export function checkBearer(req, expected) {
|
|
7
|
+
const header = req.headers.authorization;
|
|
8
|
+
if (!header || typeof header !== "string") {
|
|
9
|
+
return { ok: false, status: 401, message: "missing Authorization header" };
|
|
10
|
+
}
|
|
11
|
+
const match = /^Bearer\s+(.+)$/i.exec(header.trim());
|
|
12
|
+
if (!match) {
|
|
13
|
+
return { ok: false, status: 401, message: "Authorization header must be 'Bearer <token>'" };
|
|
14
|
+
}
|
|
15
|
+
const presented = match[1];
|
|
16
|
+
if (presented.length !== expected.length) {
|
|
17
|
+
return { ok: false, status: 403, message: "invalid token" };
|
|
18
|
+
}
|
|
19
|
+
let mismatch = 0;
|
|
20
|
+
for (let i = 0; i < presented.length; i++) {
|
|
21
|
+
mismatch |= presented.charCodeAt(i) ^ expected.charCodeAt(i);
|
|
22
|
+
}
|
|
23
|
+
if (mismatch !== 0)
|
|
24
|
+
return { ok: false, status: 403, message: "invalid token" };
|
|
25
|
+
return { ok: true };
|
|
26
|
+
}
|
package/dist/http.d.ts
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
/**
|
|
3
|
+
* Avocado Studio MCP server — streamable HTTP transport.
|
|
4
|
+
*
|
|
5
|
+
* Run this when you want the MCP server accessible as a URL (Claude Desktop's
|
|
6
|
+
* "Add custom connector" flow, remote deployments). The stdio entry at
|
|
7
|
+
* src/index.ts remains the right choice for local Claude Code installs.
|
|
8
|
+
*
|
|
9
|
+
* Env vars (in addition to the stdio ones):
|
|
10
|
+
* AVOCADO_MCP_BEARER_TOKEN required — clients must send Authorization: Bearer <token>
|
|
11
|
+
* AVOCADO_MCP_PORT optional — defaults to 4300
|
|
12
|
+
*/
|
|
13
|
+
export {};
|