pulsemcp-cms-admin-mcp-server 0.6.6 → 0.6.8
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 +37 -37
- package/build/shared/src/tools/create-unofficial-mirror.js +23 -16
- package/build/shared/src/tools/update-unofficial-mirror.js +28 -13
- package/build/shared/src/tools.js +13 -13
- package/package.json +1 -1
- package/shared/tools/create-unofficial-mirror.d.ts +2 -2
- package/shared/tools/create-unofficial-mirror.js +23 -16
- package/shared/tools/update-unofficial-mirror.d.ts +2 -2
- package/shared/tools/update-unofficial-mirror.js +28 -13
- package/shared/tools.d.ts +6 -6
- package/shared/tools.js +13 -13
package/README.md
CHANGED
|
@@ -48,11 +48,11 @@ This server is built and tested on macOS with Claude Desktop. It should work wit
|
|
|
48
48
|
| `update_newsletter_post` | newsletter | write | Update an existing newsletter post's content and metadata (except status). |
|
|
49
49
|
| `upload_image` | newsletter | write | Upload an image and attach it to a specific newsletter post. |
|
|
50
50
|
| `get_authors` | newsletter | read | Get a list of authors with optional search and pagination. |
|
|
51
|
-
| `search_mcp_implementations` |
|
|
52
|
-
| `get_draft_mcp_implementations` |
|
|
53
|
-
| `find_providers` |
|
|
54
|
-
| `save_mcp_implementation` |
|
|
55
|
-
| `send_impl_posted_notif` |
|
|
51
|
+
| `search_mcp_implementations` | server_directory | read | Search for MCP servers and clients in the PulseMCP registry. |
|
|
52
|
+
| `get_draft_mcp_implementations` | server_directory | read | Retrieve paginated list of draft MCP implementations needing review. |
|
|
53
|
+
| `find_providers` | server_directory | read | Search for providers by ID, name, URL, or slug. |
|
|
54
|
+
| `save_mcp_implementation` | server_directory | write | Update an MCP implementation (replicates Admin panel "Save Changes" button). |
|
|
55
|
+
| `send_impl_posted_notif` | server_directory | write | Send email notification when MCP implementation goes live. |
|
|
56
56
|
| `get_official_mirror_queue_items` | official_queue | read | List and filter official mirror queue entries with pagination and search. |
|
|
57
57
|
| `get_official_mirror_queue_item` | official_queue | read | Get detailed information about a single official mirror queue entry. |
|
|
58
58
|
| `approve_official_mirror_queue_item` | official_queue | write | Approve a queue entry and link it to an existing MCP server (async). |
|
|
@@ -92,33 +92,33 @@ This server organizes tools into groups that can be selectively enabled or disab
|
|
|
92
92
|
|
|
93
93
|
## Available Groups
|
|
94
94
|
|
|
95
|
-
| Group | Tools | Description
|
|
96
|
-
| ----------------------------- | ----- |
|
|
97
|
-
| `newsletter` | 6 | Full newsletter management (read + write)
|
|
98
|
-
| `newsletter_readonly` | 3 | Newsletter read-only (get posts, authors)
|
|
99
|
-
| `
|
|
100
|
-
| `
|
|
101
|
-
| `official_queue` | 7 | Full official mirror queue (read + write)
|
|
102
|
-
| `official_queue_readonly` | 2 | Official mirror queue read-only
|
|
103
|
-
| `unofficial_mirrors` | 5 | Full unofficial mirrors CRUD (read + write)
|
|
104
|
-
| `unofficial_mirrors_readonly` | 2 | Unofficial mirrors read-only
|
|
105
|
-
| `official_mirrors` | 2 | Official mirrors REST API (read-only)
|
|
106
|
-
| `official_mirrors_readonly` | 2 | Official mirrors read-only (alias)
|
|
107
|
-
| `tenants` | 2 | Tenants REST API (read-only)
|
|
108
|
-
| `tenants_readonly` | 2 | Tenants read-only (alias)
|
|
109
|
-
| `mcp_jsons` | 5 | Full MCP JSON configurations (read + write)
|
|
110
|
-
| `mcp_jsons_readonly` | 2 | MCP JSON configurations read-only
|
|
111
|
-
| `mcp_servers` | 3 | Full MCP servers management (read + write)
|
|
112
|
-
| `mcp_servers_readonly` | 2 | MCP servers read-only (list, get)
|
|
113
|
-
| `redirects` | 5 | Full URL redirect management (read + write)
|
|
114
|
-
| `redirects_readonly` | 2 | URL redirects read-only (list, get)
|
|
95
|
+
| Group | Tools | Description |
|
|
96
|
+
| ----------------------------- | ----- | ------------------------------------------- |
|
|
97
|
+
| `newsletter` | 6 | Full newsletter management (read + write) |
|
|
98
|
+
| `newsletter_readonly` | 3 | Newsletter read-only (get posts, authors) |
|
|
99
|
+
| `server_directory` | 5 | Full MCP server directory (read + write) |
|
|
100
|
+
| `server_directory_readonly` | 3 | MCP server directory read-only |
|
|
101
|
+
| `official_queue` | 7 | Full official mirror queue (read + write) |
|
|
102
|
+
| `official_queue_readonly` | 2 | Official mirror queue read-only |
|
|
103
|
+
| `unofficial_mirrors` | 5 | Full unofficial mirrors CRUD (read + write) |
|
|
104
|
+
| `unofficial_mirrors_readonly` | 2 | Unofficial mirrors read-only |
|
|
105
|
+
| `official_mirrors` | 2 | Official mirrors REST API (read-only) |
|
|
106
|
+
| `official_mirrors_readonly` | 2 | Official mirrors read-only (alias) |
|
|
107
|
+
| `tenants` | 2 | Tenants REST API (read-only) |
|
|
108
|
+
| `tenants_readonly` | 2 | Tenants read-only (alias) |
|
|
109
|
+
| `mcp_jsons` | 5 | Full MCP JSON configurations (read + write) |
|
|
110
|
+
| `mcp_jsons_readonly` | 2 | MCP JSON configurations read-only |
|
|
111
|
+
| `mcp_servers` | 3 | Full MCP servers management (read + write) |
|
|
112
|
+
| `mcp_servers_readonly` | 2 | MCP servers read-only (list, get) |
|
|
113
|
+
| `redirects` | 5 | Full URL redirect management (read + write) |
|
|
114
|
+
| `redirects_readonly` | 2 | URL redirects read-only (list, get) |
|
|
115
115
|
|
|
116
116
|
### Tools by Group
|
|
117
117
|
|
|
118
118
|
- **newsletter** / **newsletter_readonly**:
|
|
119
119
|
- Read-only: `get_newsletter_posts`, `get_newsletter_post`, `get_authors`
|
|
120
120
|
- Write: `draft_newsletter_post`, `update_newsletter_post`, `upload_image`
|
|
121
|
-
- **
|
|
121
|
+
- **server_directory** / **server_directory_readonly**:
|
|
122
122
|
- Read-only: `search_mcp_implementations`, `get_draft_mcp_implementations`, `find_providers`
|
|
123
123
|
- Write: `save_mcp_implementation`, `send_impl_posted_notif`
|
|
124
124
|
- **official_queue** / **official_queue_readonly**:
|
|
@@ -143,9 +143,9 @@ This server organizes tools into groups that can be selectively enabled or disab
|
|
|
143
143
|
|
|
144
144
|
## Environment Variables
|
|
145
145
|
|
|
146
|
-
| Variable | Description | Default
|
|
147
|
-
| ------------- | ------------------------------------------- |
|
|
148
|
-
| `TOOL_GROUPS` | Comma-separated list of enabled tool groups | `newsletter,
|
|
146
|
+
| Variable | Description | Default |
|
|
147
|
+
| ------------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
148
|
+
| `TOOL_GROUPS` | Comma-separated list of enabled tool groups | `newsletter,server_directory,official_queue,unofficial_mirrors,official_mirrors,tenants,mcp_jsons,mcp_servers,redirects` (all base groups) |
|
|
149
149
|
|
|
150
150
|
## Examples
|
|
151
151
|
|
|
@@ -161,23 +161,23 @@ Enable only newsletter tools:
|
|
|
161
161
|
TOOL_GROUPS=newsletter
|
|
162
162
|
```
|
|
163
163
|
|
|
164
|
-
Enable
|
|
164
|
+
Enable server_directory with read-only access:
|
|
165
165
|
|
|
166
166
|
```bash
|
|
167
|
-
TOOL_GROUPS=
|
|
167
|
+
TOOL_GROUPS=server_directory_readonly
|
|
168
168
|
```
|
|
169
169
|
|
|
170
170
|
Enable all groups with read-only access:
|
|
171
171
|
|
|
172
172
|
```bash
|
|
173
|
-
TOOL_GROUPS=newsletter_readonly,
|
|
173
|
+
TOOL_GROUPS=newsletter_readonly,server_directory_readonly,official_queue_readonly,unofficial_mirrors_readonly,official_mirrors_readonly,tenants_readonly,mcp_jsons_readonly,mcp_servers_readonly,redirects_readonly
|
|
174
174
|
```
|
|
175
175
|
|
|
176
176
|
Mix full and read-only access per group:
|
|
177
177
|
|
|
178
178
|
```bash
|
|
179
|
-
# Full newsletter access, read-only
|
|
180
|
-
TOOL_GROUPS=newsletter,
|
|
179
|
+
# Full newsletter access, read-only server_directory, no official_queue
|
|
180
|
+
TOOL_GROUPS=newsletter,server_directory_readonly
|
|
181
181
|
```
|
|
182
182
|
|
|
183
183
|
# Usage Tips
|
|
@@ -191,7 +191,7 @@ TOOL_GROUPS=newsletter,server_queue_readonly
|
|
|
191
191
|
- Use MCP server/client slugs for featured content (e.g., "github-mcp", "claude-desktop")
|
|
192
192
|
- Use `search_mcp_implementations` to discover MCP servers and clients in the PulseMCP registry
|
|
193
193
|
- Enable or disable specific tool groups by setting `TOOL_GROUPS` environment variable
|
|
194
|
-
- Use `_readonly` suffixes to restrict groups to read-only operations (e.g., `
|
|
194
|
+
- Use `_readonly` suffixes to restrict groups to read-only operations (e.g., `server_directory_readonly`)
|
|
195
195
|
- Use the `remote` array parameter in `save_mcp_implementation` to configure remote endpoints for MCP servers (transport, host_platform, authentication_method, etc.)
|
|
196
196
|
- Use the `canonical` array parameter in `save_mcp_implementation` to set canonical URLs with scope (domain, subdomain, subfolder, or url)
|
|
197
197
|
- Remote endpoints allow specifying how MCP servers can be accessed (direct URL, setup URL, authentication method, cost, etc.)
|
|
@@ -306,7 +306,7 @@ Add to your Claude Desktop configuration:
|
|
|
306
306
|
"args": ["/path/to/pulsemcp-cms-admin/local/build/index.js"],
|
|
307
307
|
"env": {
|
|
308
308
|
"PULSEMCP_ADMIN_API_KEY": "your-api-key-here",
|
|
309
|
-
"TOOL_GROUPS": "newsletter,
|
|
309
|
+
"TOOL_GROUPS": "newsletter,server_directory,official_queue,unofficial_mirrors,official_mirrors,tenants,mcp_jsons,mcp_servers,redirects"
|
|
310
310
|
}
|
|
311
311
|
}
|
|
312
312
|
}
|
|
@@ -323,7 +323,7 @@ For read-only access:
|
|
|
323
323
|
"args": ["/path/to/pulsemcp-cms-admin/local/build/index.js"],
|
|
324
324
|
"env": {
|
|
325
325
|
"PULSEMCP_ADMIN_API_KEY": "your-api-key-here",
|
|
326
|
-
"TOOL_GROUPS": "newsletter_readonly,
|
|
326
|
+
"TOOL_GROUPS": "newsletter_readonly,server_directory_readonly,official_queue_readonly,unofficial_mirrors_readonly,official_mirrors_readonly,tenants_readonly,mcp_jsons_readonly,mcp_servers_readonly,redirects_readonly"
|
|
327
327
|
}
|
|
328
328
|
}
|
|
329
329
|
}
|
|
@@ -2,7 +2,7 @@ import { z } from 'zod';
|
|
|
2
2
|
const PARAM_DESCRIPTIONS = {
|
|
3
3
|
name: 'The name of the unofficial mirror (e.g., "@modelcontextprotocol/server-filesystem")',
|
|
4
4
|
version: 'The version of the mirror (e.g., "1.0.0")',
|
|
5
|
-
|
|
5
|
+
server_json: 'The server.json content to store. This will be automatically wrapped in a { "server": ... } envelope as required by the PulseMCP Sub-Registry API.',
|
|
6
6
|
mcp_server_id: 'Optional ID of the MCP server to link this mirror to',
|
|
7
7
|
previous_name: 'Optional previous name if this mirror was renamed',
|
|
8
8
|
next_name: 'Optional next name if this mirror will be renamed',
|
|
@@ -10,7 +10,9 @@ const PARAM_DESCRIPTIONS = {
|
|
|
10
10
|
const CreateUnofficialMirrorSchema = z.object({
|
|
11
11
|
name: z.string().describe(PARAM_DESCRIPTIONS.name),
|
|
12
12
|
version: z.string().describe(PARAM_DESCRIPTIONS.version),
|
|
13
|
-
|
|
13
|
+
server_json: z
|
|
14
|
+
.union([z.record(z.unknown()), z.string()])
|
|
15
|
+
.describe(PARAM_DESCRIPTIONS.server_json),
|
|
14
16
|
mcp_server_id: z.number().optional().describe(PARAM_DESCRIPTIONS.mcp_server_id),
|
|
15
17
|
previous_name: z.string().optional().describe(PARAM_DESCRIPTIONS.previous_name),
|
|
16
18
|
next_name: z.string().optional().describe(PARAM_DESCRIPTIONS.next_name),
|
|
@@ -20,16 +22,18 @@ export function createUnofficialMirror(_server, clientFactory) {
|
|
|
20
22
|
name: 'create_unofficial_mirror',
|
|
21
23
|
description: `Create a new unofficial mirror entry. Unofficial mirrors represent community-submitted MCP server definitions.
|
|
22
24
|
|
|
25
|
+
The server_json parameter accepts server.json content directly and automatically wraps it in a { "server": ... } envelope as required by the PulseMCP Sub-Registry API.
|
|
26
|
+
|
|
23
27
|
Example request:
|
|
24
28
|
{
|
|
25
|
-
"name": "
|
|
26
|
-
"version": "
|
|
27
|
-
"
|
|
28
|
-
"
|
|
29
|
-
"
|
|
30
|
-
"
|
|
31
|
-
|
|
32
|
-
|
|
29
|
+
"name": "com.pulsemcp.mirror/example",
|
|
30
|
+
"version": "0.0.1",
|
|
31
|
+
"server_json": {
|
|
32
|
+
"$schema": "https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json",
|
|
33
|
+
"name": "com.pulsemcp.mirror/example",
|
|
34
|
+
"title": "Example Server",
|
|
35
|
+
"version": "0.0.1"
|
|
36
|
+
}
|
|
33
37
|
}
|
|
34
38
|
|
|
35
39
|
Use cases:
|
|
@@ -41,26 +45,29 @@ Use cases:
|
|
|
41
45
|
properties: {
|
|
42
46
|
name: { type: 'string', description: PARAM_DESCRIPTIONS.name },
|
|
43
47
|
version: { type: 'string', description: PARAM_DESCRIPTIONS.version },
|
|
44
|
-
|
|
48
|
+
server_json: {
|
|
45
49
|
oneOf: [{ type: 'object' }, { type: 'string' }],
|
|
46
|
-
description: PARAM_DESCRIPTIONS.
|
|
50
|
+
description: PARAM_DESCRIPTIONS.server_json,
|
|
47
51
|
},
|
|
48
52
|
mcp_server_id: { type: 'number', description: PARAM_DESCRIPTIONS.mcp_server_id },
|
|
49
53
|
previous_name: { type: 'string', description: PARAM_DESCRIPTIONS.previous_name },
|
|
50
54
|
next_name: { type: 'string', description: PARAM_DESCRIPTIONS.next_name },
|
|
51
55
|
},
|
|
52
|
-
required: ['name', 'version', '
|
|
56
|
+
required: ['name', 'version', 'server_json'],
|
|
53
57
|
},
|
|
54
58
|
handler: async (args) => {
|
|
55
59
|
const validatedArgs = CreateUnofficialMirrorSchema.parse(args);
|
|
56
60
|
const client = clientFactory();
|
|
57
61
|
try {
|
|
62
|
+
// Wrap server_json in { "server": ... } envelope
|
|
63
|
+
const serverContent = typeof validatedArgs.server_json === 'string'
|
|
64
|
+
? JSON.parse(validatedArgs.server_json)
|
|
65
|
+
: validatedArgs.server_json;
|
|
66
|
+
const jsonb_data = { server: serverContent };
|
|
58
67
|
const mirror = await client.createUnofficialMirror({
|
|
59
68
|
name: validatedArgs.name,
|
|
60
69
|
version: validatedArgs.version,
|
|
61
|
-
jsonb_data
|
|
62
|
-
? JSON.parse(validatedArgs.jsonb_data)
|
|
63
|
-
: validatedArgs.jsonb_data,
|
|
70
|
+
jsonb_data,
|
|
64
71
|
mcp_server_id: validatedArgs.mcp_server_id,
|
|
65
72
|
previous_name: validatedArgs.previous_name,
|
|
66
73
|
next_name: validatedArgs.next_name,
|
|
@@ -3,7 +3,7 @@ const PARAM_DESCRIPTIONS = {
|
|
|
3
3
|
id: 'The ID of the unofficial mirror to update',
|
|
4
4
|
name: 'Updated name of the unofficial mirror',
|
|
5
5
|
version: 'Updated version of the mirror',
|
|
6
|
-
|
|
6
|
+
server_json: 'Updated server.json content. This will be automatically wrapped in a { "server": ... } envelope as required by the PulseMCP Sub-Registry API.',
|
|
7
7
|
mcp_server_id: 'ID of the MCP server to link (set to null to unlink)',
|
|
8
8
|
previous_name: 'Updated previous name (set to null to clear)',
|
|
9
9
|
next_name: 'Updated next name (set to null to clear)',
|
|
@@ -12,10 +12,10 @@ const UpdateUnofficialMirrorSchema = z.object({
|
|
|
12
12
|
id: z.number().describe(PARAM_DESCRIPTIONS.id),
|
|
13
13
|
name: z.string().optional().describe(PARAM_DESCRIPTIONS.name),
|
|
14
14
|
version: z.string().optional().describe(PARAM_DESCRIPTIONS.version),
|
|
15
|
-
|
|
15
|
+
server_json: z
|
|
16
16
|
.union([z.record(z.unknown()), z.string()])
|
|
17
17
|
.optional()
|
|
18
|
-
.describe(PARAM_DESCRIPTIONS.
|
|
18
|
+
.describe(PARAM_DESCRIPTIONS.server_json),
|
|
19
19
|
mcp_server_id: z.number().nullable().optional().describe(PARAM_DESCRIPTIONS.mcp_server_id),
|
|
20
20
|
previous_name: z.string().nullable().optional().describe(PARAM_DESCRIPTIONS.previous_name),
|
|
21
21
|
next_name: z.string().nullable().optional().describe(PARAM_DESCRIPTIONS.next_name),
|
|
@@ -25,7 +25,20 @@ export function updateUnofficialMirror(_server, clientFactory) {
|
|
|
25
25
|
name: 'update_unofficial_mirror',
|
|
26
26
|
description: `Update an existing unofficial mirror by its ID. Only provided fields will be updated.
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
The server_json parameter accepts server.json content directly and automatically wraps it in a { "server": ... } envelope as required by the PulseMCP Sub-Registry API.
|
|
29
|
+
|
|
30
|
+
Example request updating server_json:
|
|
31
|
+
{
|
|
32
|
+
"id": 123,
|
|
33
|
+
"server_json": {
|
|
34
|
+
"$schema": "https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json",
|
|
35
|
+
"name": "com.pulsemcp.mirror/example",
|
|
36
|
+
"title": "Example Server",
|
|
37
|
+
"version": "0.0.2"
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
Example request updating other fields:
|
|
29
42
|
{
|
|
30
43
|
"id": 123,
|
|
31
44
|
"version": "1.1.0",
|
|
@@ -35,7 +48,7 @@ Example request:
|
|
|
35
48
|
Use cases:
|
|
36
49
|
- Link an unofficial mirror to an MCP server
|
|
37
50
|
- Update the version or name of a mirror
|
|
38
|
-
-
|
|
51
|
+
- Update the server.json configuration data
|
|
39
52
|
- Unlink a mirror from an MCP server (set mcp_server_id to null)`,
|
|
40
53
|
inputSchema: {
|
|
41
54
|
type: 'object',
|
|
@@ -43,9 +56,9 @@ Use cases:
|
|
|
43
56
|
id: { type: 'number', description: PARAM_DESCRIPTIONS.id },
|
|
44
57
|
name: { type: 'string', description: PARAM_DESCRIPTIONS.name },
|
|
45
58
|
version: { type: 'string', description: PARAM_DESCRIPTIONS.version },
|
|
46
|
-
|
|
59
|
+
server_json: {
|
|
47
60
|
oneOf: [{ type: 'object' }, { type: 'string' }],
|
|
48
|
-
description: PARAM_DESCRIPTIONS.
|
|
61
|
+
description: PARAM_DESCRIPTIONS.server_json,
|
|
49
62
|
},
|
|
50
63
|
mcp_server_id: { type: ['number', 'null'], description: PARAM_DESCRIPTIONS.mcp_server_id },
|
|
51
64
|
previous_name: { type: ['string', 'null'], description: PARAM_DESCRIPTIONS.previous_name },
|
|
@@ -57,14 +70,16 @@ Use cases:
|
|
|
57
70
|
const validatedArgs = UpdateUnofficialMirrorSchema.parse(args);
|
|
58
71
|
const client = clientFactory();
|
|
59
72
|
try {
|
|
60
|
-
const { id,
|
|
73
|
+
const { id, server_json, ...rest } = validatedArgs;
|
|
74
|
+
// If server_json provided, wrap it in { "server": ... } envelope
|
|
75
|
+
let jsonb_data;
|
|
76
|
+
if (server_json !== undefined) {
|
|
77
|
+
const serverContent = typeof server_json === 'string' ? JSON.parse(server_json) : server_json;
|
|
78
|
+
jsonb_data = { server: serverContent };
|
|
79
|
+
}
|
|
61
80
|
const params = {
|
|
62
81
|
...rest,
|
|
63
|
-
...(jsonb_data !== undefined
|
|
64
|
-
? {
|
|
65
|
-
jsonb_data: typeof jsonb_data === 'string' ? JSON.parse(jsonb_data) : jsonb_data,
|
|
66
|
-
}
|
|
67
|
-
: {}),
|
|
82
|
+
...(jsonb_data !== undefined ? { jsonb_data } : {}),
|
|
68
83
|
};
|
|
69
84
|
if (Object.keys(params).length === 0) {
|
|
70
85
|
return {
|
|
@@ -53,16 +53,16 @@ const ALL_TOOLS = [
|
|
|
53
53
|
{ factory: updateNewsletterPost, group: 'newsletter', isWriteOperation: true },
|
|
54
54
|
{ factory: uploadImage, group: 'newsletter', isWriteOperation: true },
|
|
55
55
|
{ factory: getAuthors, group: 'newsletter', isWriteOperation: false },
|
|
56
|
-
// Server
|
|
57
|
-
{ factory: searchMCPImplementations, group: '
|
|
58
|
-
{ factory: getDraftMCPImplementations, group: '
|
|
59
|
-
{ factory: saveMCPImplementation, group: '
|
|
56
|
+
// Server directory tools
|
|
57
|
+
{ factory: searchMCPImplementations, group: 'server_directory', isWriteOperation: false },
|
|
58
|
+
{ factory: getDraftMCPImplementations, group: 'server_directory', isWriteOperation: false },
|
|
59
|
+
{ factory: saveMCPImplementation, group: 'server_directory', isWriteOperation: true },
|
|
60
60
|
{
|
|
61
61
|
factory: sendMCPImplementationPostingNotification,
|
|
62
|
-
group: '
|
|
62
|
+
group: 'server_directory',
|
|
63
63
|
isWriteOperation: true,
|
|
64
64
|
},
|
|
65
|
-
{ factory: findProviders, group: '
|
|
65
|
+
{ factory: findProviders, group: 'server_directory', isWriteOperation: false },
|
|
66
66
|
// Official mirror queue tools
|
|
67
67
|
{ factory: getOfficialMirrorQueueItems, group: 'official_queue', isWriteOperation: false },
|
|
68
68
|
{ factory: getOfficialMirrorQueueItem, group: 'official_queue', isWriteOperation: false },
|
|
@@ -110,8 +110,8 @@ const ALL_TOOLS = [
|
|
|
110
110
|
const VALID_TOOL_GROUPS = [
|
|
111
111
|
'newsletter',
|
|
112
112
|
'newsletter_readonly',
|
|
113
|
-
'
|
|
114
|
-
'
|
|
113
|
+
'server_directory',
|
|
114
|
+
'server_directory_readonly',
|
|
115
115
|
'official_queue',
|
|
116
116
|
'official_queue_readonly',
|
|
117
117
|
'unofficial_mirrors',
|
|
@@ -132,7 +132,7 @@ const VALID_TOOL_GROUPS = [
|
|
|
132
132
|
*/
|
|
133
133
|
const BASE_TOOL_GROUPS = [
|
|
134
134
|
'newsletter',
|
|
135
|
-
'
|
|
135
|
+
'server_directory',
|
|
136
136
|
'official_queue',
|
|
137
137
|
'unofficial_mirrors',
|
|
138
138
|
'official_mirrors',
|
|
@@ -143,7 +143,7 @@ const BASE_TOOL_GROUPS = [
|
|
|
143
143
|
];
|
|
144
144
|
/**
|
|
145
145
|
* Parse enabled tool groups from environment variable or parameter
|
|
146
|
-
* @param enabledGroupsParam - Comma-separated list of tool groups (e.g., "newsletter,
|
|
146
|
+
* @param enabledGroupsParam - Comma-separated list of tool groups (e.g., "newsletter,server_directory_readonly")
|
|
147
147
|
* @returns Array of enabled tool groups
|
|
148
148
|
*/
|
|
149
149
|
export function parseEnabledToolGroups(enabledGroupsParam) {
|
|
@@ -192,14 +192,14 @@ function shouldIncludeTool(toolDef, enabledGroups) {
|
|
|
192
192
|
* a factory pattern that accepts the server and clientFactory as parameters.
|
|
193
193
|
*
|
|
194
194
|
* Tool groups can be enabled/disabled via the TOOL_GROUPS environment variable
|
|
195
|
-
* (comma-separated list, e.g., "newsletter,
|
|
195
|
+
* (comma-separated list, e.g., "newsletter,server_directory_readonly"). If not set, all
|
|
196
196
|
* base tool groups are enabled by default (full read+write access).
|
|
197
197
|
*
|
|
198
198
|
* Available tool groups:
|
|
199
199
|
* - newsletter: All newsletter-related tools (read + write)
|
|
200
200
|
* - newsletter_readonly: Newsletter tools (read only)
|
|
201
|
-
* -
|
|
202
|
-
* -
|
|
201
|
+
* - server_directory: MCP server directory tools (read + write)
|
|
202
|
+
* - server_directory_readonly: MCP server directory tools (read only)
|
|
203
203
|
* - official_queue: Official mirror queue tools (read + write)
|
|
204
204
|
* - official_queue_readonly: Official mirror queue tools (read only)
|
|
205
205
|
* - unofficial_mirrors: Unofficial mirror CRUD tools (read + write)
|
package/package.json
CHANGED
|
@@ -14,11 +14,11 @@ export declare function createUnofficialMirror(_server: Server, clientFactory: C
|
|
|
14
14
|
type: string;
|
|
15
15
|
description: "The version of the mirror (e.g., \"1.0.0\")";
|
|
16
16
|
};
|
|
17
|
-
|
|
17
|
+
server_json: {
|
|
18
18
|
oneOf: {
|
|
19
19
|
type: string;
|
|
20
20
|
}[];
|
|
21
|
-
description: "The
|
|
21
|
+
description: "The server.json content to store. This will be automatically wrapped in a { \"server\": ... } envelope as required by the PulseMCP Sub-Registry API.";
|
|
22
22
|
};
|
|
23
23
|
mcp_server_id: {
|
|
24
24
|
type: string;
|
|
@@ -2,7 +2,7 @@ import { z } from 'zod';
|
|
|
2
2
|
const PARAM_DESCRIPTIONS = {
|
|
3
3
|
name: 'The name of the unofficial mirror (e.g., "@modelcontextprotocol/server-filesystem")',
|
|
4
4
|
version: 'The version of the mirror (e.g., "1.0.0")',
|
|
5
|
-
|
|
5
|
+
server_json: 'The server.json content to store. This will be automatically wrapped in a { "server": ... } envelope as required by the PulseMCP Sub-Registry API.',
|
|
6
6
|
mcp_server_id: 'Optional ID of the MCP server to link this mirror to',
|
|
7
7
|
previous_name: 'Optional previous name if this mirror was renamed',
|
|
8
8
|
next_name: 'Optional next name if this mirror will be renamed',
|
|
@@ -10,7 +10,9 @@ const PARAM_DESCRIPTIONS = {
|
|
|
10
10
|
const CreateUnofficialMirrorSchema = z.object({
|
|
11
11
|
name: z.string().describe(PARAM_DESCRIPTIONS.name),
|
|
12
12
|
version: z.string().describe(PARAM_DESCRIPTIONS.version),
|
|
13
|
-
|
|
13
|
+
server_json: z
|
|
14
|
+
.union([z.record(z.unknown()), z.string()])
|
|
15
|
+
.describe(PARAM_DESCRIPTIONS.server_json),
|
|
14
16
|
mcp_server_id: z.number().optional().describe(PARAM_DESCRIPTIONS.mcp_server_id),
|
|
15
17
|
previous_name: z.string().optional().describe(PARAM_DESCRIPTIONS.previous_name),
|
|
16
18
|
next_name: z.string().optional().describe(PARAM_DESCRIPTIONS.next_name),
|
|
@@ -20,16 +22,18 @@ export function createUnofficialMirror(_server, clientFactory) {
|
|
|
20
22
|
name: 'create_unofficial_mirror',
|
|
21
23
|
description: `Create a new unofficial mirror entry. Unofficial mirrors represent community-submitted MCP server definitions.
|
|
22
24
|
|
|
25
|
+
The server_json parameter accepts server.json content directly and automatically wraps it in a { "server": ... } envelope as required by the PulseMCP Sub-Registry API.
|
|
26
|
+
|
|
23
27
|
Example request:
|
|
24
28
|
{
|
|
25
|
-
"name": "
|
|
26
|
-
"version": "
|
|
27
|
-
"
|
|
28
|
-
"
|
|
29
|
-
"
|
|
30
|
-
"
|
|
31
|
-
|
|
32
|
-
|
|
29
|
+
"name": "com.pulsemcp.mirror/example",
|
|
30
|
+
"version": "0.0.1",
|
|
31
|
+
"server_json": {
|
|
32
|
+
"$schema": "https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json",
|
|
33
|
+
"name": "com.pulsemcp.mirror/example",
|
|
34
|
+
"title": "Example Server",
|
|
35
|
+
"version": "0.0.1"
|
|
36
|
+
}
|
|
33
37
|
}
|
|
34
38
|
|
|
35
39
|
Use cases:
|
|
@@ -41,26 +45,29 @@ Use cases:
|
|
|
41
45
|
properties: {
|
|
42
46
|
name: { type: 'string', description: PARAM_DESCRIPTIONS.name },
|
|
43
47
|
version: { type: 'string', description: PARAM_DESCRIPTIONS.version },
|
|
44
|
-
|
|
48
|
+
server_json: {
|
|
45
49
|
oneOf: [{ type: 'object' }, { type: 'string' }],
|
|
46
|
-
description: PARAM_DESCRIPTIONS.
|
|
50
|
+
description: PARAM_DESCRIPTIONS.server_json,
|
|
47
51
|
},
|
|
48
52
|
mcp_server_id: { type: 'number', description: PARAM_DESCRIPTIONS.mcp_server_id },
|
|
49
53
|
previous_name: { type: 'string', description: PARAM_DESCRIPTIONS.previous_name },
|
|
50
54
|
next_name: { type: 'string', description: PARAM_DESCRIPTIONS.next_name },
|
|
51
55
|
},
|
|
52
|
-
required: ['name', 'version', '
|
|
56
|
+
required: ['name', 'version', 'server_json'],
|
|
53
57
|
},
|
|
54
58
|
handler: async (args) => {
|
|
55
59
|
const validatedArgs = CreateUnofficialMirrorSchema.parse(args);
|
|
56
60
|
const client = clientFactory();
|
|
57
61
|
try {
|
|
62
|
+
// Wrap server_json in { "server": ... } envelope
|
|
63
|
+
const serverContent = typeof validatedArgs.server_json === 'string'
|
|
64
|
+
? JSON.parse(validatedArgs.server_json)
|
|
65
|
+
: validatedArgs.server_json;
|
|
66
|
+
const jsonb_data = { server: serverContent };
|
|
58
67
|
const mirror = await client.createUnofficialMirror({
|
|
59
68
|
name: validatedArgs.name,
|
|
60
69
|
version: validatedArgs.version,
|
|
61
|
-
jsonb_data
|
|
62
|
-
? JSON.parse(validatedArgs.jsonb_data)
|
|
63
|
-
: validatedArgs.jsonb_data,
|
|
70
|
+
jsonb_data,
|
|
64
71
|
mcp_server_id: validatedArgs.mcp_server_id,
|
|
65
72
|
previous_name: validatedArgs.previous_name,
|
|
66
73
|
next_name: validatedArgs.next_name,
|
|
@@ -18,11 +18,11 @@ export declare function updateUnofficialMirror(_server: Server, clientFactory: C
|
|
|
18
18
|
type: string;
|
|
19
19
|
description: "Updated version of the mirror";
|
|
20
20
|
};
|
|
21
|
-
|
|
21
|
+
server_json: {
|
|
22
22
|
oneOf: {
|
|
23
23
|
type: string;
|
|
24
24
|
}[];
|
|
25
|
-
description: "Updated
|
|
25
|
+
description: "Updated server.json content. This will be automatically wrapped in a { \"server\": ... } envelope as required by the PulseMCP Sub-Registry API.";
|
|
26
26
|
};
|
|
27
27
|
mcp_server_id: {
|
|
28
28
|
type: string[];
|
|
@@ -3,7 +3,7 @@ const PARAM_DESCRIPTIONS = {
|
|
|
3
3
|
id: 'The ID of the unofficial mirror to update',
|
|
4
4
|
name: 'Updated name of the unofficial mirror',
|
|
5
5
|
version: 'Updated version of the mirror',
|
|
6
|
-
|
|
6
|
+
server_json: 'Updated server.json content. This will be automatically wrapped in a { "server": ... } envelope as required by the PulseMCP Sub-Registry API.',
|
|
7
7
|
mcp_server_id: 'ID of the MCP server to link (set to null to unlink)',
|
|
8
8
|
previous_name: 'Updated previous name (set to null to clear)',
|
|
9
9
|
next_name: 'Updated next name (set to null to clear)',
|
|
@@ -12,10 +12,10 @@ const UpdateUnofficialMirrorSchema = z.object({
|
|
|
12
12
|
id: z.number().describe(PARAM_DESCRIPTIONS.id),
|
|
13
13
|
name: z.string().optional().describe(PARAM_DESCRIPTIONS.name),
|
|
14
14
|
version: z.string().optional().describe(PARAM_DESCRIPTIONS.version),
|
|
15
|
-
|
|
15
|
+
server_json: z
|
|
16
16
|
.union([z.record(z.unknown()), z.string()])
|
|
17
17
|
.optional()
|
|
18
|
-
.describe(PARAM_DESCRIPTIONS.
|
|
18
|
+
.describe(PARAM_DESCRIPTIONS.server_json),
|
|
19
19
|
mcp_server_id: z.number().nullable().optional().describe(PARAM_DESCRIPTIONS.mcp_server_id),
|
|
20
20
|
previous_name: z.string().nullable().optional().describe(PARAM_DESCRIPTIONS.previous_name),
|
|
21
21
|
next_name: z.string().nullable().optional().describe(PARAM_DESCRIPTIONS.next_name),
|
|
@@ -25,7 +25,20 @@ export function updateUnofficialMirror(_server, clientFactory) {
|
|
|
25
25
|
name: 'update_unofficial_mirror',
|
|
26
26
|
description: `Update an existing unofficial mirror by its ID. Only provided fields will be updated.
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
The server_json parameter accepts server.json content directly and automatically wraps it in a { "server": ... } envelope as required by the PulseMCP Sub-Registry API.
|
|
29
|
+
|
|
30
|
+
Example request updating server_json:
|
|
31
|
+
{
|
|
32
|
+
"id": 123,
|
|
33
|
+
"server_json": {
|
|
34
|
+
"$schema": "https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json",
|
|
35
|
+
"name": "com.pulsemcp.mirror/example",
|
|
36
|
+
"title": "Example Server",
|
|
37
|
+
"version": "0.0.2"
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
Example request updating other fields:
|
|
29
42
|
{
|
|
30
43
|
"id": 123,
|
|
31
44
|
"version": "1.1.0",
|
|
@@ -35,7 +48,7 @@ Example request:
|
|
|
35
48
|
Use cases:
|
|
36
49
|
- Link an unofficial mirror to an MCP server
|
|
37
50
|
- Update the version or name of a mirror
|
|
38
|
-
-
|
|
51
|
+
- Update the server.json configuration data
|
|
39
52
|
- Unlink a mirror from an MCP server (set mcp_server_id to null)`,
|
|
40
53
|
inputSchema: {
|
|
41
54
|
type: 'object',
|
|
@@ -43,9 +56,9 @@ Use cases:
|
|
|
43
56
|
id: { type: 'number', description: PARAM_DESCRIPTIONS.id },
|
|
44
57
|
name: { type: 'string', description: PARAM_DESCRIPTIONS.name },
|
|
45
58
|
version: { type: 'string', description: PARAM_DESCRIPTIONS.version },
|
|
46
|
-
|
|
59
|
+
server_json: {
|
|
47
60
|
oneOf: [{ type: 'object' }, { type: 'string' }],
|
|
48
|
-
description: PARAM_DESCRIPTIONS.
|
|
61
|
+
description: PARAM_DESCRIPTIONS.server_json,
|
|
49
62
|
},
|
|
50
63
|
mcp_server_id: { type: ['number', 'null'], description: PARAM_DESCRIPTIONS.mcp_server_id },
|
|
51
64
|
previous_name: { type: ['string', 'null'], description: PARAM_DESCRIPTIONS.previous_name },
|
|
@@ -57,14 +70,16 @@ Use cases:
|
|
|
57
70
|
const validatedArgs = UpdateUnofficialMirrorSchema.parse(args);
|
|
58
71
|
const client = clientFactory();
|
|
59
72
|
try {
|
|
60
|
-
const { id,
|
|
73
|
+
const { id, server_json, ...rest } = validatedArgs;
|
|
74
|
+
// If server_json provided, wrap it in { "server": ... } envelope
|
|
75
|
+
let jsonb_data;
|
|
76
|
+
if (server_json !== undefined) {
|
|
77
|
+
const serverContent = typeof server_json === 'string' ? JSON.parse(server_json) : server_json;
|
|
78
|
+
jsonb_data = { server: serverContent };
|
|
79
|
+
}
|
|
61
80
|
const params = {
|
|
62
81
|
...rest,
|
|
63
|
-
...(jsonb_data !== undefined
|
|
64
|
-
? {
|
|
65
|
-
jsonb_data: typeof jsonb_data === 'string' ? JSON.parse(jsonb_data) : jsonb_data,
|
|
66
|
-
}
|
|
67
|
-
: {}),
|
|
82
|
+
...(jsonb_data !== undefined ? { jsonb_data } : {}),
|
|
68
83
|
};
|
|
69
84
|
if (Object.keys(params).length === 0) {
|
|
70
85
|
return {
|
package/shared/tools.d.ts
CHANGED
|
@@ -9,7 +9,7 @@ import { ClientFactory } from './server.js';
|
|
|
9
9
|
*
|
|
10
10
|
* Groups:
|
|
11
11
|
* - newsletter / newsletter_readonly: Newsletter-related tools (posts, authors, images)
|
|
12
|
-
* -
|
|
12
|
+
* - server_directory / server_directory_readonly: Server directory tools (search, drafts, providers, save, notifications)
|
|
13
13
|
* - official_queue / official_queue_readonly: Official mirror queue tools (list, get, approve, reject, unlink)
|
|
14
14
|
* - unofficial_mirrors / unofficial_mirrors_readonly: Unofficial mirror CRUD tools
|
|
15
15
|
* - official_mirrors_readonly: Official mirrors read-only tools (REST API)
|
|
@@ -18,10 +18,10 @@ import { ClientFactory } from './server.js';
|
|
|
18
18
|
* - mcp_servers / mcp_servers_readonly: Unified MCP server tools (abstracted interface)
|
|
19
19
|
* - redirects / redirects_readonly: URL redirect management tools
|
|
20
20
|
*/
|
|
21
|
-
export type ToolGroup = 'newsletter' | 'newsletter_readonly' | '
|
|
21
|
+
export type ToolGroup = 'newsletter' | 'newsletter_readonly' | 'server_directory' | 'server_directory_readonly' | 'official_queue' | 'official_queue_readonly' | 'unofficial_mirrors' | 'unofficial_mirrors_readonly' | 'official_mirrors' | 'official_mirrors_readonly' | 'tenants' | 'tenants_readonly' | 'mcp_jsons' | 'mcp_jsons_readonly' | 'mcp_servers' | 'mcp_servers_readonly' | 'redirects' | 'redirects_readonly';
|
|
22
22
|
/**
|
|
23
23
|
* Parse enabled tool groups from environment variable or parameter
|
|
24
|
-
* @param enabledGroupsParam - Comma-separated list of tool groups (e.g., "newsletter,
|
|
24
|
+
* @param enabledGroupsParam - Comma-separated list of tool groups (e.g., "newsletter,server_directory_readonly")
|
|
25
25
|
* @returns Array of enabled tool groups
|
|
26
26
|
*/
|
|
27
27
|
export declare function parseEnabledToolGroups(enabledGroupsParam?: string): ToolGroup[];
|
|
@@ -33,14 +33,14 @@ export declare function parseEnabledToolGroups(enabledGroupsParam?: string): Too
|
|
|
33
33
|
* a factory pattern that accepts the server and clientFactory as parameters.
|
|
34
34
|
*
|
|
35
35
|
* Tool groups can be enabled/disabled via the TOOL_GROUPS environment variable
|
|
36
|
-
* (comma-separated list, e.g., "newsletter,
|
|
36
|
+
* (comma-separated list, e.g., "newsletter,server_directory_readonly"). If not set, all
|
|
37
37
|
* base tool groups are enabled by default (full read+write access).
|
|
38
38
|
*
|
|
39
39
|
* Available tool groups:
|
|
40
40
|
* - newsletter: All newsletter-related tools (read + write)
|
|
41
41
|
* - newsletter_readonly: Newsletter tools (read only)
|
|
42
|
-
* -
|
|
43
|
-
* -
|
|
42
|
+
* - server_directory: MCP server directory tools (read + write)
|
|
43
|
+
* - server_directory_readonly: MCP server directory tools (read only)
|
|
44
44
|
* - official_queue: Official mirror queue tools (read + write)
|
|
45
45
|
* - official_queue_readonly: Official mirror queue tools (read only)
|
|
46
46
|
* - unofficial_mirrors: Unofficial mirror CRUD tools (read + write)
|
package/shared/tools.js
CHANGED
|
@@ -53,16 +53,16 @@ const ALL_TOOLS = [
|
|
|
53
53
|
{ factory: updateNewsletterPost, group: 'newsletter', isWriteOperation: true },
|
|
54
54
|
{ factory: uploadImage, group: 'newsletter', isWriteOperation: true },
|
|
55
55
|
{ factory: getAuthors, group: 'newsletter', isWriteOperation: false },
|
|
56
|
-
// Server
|
|
57
|
-
{ factory: searchMCPImplementations, group: '
|
|
58
|
-
{ factory: getDraftMCPImplementations, group: '
|
|
59
|
-
{ factory: saveMCPImplementation, group: '
|
|
56
|
+
// Server directory tools
|
|
57
|
+
{ factory: searchMCPImplementations, group: 'server_directory', isWriteOperation: false },
|
|
58
|
+
{ factory: getDraftMCPImplementations, group: 'server_directory', isWriteOperation: false },
|
|
59
|
+
{ factory: saveMCPImplementation, group: 'server_directory', isWriteOperation: true },
|
|
60
60
|
{
|
|
61
61
|
factory: sendMCPImplementationPostingNotification,
|
|
62
|
-
group: '
|
|
62
|
+
group: 'server_directory',
|
|
63
63
|
isWriteOperation: true,
|
|
64
64
|
},
|
|
65
|
-
{ factory: findProviders, group: '
|
|
65
|
+
{ factory: findProviders, group: 'server_directory', isWriteOperation: false },
|
|
66
66
|
// Official mirror queue tools
|
|
67
67
|
{ factory: getOfficialMirrorQueueItems, group: 'official_queue', isWriteOperation: false },
|
|
68
68
|
{ factory: getOfficialMirrorQueueItem, group: 'official_queue', isWriteOperation: false },
|
|
@@ -110,8 +110,8 @@ const ALL_TOOLS = [
|
|
|
110
110
|
const VALID_TOOL_GROUPS = [
|
|
111
111
|
'newsletter',
|
|
112
112
|
'newsletter_readonly',
|
|
113
|
-
'
|
|
114
|
-
'
|
|
113
|
+
'server_directory',
|
|
114
|
+
'server_directory_readonly',
|
|
115
115
|
'official_queue',
|
|
116
116
|
'official_queue_readonly',
|
|
117
117
|
'unofficial_mirrors',
|
|
@@ -132,7 +132,7 @@ const VALID_TOOL_GROUPS = [
|
|
|
132
132
|
*/
|
|
133
133
|
const BASE_TOOL_GROUPS = [
|
|
134
134
|
'newsletter',
|
|
135
|
-
'
|
|
135
|
+
'server_directory',
|
|
136
136
|
'official_queue',
|
|
137
137
|
'unofficial_mirrors',
|
|
138
138
|
'official_mirrors',
|
|
@@ -143,7 +143,7 @@ const BASE_TOOL_GROUPS = [
|
|
|
143
143
|
];
|
|
144
144
|
/**
|
|
145
145
|
* Parse enabled tool groups from environment variable or parameter
|
|
146
|
-
* @param enabledGroupsParam - Comma-separated list of tool groups (e.g., "newsletter,
|
|
146
|
+
* @param enabledGroupsParam - Comma-separated list of tool groups (e.g., "newsletter,server_directory_readonly")
|
|
147
147
|
* @returns Array of enabled tool groups
|
|
148
148
|
*/
|
|
149
149
|
export function parseEnabledToolGroups(enabledGroupsParam) {
|
|
@@ -192,14 +192,14 @@ function shouldIncludeTool(toolDef, enabledGroups) {
|
|
|
192
192
|
* a factory pattern that accepts the server and clientFactory as parameters.
|
|
193
193
|
*
|
|
194
194
|
* Tool groups can be enabled/disabled via the TOOL_GROUPS environment variable
|
|
195
|
-
* (comma-separated list, e.g., "newsletter,
|
|
195
|
+
* (comma-separated list, e.g., "newsletter,server_directory_readonly"). If not set, all
|
|
196
196
|
* base tool groups are enabled by default (full read+write access).
|
|
197
197
|
*
|
|
198
198
|
* Available tool groups:
|
|
199
199
|
* - newsletter: All newsletter-related tools (read + write)
|
|
200
200
|
* - newsletter_readonly: Newsletter tools (read only)
|
|
201
|
-
* -
|
|
202
|
-
* -
|
|
201
|
+
* - server_directory: MCP server directory tools (read + write)
|
|
202
|
+
* - server_directory_readonly: MCP server directory tools (read only)
|
|
203
203
|
* - official_queue: Official mirror queue tools (read + write)
|
|
204
204
|
* - official_queue_readonly: Official mirror queue tools (read only)
|
|
205
205
|
* - unofficial_mirrors: Unofficial mirror CRUD tools (read + write)
|