@pairsystems/goodmem-mcp 0.1.21 → 0.1.23
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 +202 -0
- package/README.md +36 -53
- package/dist/index.js +25 -25
- package/package.json +17 -2
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -2,55 +2,33 @@
|
|
|
2
2
|
|
|
3
3
|
[GoodMem](https://goodmem.ai/) MCP server — gives AI agents direct access to GoodMem memory infrastructure via the [Model Context Protocol](https://modelcontextprotocol.io).
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Store and retrieve memories, configure embedding and inference models, and manage GoodMem resources and access policies. The [tool reference](#available-tools) lists the complete API surface.
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
- A running [GoodMem](https://github.com/PAIR-Systems-Inc/goodmem) server
|
|
10
|
-
- Node.js 18+
|
|
11
|
-
|
|
12
|
-
## Configuration
|
|
13
|
-
|
|
14
|
-
### What you need to configure
|
|
15
|
-
|
|
16
|
-
**GoodMem credentials** (required):
|
|
17
|
-
|
|
18
|
-
- `GOODMEM_BASE_URL` — GoodMem server URL (e.g., `https://your-server.example.com`)
|
|
19
|
-
- `GOODMEM_API_KEY` — GoodMem API key (starts with `gm_`)
|
|
20
|
-
|
|
21
|
-
**TLS / self-signed certificates** (optional):
|
|
22
|
-
|
|
23
|
-
This is an advanced topic. If you do not even know what that is, skip this section.
|
|
24
|
-
|
|
25
|
-
If the GoodMem server uses self-signed CA certificates, set one and only one of the following:
|
|
26
|
-
|
|
27
|
-
- `NODE_EXTRA_CA_CERTS=/path/to/rootCA.pem` — adds the CA to the trusted store. More secure, but requires you to copy the certificate file from the GoodMem server to the machine where the MCP server is running.
|
|
28
|
-
- `NODE_TLS_REJECT_UNAUTHORIZED=0` — disables certificate verification entirely. Easy and hassle-free, but not recommended for production.
|
|
29
|
-
|
|
30
|
-
### How to configure
|
|
7
|
+
This package runs locally over stdio. For a remote connection focused on retrieval, see GoodMem's separate [hosted MCP endpoint](https://docs.goodmem.ai/docs/reference/mcp).
|
|
31
8
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
Just tell the MCP server your server details — it will call `goodmem_configure` automatically:
|
|
9
|
+
## Prerequisites
|
|
35
10
|
|
|
36
|
-
|
|
11
|
+
- A running [GoodMem](https://docs.goodmem.ai/) server, its URL, and a GoodMem API key
|
|
12
|
+
- Node.js 20 or newer with npm. Use a [currently supported LTS release](https://nodejs.org/en/download).
|
|
37
13
|
|
|
38
|
-
|
|
14
|
+
## Connect Claude Code
|
|
39
15
|
|
|
40
|
-
|
|
16
|
+
Set `GOODMEM_API_KEY` in your environment, then replace the server URL and run:
|
|
41
17
|
|
|
42
18
|
```bash
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
19
|
+
claude mcp add goodmem \
|
|
20
|
+
--env GOODMEM_BASE_URL="https://your-server.example.com" \
|
|
21
|
+
--env GOODMEM_API_KEY="$GOODMEM_API_KEY" \
|
|
22
|
+
-- npx -y @pairsystems/goodmem-mcp
|
|
47
23
|
```
|
|
48
24
|
|
|
49
|
-
|
|
25
|
+
This saves the connection for the current project in your private `~/.claude.json`. Open Claude Code and run `/mcp` to check the connection. Add `--scope user` before `--` to make it available across projects. Reading the key from the environment keeps its value out of the command saved in shell history.
|
|
50
26
|
|
|
51
|
-
|
|
27
|
+
## Connect other MCP clients
|
|
52
28
|
|
|
53
|
-
|
|
29
|
+
For clients that use an `mcpServers` configuration, add:
|
|
30
|
+
|
|
31
|
+
```json
|
|
54
32
|
{
|
|
55
33
|
"mcpServers": {
|
|
56
34
|
"goodmem": {
|
|
@@ -58,9 +36,7 @@ Add an `env` block in your MCP client's JSON configuration:
|
|
|
58
36
|
"args": ["-y", "@pairsystems/goodmem-mcp"],
|
|
59
37
|
"env": {
|
|
60
38
|
"GOODMEM_BASE_URL": "https://your-server.example.com",
|
|
61
|
-
"GOODMEM_API_KEY": "gm_..."
|
|
62
|
-
"NODE_EXTRA_CA_CERTS": "/path/to/rootCA.pem", // only if needed for self-signed certs
|
|
63
|
-
"NODE_TLS_REJECT_UNAUTHORIZED": "0" // only if you want to skip cert verification
|
|
39
|
+
"GOODMEM_API_KEY": "gm_..."
|
|
64
40
|
}
|
|
65
41
|
}
|
|
66
42
|
}
|
|
@@ -70,28 +46,26 @@ Add an `env` block in your MCP client's JSON configuration:
|
|
|
70
46
|
The JSON file location depends on your MCP client:
|
|
71
47
|
|
|
72
48
|
- **Claude Desktop**: `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows)
|
|
73
|
-
- **Claude Code**: `.
|
|
49
|
+
- **Claude Code**: `.mcp.json` at the project root for shared configuration; use the CLI above for private configuration. See [Claude Code's MCP documentation](https://code.claude.com/docs/en/mcp#scope-hierarchy-and-precedence).
|
|
74
50
|
- **VS Code / Cursor**: see your client's MCP server configuration docs
|
|
75
51
|
|
|
76
|
-
|
|
52
|
+
## Run from a terminal
|
|
77
53
|
|
|
78
|
-
|
|
54
|
+
With `GOODMEM_API_KEY` already set in your environment:
|
|
79
55
|
|
|
80
56
|
```bash
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
env GOODMEM_API_KEY=gm_... \
|
|
84
|
-
env NODE_EXTRA_CA_CERTS=/path/to/rootCA.pem
|
|
57
|
+
export GOODMEM_BASE_URL="https://your-server.example.com"
|
|
58
|
+
npx -y @pairsystems/goodmem-mcp
|
|
85
59
|
```
|
|
86
60
|
|
|
87
|
-
|
|
61
|
+
The process communicates over stdio and waits for an MCP client. You can also install the command globally:
|
|
88
62
|
|
|
89
63
|
```bash
|
|
90
64
|
npm install -g @pairsystems/goodmem-mcp
|
|
91
65
|
goodmem-mcp
|
|
92
66
|
```
|
|
93
67
|
|
|
94
|
-
##
|
|
68
|
+
## First requests
|
|
95
69
|
|
|
96
70
|
Once connected, ask your AI assistant to:
|
|
97
71
|
|
|
@@ -104,13 +78,17 @@ Search my Research space for "memory infrastructure"
|
|
|
104
78
|
|
|
105
79
|
The MCP server auto-infers provider, endpoint, dimensions, and other fields from the model name — you only need `display_name`, `model_identifier`, and credentials for the embedding provider.
|
|
106
80
|
|
|
81
|
+
## Custom certificates
|
|
82
|
+
|
|
83
|
+
If your server uses a private or self-signed CA, add `NODE_EXTRA_CA_CERTS` to the MCP server's environment, with the absolute path to its PEM certificate file. For Claude Code, add another `--env NODE_EXTRA_CA_CERTS="/path/to/rootCA.pem"` before `--`; in JSON, add it to the `env` object. Restart the MCP connection after changing this setting. An expired or invalid server certificate must be fixed on the server.
|
|
84
|
+
|
|
107
85
|
## Available tools
|
|
108
86
|
|
|
109
87
|
### Utility tools (hand-coded, not derived from the IR)
|
|
110
88
|
|
|
111
89
|
| Tool | Description |
|
|
112
90
|
|------|-------------|
|
|
113
|
-
| `goodmem_configure` | Set `base_url` / `api_key`
|
|
91
|
+
| `goodmem_configure` | Set `base_url` / `api_key` for the current session; overrides env vars. Use after launching `npx -y @pairsystems/goodmem-mcp` if env isn't configured. |
|
|
114
92
|
| `goodmem_lookup_model` | Inspect the built-in model registry. Shows what fields auto-infer for a given `model_identifier`. |
|
|
115
93
|
| `goodmem_client_info` | Report MCP client package version and the goodmem server commit it was built against. No server connection required. |
|
|
116
94
|
|
|
@@ -274,6 +252,7 @@ Memory spaces are containers that associate a set of memories with an embedder.
|
|
|
274
252
|
| `goodmem_user_enrollments_complete` | Complete human-user enrollment |
|
|
275
253
|
|
|
276
254
|
<!-- AUTO-GENERATED MCP TOOL TABLE END -->
|
|
255
|
+
|
|
277
256
|
## Binary content delivery
|
|
278
257
|
|
|
279
258
|
Two memory tools return raw binary payloads:
|
|
@@ -315,7 +294,7 @@ variables. If you need to tune them per deployment, edit
|
|
|
315
294
|
|
|
316
295
|
## Auto-inference
|
|
317
296
|
|
|
318
|
-
When creating embedders, LLMs, or rerankers, provide `model_identifier` and the MCP server fills in `provider_type`, `endpoint_url`, dimensions, and other fields automatically from the built-in registry
|
|
297
|
+
When creating embedders, LLMs, or rerankers, provide `model_identifier` and the MCP server fills in `provider_type`, `endpoint_url`, dimensions, and other fields automatically from the built-in model registry. Inference happens client-side in the MCP layer before the request is sent.
|
|
319
298
|
|
|
320
299
|
**Example**: calling `goodmem_embedders_create` with `model_identifier: "text-embedding-3-large"` auto-fills:
|
|
321
300
|
- `provider_type` → `"OPENAI"`
|
|
@@ -334,6 +313,10 @@ For self-hosted or local providers (vLLM, TEI, Ollama, custom endpoints), creden
|
|
|
334
313
|
## Links
|
|
335
314
|
|
|
336
315
|
- [GoodMem Documentation](https://docs.goodmem.ai)
|
|
337
|
-
- [GoodMem
|
|
316
|
+
- [GoodMem Community and Support](https://community.goodmem.ai/)
|
|
338
317
|
- [Python SDK on PyPI](https://pypi.org/project/goodmem/)
|
|
339
318
|
- [Claude Code Plugin](https://github.com/PAIR-Systems-Inc/goodmem-claude-code-plugin)
|
|
319
|
+
|
|
320
|
+
## License
|
|
321
|
+
|
|
322
|
+
Licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt). A copy is included in the package.
|
package/dist/index.js
CHANGED
|
@@ -21115,7 +21115,7 @@ function _concatBytes(a, b) {
|
|
|
21115
21115
|
out.set(b, a.length);
|
|
21116
21116
|
return out;
|
|
21117
21117
|
}
|
|
21118
|
-
var BASED_ON_GOODMEM_COMMIT = "
|
|
21118
|
+
var BASED_ON_GOODMEM_COMMIT = "40b4c0450c624f85ba5769dcb0902c4831017e1e";
|
|
21119
21119
|
function isConfigured() {
|
|
21120
21120
|
return goodmemBaseUrl !== "";
|
|
21121
21121
|
}
|
|
@@ -22358,7 +22358,7 @@ function autoInferFromRegistry(registryType, args) {
|
|
|
22358
22358
|
}
|
|
22359
22359
|
var server = new McpServer({
|
|
22360
22360
|
name: "goodmem",
|
|
22361
|
-
version: "0.1.
|
|
22361
|
+
version: "0.1.23"
|
|
22362
22362
|
});
|
|
22363
22363
|
server.tool("goodmem_configure", "Configure GoodMem server connection. Call this before using other GoodMem tools if GOODMEM_BASE_URL and GOODMEM_API_KEY environment variables are not set. Session credentials override environment variables. For bootstrap workflows that need to call /v1/system/info or /v1/system/init before keys exist, api_key may be omitted; most other tools will return AuthenticationException until a real key is provided.", {
|
|
22364
22364
|
base_url: external_exports.string().describe("GoodMem server URL (e.g., https://your-server.example.com)"),
|
|
@@ -22396,7 +22396,7 @@ server.tool("goodmem_configure", "Configure GoodMem server connection. Call this
|
|
|
22396
22396
|
const msg = err instanceof Error ? err.message : String(err);
|
|
22397
22397
|
let hint = "Check your base_url.";
|
|
22398
22398
|
if (msg.includes("CERT") || msg.includes("certificate") || msg.includes("self-signed") || msg.includes("self signed") || msg.includes("UNABLE_TO_VERIFY")) {
|
|
22399
|
-
hint = "TLS certificate error.
|
|
22399
|
+
hint = "TLS certificate error. For a private or self-signed CA, set NODE_EXTRA_CA_CERTS=/path/to/rootCA.pem in your MCP server env config and restart the connection. If the server certificate is expired or invalid, fix it on the server.";
|
|
22400
22400
|
}
|
|
22401
22401
|
return { isError: true, content: [{ type: "text", text: `Could not connect to ${args.base_url}: ${msg}. Credentials were NOT saved. ${hint}` }] };
|
|
22402
22402
|
}
|
|
@@ -22444,7 +22444,7 @@ ${allModels.join("\n")}` }] };
|
|
|
22444
22444
|
});
|
|
22445
22445
|
server.tool("goodmem_client_info", "Return the MCP client package version and the goodmem server commit it was built against. No server connection required.", {}, { readOnlyHint: true, destructiveHint: false, openWorldHint: false }, async () => {
|
|
22446
22446
|
return { content: [{ type: "text", text: JSON.stringify({
|
|
22447
|
-
mcp_version: "0.1.
|
|
22447
|
+
mcp_version: "0.1.23",
|
|
22448
22448
|
based_on_goodmem_commit: BASED_ON_GOODMEM_COMMIT
|
|
22449
22449
|
}, null, 2) }] };
|
|
22450
22450
|
});
|
|
@@ -22695,7 +22695,7 @@ function registerTools() {
|
|
|
22695
22695
|
const result = await callApi("GET", `/v1/admin/retrieve-memory-log-policies/${encodeURIComponent(String(args.id))}`, void 0, query);
|
|
22696
22696
|
return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
|
|
22697
22697
|
});
|
|
22698
|
-
server.tool("goodmem_admin_retrieve_memory_log_policies_list", "List RetrieveMemory log policies\n\nLists RetrieveMemory log policies with optional tombstone, active-time, name, label, sort, and pagination filters
|
|
22698
|
+
server.tool("goodmem_admin_retrieve_memory_log_policies_list", "List RetrieveMemory log policies\n\nLists RetrieveMemory log policies with optional tombstone, active-time, name, label, sort, and pagination filters.\n\nLABEL FILTERS: Label filters accept either label.<key>=<value> or label[key]=value (for example, label.environment=production or label[environment]=production).", {
|
|
22699
22699
|
include_deleted: external_exports.boolean().describe("Whether to include tombstoned policies. Also accepts include_deleted.").optional(),
|
|
22700
22700
|
name_filter: external_exports.string().describe("Case-insensitive substring filter on policy display names. Also accepts name_filter.").optional(),
|
|
22701
22701
|
active_at: external_exports.number().int().describe("Only return policies active at this millisecond epoch timestamp. Also accepts active_at.").optional(),
|
|
@@ -22736,7 +22736,7 @@ function registerTools() {
|
|
|
22736
22736
|
const result = await callApi("POST", `/v1/admin:transferInstanceOwnership`, body);
|
|
22737
22737
|
return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
|
|
22738
22738
|
});
|
|
22739
|
-
server.tool("goodmem_apikeys_create", "Create a new API key\n\nIssues a new API key and returns its raw value exactly once. Omitted subject and authority_mode create a self-issued human key that inherits the subject's live authority. A SCOPED key requires a nonempty immutable ceiling, and every ceiling rule must be conservatively covered by both the subject's live authority and the issuing credential's effective authority. A scoped issuer can create only scoped children. SERVICE subjects require SCOPED mode and MANAGE_ACCESS on the service identity
|
|
22739
|
+
server.tool("goodmem_apikeys_create", "Create a new API key\n\nIssues a new API key and returns its raw value exactly once. Omitted subject and authority_mode create a self-issued human key that inherits the subject's live authority. A SCOPED key requires a nonempty immutable ceiling, and every ceiling rule must be conservatively covered by both the subject's live authority and the issuing credential's effective authority. A scoped issuer can create only scoped children. SERVICE subjects require SCOPED mode and MANAGE_ACCESS on the service identity.\n\nAUTHORIZATION: Requires CREATE_API_KEY on the proposed credential; subject and ceiling checks are repeated by the final insertion statement.", {
|
|
22740
22740
|
labels: external_exports.record(external_exports.string(), external_exports.string()).describe("Key-value pairs of metadata associated with the API key. Used for organization and filtering. At most 20 entries; keys and values contain at most 255 characters; keys use [a-z0-9._-].").optional(),
|
|
22741
22741
|
expires_at: external_exports.number().int().describe("Exclusive expiration timestamp in milliseconds since epoch. It must be later than valid_from, which defaults to issuance time; if omitted, the key does not expire.").optional(),
|
|
22742
22742
|
api_key_id: external_exports.string().describe("Optional client-provided UUID for idempotent creation. If not provided, server generates a new UUID. Returns ALREADY_EXISTS if ID is already in use.").optional(),
|
|
@@ -22917,7 +22917,7 @@ function registerTools() {
|
|
|
22917
22917
|
const result = await callApi("POST", `/v1/embedders`, body);
|
|
22918
22918
|
return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
|
|
22919
22919
|
});
|
|
22920
|
-
server.tool("goodmem_embedders_delete", "Delete an embedder\n\nPermanently deletes an embedder configuration. This operation cannot be undone and removes the embedder record and securely deletes stored credentials
|
|
22920
|
+
server.tool("goodmem_embedders_delete", "Delete an embedder\n\nPermanently deletes an embedder configuration. This operation cannot be undone and removes the embedder record and securely deletes stored credentials.\n\nIMPORTANT: This does NOT invalidate or delete embeddings previously created with this embedder - existing embeddings remain accessible.\n\nCONFLICT: Returns HTTP 409 Conflict if the embedder is still referenced by a space. Requires DELETE_EMBEDDER on the requested embedder.", {
|
|
22921
22921
|
id: external_exports.string().describe("The unique identifier of the embedder to delete")
|
|
22922
22922
|
}, { readOnlyHint: false, destructiveHint: true, idempotentHint: true, openWorldHint: false }, async (args) => {
|
|
22923
22923
|
if (typeof args.id !== "string" || args.id === "") {
|
|
@@ -22939,7 +22939,7 @@ function registerTools() {
|
|
|
22939
22939
|
const result = await callApi("GET", `/v1/embedders/${encodeURIComponent(String(args.id))}`, void 0, query);
|
|
22940
22940
|
return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
|
|
22941
22941
|
});
|
|
22942
|
-
server.tool("goodmem_embedders_list", "List embedders\n\nRetrieves a list of embedder configurations accessible to the caller, with optional filtering
|
|
22942
|
+
server.tool("goodmem_embedders_list", "List embedders\n\nRetrieves a list of embedder configurations accessible to the caller, with optional filtering.\n\nLABEL FILTERS: Label filters accept either label.<key>=<value> or label[key]=value (for example, label.environment=production or label[environment]=production).\n\nAUTHORIZATION: Requires LIST_EMBEDDER on the GoodMem instance. Each returned embedder must also be visible through READ_EMBEDDER; unauthorized embedders are filtered in PostgreSQL. The owner_id parameter filters that already-authorized result set and does not grant additional visibility. This is a read-only operation with no side effects.", {
|
|
22943
22943
|
owner_id: external_exports.string().describe("Filter the already-authorized result set by owner principal UUID. Omitting this parameter does not bypass per-embedder READ_EMBEDDER filtering.").optional(),
|
|
22944
22944
|
provider_type: external_exports.enum(["OPENAI", "VLLM", "TEI", "LLAMA_CPP", "VOYAGE", "COHERE", "JINA", "DASHSCOPE", "GEMINI"]).describe("Filter embedders by provider type. Allowed values match the ProviderType schema.").optional(),
|
|
22945
22945
|
label: external_exports.record(external_exports.string(), external_exports.string()).describe("Filter by label. Each key-value pair is sent as label[key]=value query parameter.").optional()
|
|
@@ -23039,7 +23039,7 @@ function registerTools() {
|
|
|
23039
23039
|
const result = await callApi("GET", `/v1/instance`, void 0);
|
|
23040
23040
|
return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
|
|
23041
23041
|
});
|
|
23042
|
-
server.tool("goodmem_llms_create", "Create a new LLM\n\nCreates a new LLM configuration for text generation services. LLMs represent connections to different language model API services (like OpenAI, vLLM, etc.) and include all the necessary configuration to use them for text generation
|
|
23042
|
+
server.tool("goodmem_llms_create", "Create a new LLM\n\nCreates a new LLM configuration for text generation services. LLMs represent connections to different language model API services (like OpenAI, vLLM, etc.) and include all the necessary configuration to use them for text generation.\n\nDUPLICATE DETECTION: Returns HTTP 409 Conflict (ALREADY_EXISTS) if another LLM exists with the same effective provider connection and model configuration for this owner after endpoint canonicalization and provider-default resolution. Equivalent credentials participate in the comparison. The api_path field defaults to '/chat/completions' if omitted.\n\nOWNER DEFAULTS: Owner defaults to the authenticated principal unless owner_id is provided; CREATE_LLM is evaluated against the proposed LLM and owner.", {
|
|
23043
23043
|
display_name: external_exports.string().describe("User-facing name of the LLM"),
|
|
23044
23044
|
description: external_exports.string().describe("Description of the LLM").optional(),
|
|
23045
23045
|
provider_type: external_exports.enum(["OPENAI", "LITELLM_PROXY", "OPEN_ROUTER", "DASHSCOPE", "VLLM", "OLLAMA", "LLAMA_CPP", "CUSTOM_OPENAI_COMPATIBLE"]).describe("Type of LLM provider (auto-inferred from model_identifier if omitted)").optional(),
|
|
@@ -23132,7 +23132,7 @@ function registerTools() {
|
|
|
23132
23132
|
const result = await callApi("POST", `/v1/llms`, body);
|
|
23133
23133
|
return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
|
|
23134
23134
|
});
|
|
23135
|
-
server.tool("goodmem_llms_delete", "Delete an LLM\n\nPermanently deletes an LLM configuration. This operation cannot be undone and removes the LLM record and securely deletes stored credentials
|
|
23135
|
+
server.tool("goodmem_llms_delete", "Delete an LLM\n\nPermanently deletes an LLM configuration. This operation cannot be undone and removes the LLM record and securely deletes stored credentials.\n\nIMPORTANT: This does NOT invalidate or delete any previously generated content using this LLM - existing generations remain accessible. Requires DELETE_LLM on the requested LLM.", {
|
|
23136
23136
|
id: external_exports.string().describe("The unique identifier of the LLM to delete")
|
|
23137
23137
|
}, { readOnlyHint: false, destructiveHint: true, idempotentHint: true, openWorldHint: false }, async (args) => {
|
|
23138
23138
|
if (typeof args.id !== "string" || args.id === "") {
|
|
@@ -23154,7 +23154,7 @@ function registerTools() {
|
|
|
23154
23154
|
const result = await callApi("GET", `/v1/llms/${encodeURIComponent(String(args.id))}`, void 0, query);
|
|
23155
23155
|
return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
|
|
23156
23156
|
});
|
|
23157
|
-
server.tool("goodmem_llms_list", "List LLMs\n\nRetrieves a list of LLM configurations accessible to the caller, with optional filtering
|
|
23157
|
+
server.tool("goodmem_llms_list", "List LLMs\n\nRetrieves a list of LLM configurations accessible to the caller, with optional filtering.\n\nLABEL FILTERS: Label filters accept either label.<key>=<value> or label[key]=value (for example, label.environment=production or label[environment]=production).\n\nAUTHORIZATION: Requires LIST_LLM on the GoodMem instance. Each returned LLM must also be visible through READ_LLM; unauthorized LLMs are filtered in PostgreSQL. The owner_id parameter filters that already-authorized result set and does not grant additional visibility. This is a read-only operation with no side effects.", {
|
|
23158
23158
|
owner_id: external_exports.string().describe("Filter the already-authorized result set by owner principal UUID. Omitting this parameter does not bypass per-LLM READ_LLM filtering.").optional(),
|
|
23159
23159
|
provider_type: external_exports.enum(["OPENAI", "LITELLM_PROXY", "OPEN_ROUTER", "DASHSCOPE", "VLLM", "OLLAMA", "LLAMA_CPP", "CUSTOM_OPENAI_COMPATIBLE"]).describe("Filter LLMs by provider type. Allowed values match the LLMProviderType schema.").optional(),
|
|
23160
23160
|
label: external_exports.record(external_exports.string(), external_exports.string()).describe("Filter by label. Each key-value pair is sent as label[key]=value query parameter.").optional()
|
|
@@ -23171,7 +23171,7 @@ function registerTools() {
|
|
|
23171
23171
|
const result = await callApi("GET", `/v1/llms`, void 0, query);
|
|
23172
23172
|
return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
|
|
23173
23173
|
});
|
|
23174
|
-
server.tool("goodmem_llms_update", "Update an LLM\n\nUpdates an existing LLM configuration including display information, endpoint configuration, model parameters, credentials, and labels. All fields are optional - only specified fields will be updated
|
|
23174
|
+
server.tool("goodmem_llms_update", "Update an LLM\n\nUpdates an existing LLM configuration including display information, endpoint configuration, model parameters, credentials, and labels. All fields are optional - only specified fields will be updated.\n\nSUPPORTED_MODALITIES UPDATE: If the array contains >=1 elements, it replaces the stored set; if empty or omitted, no change occurs and it does not count as an update by itself.\n\nIMPORTANT: providerType is IMMUTABLE after creation and cannot be changed. Requires UPDATE_LLM on the requested LLM.", {
|
|
23175
23175
|
id: external_exports.string().describe("The unique identifier of the LLM to update"),
|
|
23176
23176
|
display_name: external_exports.string().describe("Update display name").optional(),
|
|
23177
23177
|
description: external_exports.string().describe("Update description").optional(),
|
|
@@ -23429,7 +23429,7 @@ function registerTools() {
|
|
|
23429
23429
|
const result = await callApi("POST", `/v1/memories`, body);
|
|
23430
23430
|
return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
|
|
23431
23431
|
});
|
|
23432
|
-
server.tool("goodmem_memories_delete", "Delete a memory\n\nPermanently deletes a memory and its associated chunks. This operation cannot be undone and immediately removes the memory record from the database
|
|
23432
|
+
server.tool("goodmem_memories_delete", "Delete a memory\n\nPermanently deletes a memory and its associated chunks. This operation cannot be undone and immediately removes the memory record from the database.\n\nIDEMPOTENCY: This operation is safe to retry - may return NOT_FOUND if the memory was already deleted or never existed.\n\nAUTHORIZATION: Requires DELETE_MEMORY on the requested memory; authority may be granted through DIRECT_MEMBERS_OF its containing space. Side effects include permanent removal of the memory record and all associated chunk data.", {
|
|
23433
23433
|
id: external_exports.string().describe("The UUID of the memory to delete")
|
|
23434
23434
|
}, { readOnlyHint: false, destructiveHint: true, idempotentHint: true, openWorldHint: false }, async (args) => {
|
|
23435
23435
|
if (typeof args.id !== "string" || args.id === "") {
|
|
@@ -23438,7 +23438,7 @@ function registerTools() {
|
|
|
23438
23438
|
await callApi("DELETE", `/v1/memories/${encodeURIComponent(String(args.id))}`, void 0);
|
|
23439
23439
|
return { content: [{ type: "text", text: "Deleted successfully." }] };
|
|
23440
23440
|
});
|
|
23441
|
-
server.tool("goodmem_memories_get", "Get a memory by ID\n\nRetrieves a single memory by its ID
|
|
23441
|
+
server.tool("goodmem_memories_get", "Get a memory by ID\n\nRetrieves a single memory by its ID.\n\nAUTHORIZATION: Requires READ_MEMORY on the requested memory; authority may be granted directly or through DIRECT_MEMBERS_OF its containing space. This is a read-only operation with no side effects and is safe to retry. Returns NOT_FOUND if the memory or its parent space does not exist.", {
|
|
23442
23442
|
id: external_exports.string().describe("The UUID of the memory to retrieve"),
|
|
23443
23443
|
include_content: external_exports.boolean().describe("Whether to include the original content in the response (defaults to false).").optional(),
|
|
23444
23444
|
include_processing_history: external_exports.boolean().describe("Whether to include background job processing history in the response (defaults to false).").optional()
|
|
@@ -23703,7 +23703,7 @@ function registerTools() {
|
|
|
23703
23703
|
const result = await callApiNdjson("POST", `/v1/ping:stream`, body, void 0, args.timeout_sec ?? Math.ceil(((args.count || 100) * (args.interval_ms || 1e3) + (args.timeout_ms || 5e3) + 6e4) / 1e3));
|
|
23704
23704
|
return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
|
|
23705
23705
|
});
|
|
23706
|
-
server.tool("goodmem_rerankers_create", "Create a new reranker\n\nCreates a new reranker configuration for ranking search results. Rerankers represent connections to different reranking API services (like TEI, OpenAI, etc.) and include all the necessary configuration to use them for result ranking
|
|
23706
|
+
server.tool("goodmem_rerankers_create", "Create a new reranker\n\nCreates a new reranker configuration for ranking search results. Rerankers represent connections to different reranking API services (like TEI, OpenAI, etc.) and include all the necessary configuration to use them for result ranking.\n\nDUPLICATE DETECTION: Returns HTTP 409 Conflict (ALREADY_EXISTS) if another reranker exists with the same effective provider connection and model configuration for this owner after endpoint canonicalization and provider-default resolution. Equivalent credentials participate in the comparison.\n\nDEFAULTS: api_path defaults to '/v2/rerank' for Cohere and '/rerank' for other providers if omitted; supported_modalities defaults to [TEXT] if omitted.\n\nOWNER DEFAULTS: Owner defaults to the authenticated principal unless owner_id is provided; CREATE_RERANKER is evaluated against the proposed reranker and owner. This operation is NOT idempotent - each request creates a new reranker record.", {
|
|
23707
23707
|
display_name: external_exports.string().describe("User-facing name of the reranker"),
|
|
23708
23708
|
description: external_exports.string().describe("Description of the reranker").optional(),
|
|
23709
23709
|
provider_type: external_exports.enum(["VLLM", "TEI", "LLAMA_CPP", "VOYAGE", "COHERE", "JINA", "DASHSCOPE"]).describe("Type of reranking provider (auto-inferred from model_identifier if omitted)").optional(),
|
|
@@ -23769,7 +23769,7 @@ function registerTools() {
|
|
|
23769
23769
|
const result = await callApi("POST", `/v1/rerankers`, body);
|
|
23770
23770
|
return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
|
|
23771
23771
|
});
|
|
23772
|
-
server.tool("goodmem_rerankers_delete", "Delete a reranker\n\nPermanently deletes a reranker configuration. This operation cannot be undone and immediately removes the reranker record from the database
|
|
23772
|
+
server.tool("goodmem_rerankers_delete", "Delete a reranker\n\nPermanently deletes a reranker configuration. This operation cannot be undone and immediately removes the reranker record from the database.\n\nSIDE EFFECTS: Invalidates any cached references to this reranker; does not affect historical usage data or audit logs. Requires DELETE_RERANKER on the requested reranker. This operation is safe to retry - may return NOT_FOUND if already deleted.", {
|
|
23773
23773
|
id: external_exports.string().describe("The unique identifier of the reranker to delete")
|
|
23774
23774
|
}, { readOnlyHint: false, destructiveHint: true, idempotentHint: true, openWorldHint: false }, async (args) => {
|
|
23775
23775
|
if (typeof args.id !== "string" || args.id === "") {
|
|
@@ -23791,7 +23791,7 @@ function registerTools() {
|
|
|
23791
23791
|
const result = await callApi("GET", `/v1/rerankers/${encodeURIComponent(String(args.id))}`, void 0, query);
|
|
23792
23792
|
return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
|
|
23793
23793
|
});
|
|
23794
|
-
server.tool("goodmem_rerankers_list", "List rerankers\n\nRetrieves a list of reranker configurations accessible to the caller, with optional filtering
|
|
23794
|
+
server.tool("goodmem_rerankers_list", "List rerankers\n\nRetrieves a list of reranker configurations accessible to the caller, with optional filtering.\n\nIMPORTANT: Pagination is NOT supported - all matching results are returned. Results are ordered by created_at descending. Stored credentials are never included in list responses.\n\nLABEL FILTERS: Label filters accept either label.<key>=<value> or label[key]=value (for example, label.environment=production or label[environment]=production).\n\nAUTHORIZATION: Requires LIST_RERANKER on the GoodMem instance. Each returned reranker must also be visible through READ_RERANKER; unauthorized rerankers are filtered in PostgreSQL. The owner_id parameter filters that already-authorized result set and does not grant additional visibility.", {
|
|
23795
23795
|
owner_id: external_exports.string().describe("Filter the already-authorized result set by owner principal UUID. Omitting this parameter does not bypass per-reranker READ_RERANKER filtering.").optional(),
|
|
23796
23796
|
provider_type: external_exports.enum(["OPENAI", "VLLM", "TEI", "LLAMA_CPP", "VOYAGE", "COHERE", "JINA", "DASHSCOPE", "GEMINI"]).describe("Filter rerankers by provider type. Allowed values match the ProviderType schema.").optional(),
|
|
23797
23797
|
label: external_exports.record(external_exports.string(), external_exports.string()).describe("Filter by label. Each key-value pair is sent as label[key]=value query parameter.").optional()
|
|
@@ -23808,7 +23808,7 @@ function registerTools() {
|
|
|
23808
23808
|
const result = await callApi("GET", `/v1/rerankers`, void 0, query);
|
|
23809
23809
|
return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
|
|
23810
23810
|
});
|
|
23811
|
-
server.tool("goodmem_rerankers_update", "Update a reranker\n\nUpdates an existing reranker configuration including display information, endpoint configuration, model parameters, credentials, and labels. All fields are optional - only specified fields will be updated
|
|
23811
|
+
server.tool("goodmem_rerankers_update", "Update a reranker\n\nUpdates an existing reranker configuration including display information, endpoint configuration, model parameters, credentials, and labels. All fields are optional - only specified fields will be updated.\n\nIMMUTABLE FIELDS: providerType and ownerId cannot be changed after creation.\n\nSUPPORTED_MODALITIES UPDATE: If the array contains >=1 elements, it replaces the stored set; if empty or omitted, no change occurs and it does not count as an update by itself. Returns ALREADY_EXISTS if update would create an equivalent reranker configuration for this owner after endpoint canonicalization and provider-default resolution (HTTP 409 Conflict / ALREADY_EXISTS). Requires UPDATE_RERANKER on the requested reranker. This operation is idempotent.", {
|
|
23812
23812
|
id: external_exports.string().describe("The unique identifier of the reranker to update"),
|
|
23813
23813
|
display_name: external_exports.string().describe("User-facing name of the reranker").optional(),
|
|
23814
23814
|
description: external_exports.string().describe("Description of the reranker").optional(),
|
|
@@ -23914,7 +23914,7 @@ function registerTools() {
|
|
|
23914
23914
|
const result = await callApi("GET", `/v1/service-identities/${encodeURIComponent(String(args.id))}`, void 0, query);
|
|
23915
23915
|
return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
|
|
23916
23916
|
});
|
|
23917
|
-
server.tool("goodmem_service_identities_list", "List service identities\n\nRequires LIST_SERVICE_IDENTITY on the GoodMem instance and READ_SERVICE_IDENTITY on each returned row. Owner and label filters, lifecycle filtering, authorization, and keyset pagination execute in PostgreSQL
|
|
23917
|
+
server.tool("goodmem_service_identities_list", "List service identities\n\nRequires LIST_SERVICE_IDENTITY on the GoodMem instance and READ_SERVICE_IDENTITY on each returned row. Owner and label filters, lifecycle filtering, authorization, and keyset pagination execute in PostgreSQL.\n\nLABEL FILTERS: Label filters accept either label.<key>=<value> or label[key]=value (for example, label.environment=production or label[environment]=production).", {
|
|
23918
23918
|
owner_principal_id: external_exports.string().describe("Exact current administrative-owner principal UUID").optional(),
|
|
23919
23919
|
include_deleted: external_exports.boolean().describe("Include readable permanent tombstones").optional(),
|
|
23920
23920
|
max_results: external_exports.number().int().describe("Page size; defaults to 50 and must be between 1 and 1000").optional(),
|
|
@@ -23972,7 +23972,7 @@ function registerTools() {
|
|
|
23972
23972
|
const result = await callApi("PUT", `/v1/service-identities/${encodeURIComponent(String(args.id))}`, body);
|
|
23973
23973
|
return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
|
|
23974
23974
|
});
|
|
23975
|
-
server.tool("goodmem_spaces_create", "Create a new Space\n\nCreates a new space with the provided name, labels, and embedder configuration. A space is a container for organizing related memories
|
|
23975
|
+
server.tool("goodmem_spaces_create", "Create a new Space\n\nCreates a new space with the provided name, labels, and embedder configuration. A space is a container for organizing related memories.\n\nOWNER DEFAULTS: Owner defaults to the authenticated principal unless owner_id is provided; CREATE_SPACE is evaluated against the proposed space and owner.\n\nEMBEDDER REQUIREMENTS: At least one embedder configuration must be specified. Every referenced embedder must exist, and the caller must have EXECUTE_EMBEDDER on each one.\n\nDUPLICATE DETECTION: Returns ALREADY_EXISTS if another space exists with identical {owner_id, name} (case-sensitive). This operation is NOT idempotent.", {
|
|
23976
23976
|
name: external_exports.string().describe("The desired name for the space. Must be unique within the user's scope."),
|
|
23977
23977
|
labels: external_exports.record(external_exports.string(), external_exports.string()).describe("A set of key-value pairs to categorize or tag the space. Used for filtering and organizational purposes.").optional(),
|
|
23978
23978
|
space_embedders: external_exports.array(external_exports.object({
|
|
@@ -24015,7 +24015,7 @@ function registerTools() {
|
|
|
24015
24015
|
const result = await callApi("POST", `/v1/spaces`, body);
|
|
24016
24016
|
return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
|
|
24017
24017
|
});
|
|
24018
|
-
server.tool("goodmem_spaces_delete", "Delete a space\n\nPermanently deletes a space and all associated content. This operation cannot be undone
|
|
24018
|
+
server.tool("goodmem_spaces_delete", "Delete a space\n\nPermanently deletes a space and all associated content. This operation cannot be undone.\n\nCASCADE DELETION: Removes the space record and cascades deletion to associated memories, chunks, and embedder associations. Requires DELETE_SPACE on the requested space. This operation is safe to retry and may return NOT_FOUND if the space was already deleted.", {
|
|
24019
24019
|
id: external_exports.string().describe("The unique identifier of the space to delete")
|
|
24020
24020
|
}, { readOnlyHint: false, destructiveHint: true, idempotentHint: true, openWorldHint: false }, async (args) => {
|
|
24021
24021
|
if (typeof args.id !== "string" || args.id === "") {
|
|
@@ -24075,7 +24075,7 @@ function registerTools() {
|
|
|
24075
24075
|
const result = await callApi("POST", `/v1/spaces/${encodeURIComponent(String(args.id))}:transferOwnership`, body);
|
|
24076
24076
|
return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
|
|
24077
24077
|
});
|
|
24078
|
-
server.tool("goodmem_spaces_update", "Update a space\n\nUpdates an existing space with new values for the specified fields. Only name and labels can be updated. Fields not included in the request remain unchanged
|
|
24078
|
+
server.tool("goodmem_spaces_update", "Update a space\n\nUpdates an existing space with new values for the specified fields. Only name and labels can be updated. Fields not included in the request remain unchanged.\n\nIMMUTABLE FIELDS: space_embedders, default_chunking_config, and ownerId cannot be modified after creation.\n\nNAME UNIQUENESS: Name must be unique per owner - returns ALREADY_EXISTS if name conflicts with an existing space. Requires UPDATE_SPACE on the requested space. This operation is idempotent.", {
|
|
24079
24079
|
id: external_exports.string().describe("The unique identifier of the space to update"),
|
|
24080
24080
|
name: external_exports.string().describe("The new name for the space.").optional(),
|
|
24081
24081
|
replace_labels: external_exports.record(external_exports.string(), external_exports.string()).describe("Labels to replace all existing labels. Mutually exclusive with merge_labels.").optional(),
|
|
@@ -24211,7 +24211,7 @@ function registerTools() {
|
|
|
24211
24211
|
const result = await callApi("GET", `/v1/users/${encodeURIComponent(String(args.user_id))}/enrollments/${encodeURIComponent(String(args.enrollment_id))}`, void 0);
|
|
24212
24212
|
return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
|
|
24213
24213
|
});
|
|
24214
|
-
server.tool("goodmem_users_list", "List human users\n\nRequires LIST_USER on the GoodMem instance and READ_USER on each returned row. Authorization, label filtering, lifecycle filtering, and keyset pagination run in PostgreSQL. include_deleted expands the lifecycle view but grants no access. include_enrollment_summary requests non-secret bootstrap posture only on active rows where MANAGE_USER_ENROLLMENT is independently authorized
|
|
24214
|
+
server.tool("goodmem_users_list", "List human users\n\nRequires LIST_USER on the GoodMem instance and READ_USER on each returned row. Authorization, label filtering, lifecycle filtering, and keyset pagination run in PostgreSQL. include_deleted expands the lifecycle view but grants no access. include_enrollment_summary requests non-secret bootstrap posture only on active rows where MANAGE_USER_ENROLLMENT is independently authorized.\n\nLABEL FILTERS: Label filters accept either label.<key>=<value> or label[key]=value (for example, label.environment=production or label[environment]=production).", {
|
|
24215
24215
|
include_deleted: external_exports.boolean().describe("Include readable permanent tombstones").optional(),
|
|
24216
24216
|
include_enrollment_summary: external_exports.boolean().describe("Request non-secret enrollment posture on active rows where the caller also has MANAGE_USER_ENROLLMENT").optional(),
|
|
24217
24217
|
max_results: external_exports.number().int().describe("Page size; defaults to 50 and must be between 1 and 1000").optional(),
|
|
@@ -24322,8 +24322,8 @@ async function healthCheck() {
|
|
|
24322
24322
|
const msg = err instanceof Error ? err.message : String(err);
|
|
24323
24323
|
if (msg.includes("CERT") || msg.includes("certificate") || msg.includes("self-signed") || msg.includes("self signed") || msg.includes("UNABLE_TO_VERIFY")) {
|
|
24324
24324
|
console.error(`[goodmem-mcp] TLS certificate error: ${msg}
|
|
24325
|
-
|
|
24326
|
-
or
|
|
24325
|
+
For a private or self-signed CA, set NODE_EXTRA_CA_CERTS=/path/to/rootCA.pem in your MCP server env config and restart the connection.
|
|
24326
|
+
If the server certificate is expired or invalid, fix it on the server.`);
|
|
24327
24327
|
} else {
|
|
24328
24328
|
console.error(`[goodmem-mcp] Cannot reach ${goodmemBaseUrl}: ${msg}`);
|
|
24329
24329
|
}
|
package/package.json
CHANGED
|
@@ -1,7 +1,22 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pairsystems/goodmem-mcp",
|
|
3
|
-
"version": "0.1.
|
|
4
|
-
"description": "GoodMem MCP server
|
|
3
|
+
"version": "0.1.23",
|
|
4
|
+
"description": "GoodMem MCP server — exposes GoodMem API as MCP tools",
|
|
5
|
+
"license": "Apache-2.0",
|
|
6
|
+
"homepage": "https://docs.goodmem.ai/",
|
|
7
|
+
"bugs": {
|
|
8
|
+
"url": "https://community.goodmem.ai/"
|
|
9
|
+
},
|
|
10
|
+
"keywords": [
|
|
11
|
+
"goodmem",
|
|
12
|
+
"mcp",
|
|
13
|
+
"model-context-protocol",
|
|
14
|
+
"memory",
|
|
15
|
+
"retrieval"
|
|
16
|
+
],
|
|
17
|
+
"engines": {
|
|
18
|
+
"node": ">=20"
|
|
19
|
+
},
|
|
5
20
|
"type": "module",
|
|
6
21
|
"main": "dist/index.js",
|
|
7
22
|
"bin": {
|