@terreno/api 57.20.0 → 58.0.0-beta.1
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/CHANGELOG.md +93 -0
- package/README.md +1 -1
- package/biome.jsonc +3 -2
- package/dist/api.d.ts +3 -16
- package/dist/api.js +0 -9
- package/dist/auth.d.ts +3 -2
- package/dist/auth.js +95 -5
- package/dist/authRecovery.d.ts +2 -1
- package/dist/authRecovery.js +35 -17
- package/dist/collectionRegistry.d.ts +3 -4
- package/dist/collectionRegistry.js +0 -1
- package/dist/consentApp.d.ts +1 -1
- package/dist/consentApp.js +58 -2
- package/dist/frameworkModelNames.d.ts +4 -0
- package/dist/frameworkModelNames.js +4 -0
- package/dist/index.d.ts +8 -5
- package/dist/index.js +14 -20
- package/dist/mcp/adminTracking.d.ts +28 -0
- package/dist/mcp/adminTracking.js +80 -0
- package/dist/mcp/auth.d.ts +6 -0
- package/dist/mcp/auth.js +12 -2
- package/dist/mcp/server.d.ts +8 -0
- package/dist/mcp/server.js +48 -4
- package/dist/mcp/serviceTokens.d.ts +21 -1
- package/dist/mcp/serviceTokens.js +159 -183
- package/dist/migrations/builtin/mcpServiceTokenStringIds.d.ts +18 -0
- package/dist/migrations/builtin/mcpServiceTokenStringIds.js +67 -0
- package/dist/models/mcpOAuthToken.js +27 -0
- package/dist/models/mcpRequestLog.d.ts +2 -0
- package/dist/models/mcpRequestLog.js +73 -0
- package/dist/models/mcpServiceToken.js +40 -4
- package/dist/models/mcpToolSetting.d.ts +2 -0
- package/dist/models/mcpToolSetting.js +119 -0
- package/dist/models/versionConfig.d.ts +2 -0
- package/dist/openApiBuilder.d.ts +4 -0
- package/dist/openApiBuilder.js +2 -0
- package/dist/rbac/auditModel.d.ts +2 -1
- package/dist/rbac/realtimeAccess.d.ts +5 -4
- package/dist/rbac/realtimeAccess.js +17 -64
- package/dist/realtime/changeStreamWatcher.d.ts +8 -63
- package/dist/realtime/changeStreamWatcher.js +32 -391
- package/dist/realtime/realtimeApp.d.ts +14 -27
- package/dist/realtime/realtimeApp.js +14 -220
- package/dist/realtime/types.d.ts +0 -64
- package/dist/sync/executors.js +14 -2
- package/dist/sync/socketHandlers.d.ts +1 -1
- package/dist/sync/socketHandlers.js +1 -1
- package/dist/terrenoApp.d.ts +19 -5
- package/dist/terrenoApp.js +21 -14
- package/dist/tests/models.d.ts +17 -22
- package/dist/tests/models.js +7 -1
- package/dist/tests/openApiResponseSchema.d.ts +39 -0
- package/dist/tests/openApiResponseSchema.js +56 -0
- package/dist/tests/testHelper.d.ts +6 -12
- package/dist/tests.d.ts +2 -0
- package/dist/tests.js +6 -1
- package/dist/types/mcpAdmin.d.ts +58 -0
- package/dist/types/mcpAdmin.js +2 -0
- package/dist/types/mcpOAuth.d.ts +2 -0
- package/dist/types/mcpServiceToken.d.ts +9 -4
- package/dist/versionCheckPlugin.d.ts +1 -1
- package/dist/versionCheckPlugin.js +25 -2
- package/e2e/smoke.ts +193 -0
- package/package.json +14 -8
- package/src/__snapshots__/openApi.test.ts.snap +4986 -2478
- package/src/__snapshots__/openApiBuilder.test.ts.snap +836 -0
- package/src/__tests__/openApiResponseSchema.test.ts +148 -0
- package/src/__tests__/versionCheckPlugin.test.ts +72 -0
- package/src/adminModelRouter.test.ts +8 -6
- package/src/api.arrayOperations.test.ts +31 -22
- package/src/api.hooks.test.ts +12 -11
- package/src/api.query.test.ts +2 -2
- package/src/api.test.ts +17 -14
- package/src/api.ts +3 -27
- package/src/audit/auditApp.test.ts +1 -1
- package/src/audit/cloudTasksEnqueue.test.ts +19 -14
- package/src/auth.test.ts +21 -7
- package/src/auth.ts +116 -5
- package/src/authOpenApi.test.ts +316 -0
- package/src/authRecovery.test.ts +10 -10
- package/src/authRecovery.ts +47 -19
- package/src/authVerification.test.ts +7 -7
- package/src/betterAuthFeatures.test.ts +3 -2
- package/src/betterAuthLinking.test.ts +3 -1
- package/src/betterAuthOAuthHandoff.test.ts +13 -5
- package/src/betterAuthSetup.test.ts +77 -51
- package/src/collectionRegistry.test.ts +4 -4
- package/src/collectionRegistry.ts +3 -5
- package/src/consentApp.test.ts +98 -0
- package/src/consentApp.ts +67 -2
- package/src/frameworkModelNames.test.ts +8 -0
- package/src/frameworkModelNames.ts +4 -0
- package/src/githubAuth.test.ts +11 -11
- package/src/index.ts +14 -28
- package/src/isolated/migrateCliConnect.isolated.ts +3 -2
- package/src/mcp/actionTools.test.ts +13 -7
- package/src/mcp/adminTracking.test.ts +272 -0
- package/src/mcp/adminTracking.ts +104 -0
- package/src/mcp/auth.test.ts +7 -3
- package/src/mcp/auth.ts +18 -2
- package/src/mcp/oauth.test.ts +13 -13
- package/src/mcp/server.ts +67 -4
- package/src/mcp/serviceTokens.sync.test.ts +230 -0
- package/src/mcp/serviceTokens.test.ts +114 -62
- package/src/mcp/serviceTokens.ts +193 -212
- package/src/mcp/toolGenerator.test.ts +9 -5
- package/src/migrations/builtin/mcpServiceTokenStringIds.test.ts +194 -0
- package/src/migrations/builtin/mcpServiceTokenStringIds.ts +121 -0
- package/src/migrations/cli.test.ts +15 -14
- package/src/migrations/cli.ts +1 -1
- package/src/migrations/generate.test.ts +2 -2
- package/src/migrations/load.test.ts +1 -1
- package/src/migrations/lock.test.ts +8 -3
- package/src/migrations/runner.test.ts +16 -5
- package/src/migrations/schemaCatalog.test.ts +4 -1
- package/src/models/mcpOAuthToken.test.ts +42 -0
- package/src/models/mcpOAuthToken.ts +32 -0
- package/src/models/mcpRequestLog.ts +81 -0
- package/src/models/mcpServiceToken.test.ts +75 -5
- package/src/models/mcpServiceToken.ts +61 -14
- package/src/models/mcpToolSetting.test.ts +69 -0
- package/src/models/mcpToolSetting.ts +138 -0
- package/src/models/versionConfig.ts +2 -0
- package/src/notifications/notificationsApp.test.ts +5 -8
- package/src/notifiers/slackWebApi.test.ts +30 -8
- package/src/openApi.test.ts +4 -4
- package/src/openApiBuilder.test.ts +34 -1
- package/src/openApiBuilder.ts +5 -0
- package/src/openApiValidator.test.ts +3 -3
- package/src/orgs/orgPermissions.test.ts +2 -2
- package/src/orgs/orgPlugin.test.ts +4 -3
- package/src/orgs/orgSecurityDefects.test.ts +3 -1
- package/src/orgs/organizationSettings.test.ts +1 -1
- package/src/orgs/orgsApp.test.ts +5 -3
- package/src/permissions.test.ts +2 -2
- package/src/rateLimit/rateLimit.test.ts +25 -10
- package/src/rateLimit/redisStore.ioredis.test.ts +3 -2
- package/src/rbac/assertAllowed.test.ts +1 -1
- package/src/rbac/auditModel.ts +10 -2
- package/src/rbac/realtimeAccess.test.ts +20 -171
- package/src/rbac/realtimeAccess.ts +17 -82
- package/src/rbac/routes.test.ts +1 -1
- package/src/rbac/userWriteGuards.test.ts +8 -5
- package/src/realtime/changeStreamWatcher.ts +43 -506
- package/src/realtime/realtime.test.ts +211 -2547
- package/src/realtime/realtimeApp.ts +16 -295
- package/src/realtime/types.ts +0 -72
- package/src/scrubAdminFields.test.ts +1 -1
- package/src/sync/adminWindowMutation.test.ts +4 -3
- package/src/sync/executors.test.ts +29 -1
- package/src/sync/executors.ts +23 -2
- package/src/sync/scripts/compactTombstones.test.ts +4 -3
- package/src/sync/socketHandlers.ts +1 -1
- package/src/sync/sync.test.ts +1 -1
- package/src/sync/syncPhaseC.test.ts +14 -11
- package/src/sync/syncRoutes.test.ts +8 -8
- package/src/sync/syncSeqPlugin.test.ts +1 -2
- package/src/sync/syncSocket.test.ts +78 -113
- package/src/terrenoApp.mcpServiceTokens.test.ts +16 -8
- package/src/terrenoApp.migrations.test.ts +8 -7
- package/src/terrenoApp.ts +38 -18
- package/src/tests/betterAuthStubs.ts +3 -2
- package/src/tests/bunSetup.ts +1 -1
- package/src/tests/models.ts +10 -0
- package/src/tests/openApiResponseSchema.ts +104 -0
- package/src/tests/testEnv.ts +7 -0
- package/src/tests.ts +8 -0
- package/src/types/mcpAdmin.ts +80 -0
- package/src/types/mcpOAuth.ts +5 -0
- package/src/types/mcpServiceToken.ts +12 -4
- package/src/versionCheckPlugin.ts +41 -2
- package/src/webhooks/verifiers/hmac.test.ts +1 -1
- package/tsconfig.typecheck.json +14 -0
- package/dist/realtime/deprecation.d.ts +0 -13
- package/dist/realtime/deprecation.js +0 -31
- package/dist/realtime/queryStore.d.ts +0 -37
- package/dist/realtime/queryStore.js +0 -103
- package/dist/realtime/registry.d.ts +0 -15
- package/dist/realtime/registry.js +0 -52
- package/src/realtime/deprecation.test.ts +0 -60
- package/src/realtime/deprecation.ts +0 -33
- package/src/realtime/queryStore.ts +0 -122
- package/src/realtime/registry.ts +0 -84
|
@@ -0,0 +1,272 @@
|
|
|
1
|
+
import {beforeEach, describe, expect, it, spyOn} from "bun:test";
|
|
2
|
+
import express from "express";
|
|
3
|
+
import mongoose from "mongoose";
|
|
4
|
+
import supertest from "supertest";
|
|
5
|
+
import {z} from "zod";
|
|
6
|
+
|
|
7
|
+
import type {UserModel as AuthUserModel} from "../auth";
|
|
8
|
+
import {logger} from "../logger";
|
|
9
|
+
import {McpRequestLog} from "../models/mcpRequestLog";
|
|
10
|
+
import {McpServiceToken} from "../models/mcpServiceToken";
|
|
11
|
+
import {McpToolSetting} from "../models/mcpToolSetting";
|
|
12
|
+
import {TerrenoApp} from "../terrenoApp";
|
|
13
|
+
import {setupDb, UserModel} from "../tests";
|
|
14
|
+
import type {McpRequestLogOutcome} from "../types/mcpAdmin";
|
|
15
|
+
import {recordMcpToolCall, resolveMcpRequestLogOption} from "./adminTracking";
|
|
16
|
+
import {clearMCPRegistry, registerMCPTool} from "./registry";
|
|
17
|
+
import {mountMCPServer} from "./server";
|
|
18
|
+
|
|
19
|
+
const ACCEPT = "application/json, text/event-stream";
|
|
20
|
+
|
|
21
|
+
const registerTools = (): void => {
|
|
22
|
+
registerMCPTool({
|
|
23
|
+
description: "Echo a secret message",
|
|
24
|
+
handler: async (args) => {
|
|
25
|
+
return {content: [{text: `echo ${String(args.message)}`, type: "text"}]};
|
|
26
|
+
},
|
|
27
|
+
name: "echo_message",
|
|
28
|
+
zodSchema: z.object({message: z.string()}).strict(),
|
|
29
|
+
});
|
|
30
|
+
registerMCPTool({
|
|
31
|
+
description: "Always fails",
|
|
32
|
+
handler: async () => {
|
|
33
|
+
throw new TypeError("patient 123 not found");
|
|
34
|
+
},
|
|
35
|
+
name: "always_throws",
|
|
36
|
+
zodSchema: z.object({}).strict(),
|
|
37
|
+
});
|
|
38
|
+
};
|
|
39
|
+
|
|
40
|
+
const buildApp = (options: {requestLog?: boolean; toolSettings?: boolean}): express.Application => {
|
|
41
|
+
const app = express();
|
|
42
|
+
app.use(express.json());
|
|
43
|
+
mountMCPServer(app, {
|
|
44
|
+
mcpServiceTokens: true,
|
|
45
|
+
requestLog: options.requestLog ? {retentionDays: 7} : undefined,
|
|
46
|
+
toolSettings: options.toolSettings,
|
|
47
|
+
userModel: UserModel as unknown as AuthUserModel,
|
|
48
|
+
});
|
|
49
|
+
return app;
|
|
50
|
+
};
|
|
51
|
+
|
|
52
|
+
const callTool = (
|
|
53
|
+
app: express.Application,
|
|
54
|
+
name: string,
|
|
55
|
+
args: Record<string, unknown>,
|
|
56
|
+
token?: string
|
|
57
|
+
): supertest.Test => {
|
|
58
|
+
const request = supertest(app).post("/mcp").set("accept", ACCEPT);
|
|
59
|
+
if (token) {
|
|
60
|
+
request.set("authorization", `Bearer ${token}`);
|
|
61
|
+
}
|
|
62
|
+
return request.send({
|
|
63
|
+
id: 1,
|
|
64
|
+
jsonrpc: "2.0",
|
|
65
|
+
method: "tools/call",
|
|
66
|
+
params: {arguments: args, name},
|
|
67
|
+
});
|
|
68
|
+
};
|
|
69
|
+
|
|
70
|
+
const listTools = (app: express.Application): supertest.Test =>
|
|
71
|
+
supertest(app)
|
|
72
|
+
.post("/mcp")
|
|
73
|
+
.set("accept", ACCEPT)
|
|
74
|
+
.send({id: 2, jsonrpc: "2.0", method: "tools/list", params: {}});
|
|
75
|
+
|
|
76
|
+
// Request-log writes are fire-and-forget, so poll briefly for the row.
|
|
77
|
+
const waitForLogs = async (count: number): Promise<void> => {
|
|
78
|
+
for (let attempt = 0; attempt < 50; attempt++) {
|
|
79
|
+
if ((await McpRequestLog.countDocuments({})) >= count) {
|
|
80
|
+
return;
|
|
81
|
+
}
|
|
82
|
+
await new Promise((resolve) => setTimeout(resolve, 10));
|
|
83
|
+
}
|
|
84
|
+
};
|
|
85
|
+
|
|
86
|
+
const waitForSettings = async (count: number): Promise<void> => {
|
|
87
|
+
for (let attempt = 0; attempt < 50; attempt++) {
|
|
88
|
+
if ((await McpToolSetting.countDocuments({})) >= count) {
|
|
89
|
+
return;
|
|
90
|
+
}
|
|
91
|
+
await new Promise((resolve) => setTimeout(resolve, 10));
|
|
92
|
+
}
|
|
93
|
+
};
|
|
94
|
+
|
|
95
|
+
describe("resolveMcpRequestLogOption", () => {
|
|
96
|
+
it("is off unless enabled", () => {
|
|
97
|
+
expect(resolveMcpRequestLogOption(undefined)).toBeUndefined();
|
|
98
|
+
expect(resolveMcpRequestLogOption(false)).toBeUndefined();
|
|
99
|
+
expect(resolveMcpRequestLogOption({enabled: false})).toBeUndefined();
|
|
100
|
+
});
|
|
101
|
+
|
|
102
|
+
it("defaults retention to 30 days", () => {
|
|
103
|
+
expect(resolveMcpRequestLogOption(true)).toEqual({retentionDays: 30});
|
|
104
|
+
expect(resolveMcpRequestLogOption({enabled: true, retentionDays: 3})).toEqual({
|
|
105
|
+
retentionDays: 3,
|
|
106
|
+
});
|
|
107
|
+
});
|
|
108
|
+
|
|
109
|
+
it("rejects a non-positive retention", () => {
|
|
110
|
+
expect(() => resolveMcpRequestLogOption({enabled: true, retentionDays: 0})).toThrow();
|
|
111
|
+
});
|
|
112
|
+
});
|
|
113
|
+
|
|
114
|
+
describe("MCP request log", () => {
|
|
115
|
+
let notAdmin: {_id: mongoose.Types.ObjectId};
|
|
116
|
+
beforeEach(async () => {
|
|
117
|
+
clearMCPRegistry();
|
|
118
|
+
registerTools();
|
|
119
|
+
const users = await setupDb();
|
|
120
|
+
notAdmin = users[1];
|
|
121
|
+
await McpRequestLog.deleteMany({});
|
|
122
|
+
await McpServiceToken.deleteMany({});
|
|
123
|
+
});
|
|
124
|
+
|
|
125
|
+
it("records the tool, user, and service token but never the arguments or result", async () => {
|
|
126
|
+
const user = notAdmin;
|
|
127
|
+
const {mcpServiceToken, token} = await McpServiceToken.issueFor(user, {name: "Laptop"});
|
|
128
|
+
const app = buildApp({requestLog: true});
|
|
129
|
+
|
|
130
|
+
const res = await callTool(app, "echo_message", {message: "very secret"}, token);
|
|
131
|
+
|
|
132
|
+
expect(res.text).toContain("echo very secret");
|
|
133
|
+
await waitForLogs(1);
|
|
134
|
+
const [row] = await McpRequestLog.find({}).lean();
|
|
135
|
+
expect(row.toolName).toBe("echo_message");
|
|
136
|
+
expect(row.outcome).toBe("ok");
|
|
137
|
+
expect(row.credential).toBe("mcp-service-token");
|
|
138
|
+
expect(String(row.userId)).toBe(String(user._id));
|
|
139
|
+
expect(String(row.serviceTokenId)).toBe(String(mcpServiceToken._id));
|
|
140
|
+
expect(row.durationMs).toBeGreaterThanOrEqual(0);
|
|
141
|
+
expect(row.expiresAt.getTime()).toBeGreaterThan(Date.now() + 6 * 24 * 60 * 60 * 1000);
|
|
142
|
+
const stored = JSON.stringify(row);
|
|
143
|
+
expect(stored).not.toContain("very secret");
|
|
144
|
+
expect(stored).not.toContain(token);
|
|
145
|
+
});
|
|
146
|
+
|
|
147
|
+
it("records an exception by class name without the message", async () => {
|
|
148
|
+
const app = buildApp({requestLog: true});
|
|
149
|
+
|
|
150
|
+
await callTool(app, "always_throws", {});
|
|
151
|
+
|
|
152
|
+
await waitForLogs(1);
|
|
153
|
+
const [row] = await McpRequestLog.find({}).lean();
|
|
154
|
+
expect(row.outcome).toBe("exception");
|
|
155
|
+
expect(row.errorName).toBe("TypeError");
|
|
156
|
+
expect(row.userId).toBeUndefined();
|
|
157
|
+
expect(JSON.stringify(row)).not.toContain("patient 123");
|
|
158
|
+
});
|
|
159
|
+
|
|
160
|
+
it("writes nothing when the log is off", async () => {
|
|
161
|
+
const app = buildApp({});
|
|
162
|
+
|
|
163
|
+
await callTool(app, "echo_message", {message: "hi"});
|
|
164
|
+
|
|
165
|
+
expect(await McpRequestLog.countDocuments({})).toBe(0);
|
|
166
|
+
});
|
|
167
|
+
|
|
168
|
+
it("drops a failed write with a debug log instead of failing the call", async () => {
|
|
169
|
+
const debug = spyOn(logger, "debug");
|
|
170
|
+
try {
|
|
171
|
+
// An outcome outside the schema enum makes the insert fail validation.
|
|
172
|
+
expect(() =>
|
|
173
|
+
recordMcpToolCall(
|
|
174
|
+
{durationMs: 1, outcome: "bogus" as McpRequestLogOutcome, toolName: "echo_message"},
|
|
175
|
+
{retentionDays: 1}
|
|
176
|
+
)
|
|
177
|
+
).not.toThrow();
|
|
178
|
+
for (let attempt = 0; attempt < 50 && debug.mock.calls.length === 0; attempt++) {
|
|
179
|
+
await new Promise((resolve) => setTimeout(resolve, 10));
|
|
180
|
+
}
|
|
181
|
+
expect(String(debug.mock.calls[0]?.[0])).toContain("Request log write failed");
|
|
182
|
+
expect(await McpRequestLog.countDocuments({})).toBe(0);
|
|
183
|
+
} finally {
|
|
184
|
+
debug.mockRestore();
|
|
185
|
+
}
|
|
186
|
+
});
|
|
187
|
+
});
|
|
188
|
+
|
|
189
|
+
describe("MCP tool settings", () => {
|
|
190
|
+
beforeEach(async () => {
|
|
191
|
+
clearMCPRegistry();
|
|
192
|
+
registerTools();
|
|
193
|
+
await McpToolSetting.deleteMany({});
|
|
194
|
+
});
|
|
195
|
+
|
|
196
|
+
it("registers every tool as enabled on mount", async () => {
|
|
197
|
+
buildApp({toolSettings: true});
|
|
198
|
+
|
|
199
|
+
await waitForSettings(2);
|
|
200
|
+
const rows = await McpToolSetting.find({}).sort({name: 1}).lean();
|
|
201
|
+
expect(rows.map((row) => [row.name, row.enabled, row.source, row.registered])).toEqual([
|
|
202
|
+
["always_throws", true, "custom", true],
|
|
203
|
+
["echo_message", true, "custom", true],
|
|
204
|
+
]);
|
|
205
|
+
});
|
|
206
|
+
|
|
207
|
+
it("keeps an admin's switch across restarts and marks tools that are gone", async () => {
|
|
208
|
+
await McpToolSetting.create({enabled: false, name: "echo_message", source: "custom"});
|
|
209
|
+
await McpToolSetting.create({name: "retired_tool", source: "custom"});
|
|
210
|
+
|
|
211
|
+
await McpToolSetting.syncRegistered([
|
|
212
|
+
{description: "Echo", name: "echo_message", source: "custom"},
|
|
213
|
+
]);
|
|
214
|
+
|
|
215
|
+
const echo = await McpToolSetting.findExactlyOne({name: "echo_message"});
|
|
216
|
+
expect(echo.enabled).toBe(false);
|
|
217
|
+
expect(echo.registered).toBe(true);
|
|
218
|
+
const retired = await McpToolSetting.findExactlyOne({name: "retired_tool"});
|
|
219
|
+
expect(retired.registered).toBe(false);
|
|
220
|
+
});
|
|
221
|
+
|
|
222
|
+
it("hides a disabled tool from tools/list and rejects tools/call", async () => {
|
|
223
|
+
await McpToolSetting.create({enabled: false, name: "echo_message", source: "custom"});
|
|
224
|
+
const app = buildApp({toolSettings: true});
|
|
225
|
+
|
|
226
|
+
const list = await listTools(app);
|
|
227
|
+
expect(list.text).not.toContain("echo_message");
|
|
228
|
+
expect(list.text).toContain("always_throws");
|
|
229
|
+
|
|
230
|
+
const call = await callTool(app, "echo_message", {message: "hi"});
|
|
231
|
+
expect(call.text).not.toContain("echo hi");
|
|
232
|
+
expect(call.text).toContain("echo_message");
|
|
233
|
+
});
|
|
234
|
+
|
|
235
|
+
it("serves every tool when settings are off, even with a disabled row", async () => {
|
|
236
|
+
await McpToolSetting.create({enabled: false, name: "echo_message", source: "custom"});
|
|
237
|
+
const app = buildApp({});
|
|
238
|
+
|
|
239
|
+
const list = await listTools(app);
|
|
240
|
+
|
|
241
|
+
expect(list.text).toContain("echo_message");
|
|
242
|
+
expect(await McpToolSetting.countDocuments({})).toBe(1);
|
|
243
|
+
expect(mongoose.connection.readyState).toBe(1);
|
|
244
|
+
});
|
|
245
|
+
});
|
|
246
|
+
|
|
247
|
+
describe("TerrenoApp MCP admin options", () => {
|
|
248
|
+
beforeEach(async () => {
|
|
249
|
+
clearMCPRegistry();
|
|
250
|
+
registerTools();
|
|
251
|
+
await McpToolSetting.deleteMany({});
|
|
252
|
+
await McpRequestLog.deleteMany({});
|
|
253
|
+
});
|
|
254
|
+
|
|
255
|
+
it("passes mcpToolSettings and mcpRequestLog through to /mcp", async () => {
|
|
256
|
+
await McpToolSetting.create({enabled: false, name: "always_throws", source: "custom"});
|
|
257
|
+
const app = new TerrenoApp({
|
|
258
|
+
mcpRequestLog: true,
|
|
259
|
+
mcpToolSettings: true,
|
|
260
|
+
skipListen: true,
|
|
261
|
+
userModel: UserModel as unknown as AuthUserModel,
|
|
262
|
+
}).build();
|
|
263
|
+
|
|
264
|
+
const list = await listTools(app);
|
|
265
|
+
expect(list.text).not.toContain("always_throws");
|
|
266
|
+
await callTool(app, "echo_message", {message: "hi"});
|
|
267
|
+
|
|
268
|
+
await waitForLogs(1);
|
|
269
|
+
await waitForSettings(2);
|
|
270
|
+
expect(await McpRequestLog.countDocuments({toolName: "echo_message"})).toBe(1);
|
|
271
|
+
});
|
|
272
|
+
});
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import {DateTime} from "luxon";
|
|
2
|
+
import mongoose from "mongoose";
|
|
3
|
+
|
|
4
|
+
import {APIError} from "../errors";
|
|
5
|
+
import {logger} from "../logger";
|
|
6
|
+
import {McpRequestLog} from "../models/mcpRequestLog";
|
|
7
|
+
import {McpToolSetting} from "../models/mcpToolSetting";
|
|
8
|
+
import type {McpRequestLogOutcome, McpToolSource} from "../types/mcpAdmin";
|
|
9
|
+
import type {MCPAuthResult} from "./auth";
|
|
10
|
+
import {getMCPCustomTools} from "./registry";
|
|
11
|
+
import type {MCPToolDefinition} from "./toolGenerator";
|
|
12
|
+
|
|
13
|
+
const DEFAULT_REQUEST_LOG_RETENTION_DAYS = 30;
|
|
14
|
+
|
|
15
|
+
/** `true` is `{enabled: true}`. Rows keep metadata only and expire after `retentionDays`. */
|
|
16
|
+
export type McpRequestLogAppOption = boolean | {enabled: boolean; retentionDays?: number};
|
|
17
|
+
|
|
18
|
+
export interface ResolvedMcpRequestLogOptions {
|
|
19
|
+
retentionDays: number;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
export const resolveMcpRequestLogOption = (
|
|
23
|
+
option: McpRequestLogAppOption | undefined
|
|
24
|
+
): ResolvedMcpRequestLogOptions | undefined => {
|
|
25
|
+
if (option === true) {
|
|
26
|
+
return {retentionDays: DEFAULT_REQUEST_LOG_RETENTION_DAYS};
|
|
27
|
+
}
|
|
28
|
+
if (!option || typeof option !== "object" || option.enabled !== true) {
|
|
29
|
+
return undefined;
|
|
30
|
+
}
|
|
31
|
+
const retentionDays = option.retentionDays ?? DEFAULT_REQUEST_LOG_RETENTION_DAYS;
|
|
32
|
+
if (!Number.isFinite(retentionDays) || retentionDays <= 0) {
|
|
33
|
+
throw new APIError({
|
|
34
|
+
code: "mcp-request-log-misconfigured",
|
|
35
|
+
detail: `mcpRequestLog.retentionDays must be a positive number, got ${retentionDays}`,
|
|
36
|
+
status: 500,
|
|
37
|
+
title: "MCP request log is misconfigured",
|
|
38
|
+
});
|
|
39
|
+
}
|
|
40
|
+
return {retentionDays};
|
|
41
|
+
};
|
|
42
|
+
|
|
43
|
+
export interface McpToolCallRecord {
|
|
44
|
+
auth?: MCPAuthResult;
|
|
45
|
+
durationMs: number;
|
|
46
|
+
errorName?: string;
|
|
47
|
+
outcome: McpRequestLogOutcome;
|
|
48
|
+
toolName: string;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
const toObjectId = (value: string | undefined): mongoose.Types.ObjectId | undefined => {
|
|
52
|
+
if (!value || !mongoose.isValidObjectId(value)) {
|
|
53
|
+
return undefined;
|
|
54
|
+
}
|
|
55
|
+
return new mongoose.Types.ObjectId(value);
|
|
56
|
+
};
|
|
57
|
+
|
|
58
|
+
/**
|
|
59
|
+
* Write one request-log row without blocking or failing the tool call. A failed write is
|
|
60
|
+
* logged at debug level and dropped.
|
|
61
|
+
*/
|
|
62
|
+
export const recordMcpToolCall = (
|
|
63
|
+
record: McpToolCallRecord,
|
|
64
|
+
options: ResolvedMcpRequestLogOptions
|
|
65
|
+
): void => {
|
|
66
|
+
const {auth} = record;
|
|
67
|
+
void McpRequestLog.create({
|
|
68
|
+
credential: auth?.credential,
|
|
69
|
+
durationMs: Math.round(record.durationMs),
|
|
70
|
+
errorName: record.errorName,
|
|
71
|
+
expiresAt: DateTime.now().plus({days: options.retentionDays}).toJSDate(),
|
|
72
|
+
oauthClientId: auth?.oauthClientId,
|
|
73
|
+
oauthFamilyId: auth?.oauthFamilyId,
|
|
74
|
+
outcome: record.outcome,
|
|
75
|
+
serviceTokenId: auth?.serviceTokenId,
|
|
76
|
+
toolName: record.toolName,
|
|
77
|
+
userId: toObjectId(auth?.user?.id ? String(auth.user.id) : undefined),
|
|
78
|
+
}).catch((error: unknown) => {
|
|
79
|
+
logger.debug(`[mcp] Request log write failed: ${String(error)}`);
|
|
80
|
+
});
|
|
81
|
+
};
|
|
82
|
+
|
|
83
|
+
/** Register every tool in `McpToolSetting` so admins can see and switch them. */
|
|
84
|
+
export const syncMcpToolSettings = async (tools: MCPToolDefinition[]): Promise<void> => {
|
|
85
|
+
const customNames = new Set(getMCPCustomTools().map((tool) => tool.name));
|
|
86
|
+
await McpToolSetting.syncRegistered(
|
|
87
|
+
tools.map((tool) => ({
|
|
88
|
+
description: tool.description,
|
|
89
|
+
name: tool.name,
|
|
90
|
+
source: (customNames.has(tool.name) ? "custom" : "model") as McpToolSource,
|
|
91
|
+
}))
|
|
92
|
+
);
|
|
93
|
+
};
|
|
94
|
+
|
|
95
|
+
/** Tools an admin left on. A tool without a settings row counts as on. */
|
|
96
|
+
export const filterEnabledMcpTools = async (
|
|
97
|
+
tools: MCPToolDefinition[]
|
|
98
|
+
): Promise<MCPToolDefinition[]> => {
|
|
99
|
+
const disabled = await McpToolSetting.disabledNames();
|
|
100
|
+
if (disabled.size === 0) {
|
|
101
|
+
return tools;
|
|
102
|
+
}
|
|
103
|
+
return tools.filter((tool) => !disabled.has(tool.name));
|
|
104
|
+
};
|
package/src/mcp/auth.test.ts
CHANGED
|
@@ -52,7 +52,7 @@ const signToken = (payload: Record<string, unknown>, secret = "test-token-secret
|
|
|
52
52
|
describe("extractUserFromHeaders", () => {
|
|
53
53
|
beforeEach(async () => {
|
|
54
54
|
await UserTestModel.deleteMany({});
|
|
55
|
-
await McpServiceToken.deleteMany({});
|
|
55
|
+
await McpServiceToken.collection.deleteMany({});
|
|
56
56
|
process.env.TOKEN_SECRET = "test-token-secret";
|
|
57
57
|
});
|
|
58
58
|
|
|
@@ -88,8 +88,12 @@ describe("extractUserFromHeaders", () => {
|
|
|
88
88
|
|
|
89
89
|
assert.equal(String((user as unknown as MCPAuthUserFields)?._id), created._id.toString());
|
|
90
90
|
|
|
91
|
-
|
|
92
|
-
|
|
91
|
+
// lastUsedAt is written without awaiting the request, so poll for it.
|
|
92
|
+
let usedToken = await McpServiceToken.findById(issued.mcpServiceToken._id);
|
|
93
|
+
for (let attempt = 0; attempt < 50 && !usedToken?.lastUsedAt; attempt++) {
|
|
94
|
+
await Bun.sleep(20);
|
|
95
|
+
usedToken = await McpServiceToken.findById(issued.mcpServiceToken._id);
|
|
96
|
+
}
|
|
93
97
|
assert.isDefined(usedToken?.lastUsedAt);
|
|
94
98
|
});
|
|
95
99
|
|
package/src/mcp/auth.ts
CHANGED
|
@@ -20,6 +20,12 @@ export interface MCPAuthContext {
|
|
|
20
20
|
/** The authenticated user plus the credential type that proved it. */
|
|
21
21
|
export interface MCPAuthResult {
|
|
22
22
|
credential: RequestCredential;
|
|
23
|
+
/** OAuth client id for an MCP OAuth access token. Never a secret. */
|
|
24
|
+
oauthClientId?: string;
|
|
25
|
+
/** OAuth rotation-chain id for an MCP OAuth access token. Never a secret. */
|
|
26
|
+
oauthFamilyId?: string;
|
|
27
|
+
/** `McpServiceToken` document id for a service token. Never the token or its hash. */
|
|
28
|
+
serviceTokenId?: string;
|
|
23
29
|
/** Scopes granted to an MCP OAuth access token; unset for other credentials. */
|
|
24
30
|
scopes?: string[];
|
|
25
31
|
user: User;
|
|
@@ -97,7 +103,11 @@ const authenticateServiceToken = async (
|
|
|
97
103
|
).catch((error) => {
|
|
98
104
|
logger.debug(`MCP service token last-used update failed: ${error}`);
|
|
99
105
|
});
|
|
100
|
-
return {
|
|
106
|
+
return {
|
|
107
|
+
credential: "mcp-service-token",
|
|
108
|
+
serviceTokenId: String(serviceToken._id),
|
|
109
|
+
user: activeUser,
|
|
110
|
+
};
|
|
101
111
|
};
|
|
102
112
|
|
|
103
113
|
const authenticateOAuthAccessToken = async (
|
|
@@ -121,7 +131,13 @@ const authenticateOAuthAccessToken = async (
|
|
|
121
131
|
return undefined;
|
|
122
132
|
}
|
|
123
133
|
const scopes = (accessToken.scope ?? "").split(" ").filter((scope) => scope.length > 0);
|
|
124
|
-
return {
|
|
134
|
+
return {
|
|
135
|
+
credential: "oauth",
|
|
136
|
+
oauthClientId: accessToken.clientId,
|
|
137
|
+
oauthFamilyId: accessToken.familyId,
|
|
138
|
+
scopes,
|
|
139
|
+
user: activeUser,
|
|
140
|
+
};
|
|
125
141
|
};
|
|
126
142
|
|
|
127
143
|
/**
|
package/src/mcp/oauth.test.ts
CHANGED
|
@@ -177,7 +177,7 @@ describe("MCP OAuth authorization server", () => {
|
|
|
177
177
|
McpOAuthAuthorization.deleteMany({}),
|
|
178
178
|
McpOAuthClient.deleteMany({}),
|
|
179
179
|
McpOAuthToken.deleteMany({}),
|
|
180
|
-
McpServiceToken.deleteMany({}),
|
|
180
|
+
McpServiceToken.collection.deleteMany({}),
|
|
181
181
|
]);
|
|
182
182
|
clearMCPRegistry();
|
|
183
183
|
app = buildApp();
|
|
@@ -849,7 +849,7 @@ describe("MCP OAuth authorization server", () => {
|
|
|
849
849
|
});
|
|
850
850
|
|
|
851
851
|
it("keeps accepting JWT and mcp_ service tokens", async () => {
|
|
852
|
-
const created = await agent.post("/mcp/service-tokens").send({name: "Agent"});
|
|
852
|
+
const created = await agent.post("/mcp/service-tokens/create").send({name: "Agent"});
|
|
853
853
|
|
|
854
854
|
const jwtCall = await agent
|
|
855
855
|
.post("/mcp")
|
|
@@ -872,8 +872,8 @@ describe("MCP OAuth authorization server", () => {
|
|
|
872
872
|
};
|
|
873
873
|
|
|
874
874
|
it("ends service tokens, access tokens, and refresh tokens issued before a password reset", async () => {
|
|
875
|
-
const serviceToken = (await agent.post("/mcp/service-tokens").send({name: "Agent"}))
|
|
876
|
-
.token as string;
|
|
875
|
+
const serviceToken = (await agent.post("/mcp/service-tokens/create").send({name: "Agent"}))
|
|
876
|
+
.body.data.token as string;
|
|
877
877
|
const flow = await approvedCode(app, agent);
|
|
878
878
|
const oauth = (await exchangeCode(app, flow)).body;
|
|
879
879
|
expect((await callMcp(app, serviceToken)).status).toBe(200);
|
|
@@ -891,7 +891,7 @@ describe("MCP OAuth authorization server", () => {
|
|
|
891
891
|
});
|
|
892
892
|
|
|
893
893
|
it("lists service tokens from before a password reset as revoked", async () => {
|
|
894
|
-
await agent.post("/mcp/service-tokens").send({name: "Before reset"});
|
|
894
|
+
await agent.post("/mcp/service-tokens/create").send({name: "Before reset"});
|
|
895
895
|
|
|
896
896
|
await resetPassword();
|
|
897
897
|
|
|
@@ -911,8 +911,8 @@ describe("MCP OAuth authorization server", () => {
|
|
|
911
911
|
});
|
|
912
912
|
|
|
913
913
|
it("ends MCP credentials on any tokenEpoch bump, such as a Better Auth session revocation", async () => {
|
|
914
|
-
const serviceToken = (await agent.post("/mcp/service-tokens").send({name: "Agent"}))
|
|
915
|
-
.token as string;
|
|
914
|
+
const serviceToken = (await agent.post("/mcp/service-tokens/create").send({name: "Agent"}))
|
|
915
|
+
.body.data.token as string;
|
|
916
916
|
const flow = await approvedCode(app, agent);
|
|
917
917
|
const oauth = (await exchangeCode(app, flow)).body;
|
|
918
918
|
|
|
@@ -928,8 +928,8 @@ describe("MCP OAuth authorization server", () => {
|
|
|
928
928
|
it("accepts MCP credentials issued after a password reset", async () => {
|
|
929
929
|
await resetPassword();
|
|
930
930
|
|
|
931
|
-
const serviceToken = (await agent.post("/mcp/service-tokens").send({name: "After"}))
|
|
932
|
-
.token as string;
|
|
931
|
+
const serviceToken = (await agent.post("/mcp/service-tokens/create").send({name: "After"}))
|
|
932
|
+
.body.data.token as string;
|
|
933
933
|
const flow = await approvedCode(app, agent);
|
|
934
934
|
const oauth = (await exchangeCode(app, flow)).body;
|
|
935
935
|
const refreshed = await refresh(app, flow.clientId, oauth.refresh_token);
|
|
@@ -949,7 +949,7 @@ describe("MCP OAuth authorization server", () => {
|
|
|
949
949
|
})
|
|
950
950
|
.addMiddleware((req, _res, next) => {
|
|
951
951
|
if (req.path.startsWith("/oauth/authorize/")) {
|
|
952
|
-
req.user = user ?? undefined;
|
|
952
|
+
req.user = (user ?? undefined) as unknown as typeof req.user;
|
|
953
953
|
}
|
|
954
954
|
next();
|
|
955
955
|
})
|
|
@@ -1313,7 +1313,7 @@ describe("MCP OAuth granted scopes", () => {
|
|
|
1313
1313
|
McpOAuthAuthorization.deleteMany({}),
|
|
1314
1314
|
McpOAuthClient.deleteMany({}),
|
|
1315
1315
|
McpOAuthToken.deleteMany({}),
|
|
1316
|
-
McpServiceToken.deleteMany({}),
|
|
1316
|
+
McpServiceToken.collection.deleteMany({}),
|
|
1317
1317
|
]);
|
|
1318
1318
|
clearMCPRegistry();
|
|
1319
1319
|
app = new TerrenoApp({
|
|
@@ -1347,8 +1347,8 @@ describe("MCP OAuth granted scopes", () => {
|
|
|
1347
1347
|
});
|
|
1348
1348
|
|
|
1349
1349
|
it("does not apply OAuth scopes to the user's own JWT or service token", async () => {
|
|
1350
|
-
const serviceToken = (await agent.post("/mcp/service-tokens").send({name: "Agent"})).body
|
|
1351
|
-
.token as string;
|
|
1350
|
+
const serviceToken = (await agent.post("/mcp/service-tokens/create").send({name: "Agent"})).body
|
|
1351
|
+
.data.token as string;
|
|
1352
1352
|
|
|
1353
1353
|
const viaServiceToken = rpcResult((await callTool(serviceToken, "scoped_write")).text);
|
|
1354
1354
|
const viaScopes = rpcResult((await callTool(serviceToken, "scoped_scopes")).text);
|
package/src/mcp/server.ts
CHANGED
|
@@ -7,6 +7,13 @@ import type {User, UserModel} from "../auth";
|
|
|
7
7
|
import type {BetterAuthInstance} from "../betterAuthSetup";
|
|
8
8
|
import {logger} from "../logger";
|
|
9
9
|
import {setRequestContext} from "../requestContext";
|
|
10
|
+
import {
|
|
11
|
+
filterEnabledMcpTools,
|
|
12
|
+
type McpToolCallRecord,
|
|
13
|
+
type ResolvedMcpRequestLogOptions,
|
|
14
|
+
recordMcpToolCall,
|
|
15
|
+
syncMcpToolSettings,
|
|
16
|
+
} from "./adminTracking";
|
|
10
17
|
import {extractAuthFromHeaders, type MCPAuthContext, type MCPAuthResult} from "./auth";
|
|
11
18
|
import {type ResolvedMcpOAuthOptions, sendMcpOAuthChallenge} from "./oauthMetadata";
|
|
12
19
|
import {getAllMCPTools, type MCPToolDefinition} from "./toolGenerator";
|
|
@@ -20,6 +27,13 @@ export interface MCPServerOptions {
|
|
|
20
27
|
* request without valid credentials with a 401 RFC 9728 challenge.
|
|
21
28
|
*/
|
|
22
29
|
mcpOAuth?: ResolvedMcpOAuthOptions;
|
|
30
|
+
/** When set, each tool call writes a metadata-only `McpRequestLog` row. */
|
|
31
|
+
requestLog?: ResolvedMcpRequestLogOptions;
|
|
32
|
+
/**
|
|
33
|
+
* When true, tools are registered in `McpToolSetting` on mount and tools an admin turned off
|
|
34
|
+
* are left out of `tools/list` and `tools/call`.
|
|
35
|
+
*/
|
|
36
|
+
toolSettings?: boolean;
|
|
23
37
|
}
|
|
24
38
|
|
|
25
39
|
// Auth is resolved once in the Express handler (which may answer 401) and read back by the
|
|
@@ -40,13 +54,29 @@ export const mountMCPServer = (app: Application, options: MCPServerOptions): voi
|
|
|
40
54
|
|
|
41
55
|
logger.info(`Mounting MCP server with ${tools.length} tools at /mcp`);
|
|
42
56
|
|
|
57
|
+
if (options.toolSettings) {
|
|
58
|
+
void syncMcpToolSettings(tools).catch((error: unknown) => {
|
|
59
|
+
logger.warn(`[mcp] Could not register tools in McpToolSetting: ${String(error)}`);
|
|
60
|
+
});
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
const buildServer = async (auth: MCPAuthResult | undefined): Promise<McpServer> => {
|
|
64
|
+
const served = options.toolSettings ? await filterEnabledMcpTools(tools) : tools;
|
|
65
|
+
const onToolCall = options.requestLog
|
|
66
|
+
? (record: Omit<McpToolCallRecord, "auth">): void => {
|
|
67
|
+
recordMcpToolCall({...record, auth}, options.requestLog as ResolvedMcpRequestLogOptions);
|
|
68
|
+
}
|
|
69
|
+
: undefined;
|
|
70
|
+
return createMcpServerInstance(served, auth?.user, onToolCall);
|
|
71
|
+
};
|
|
72
|
+
|
|
43
73
|
// The 2026-07-28 handler is stateless: it creates one server per request and also serves
|
|
44
74
|
// 2025-era clients through the SDK's stateless legacy fallback.
|
|
45
75
|
const handler = createMcpHandler(
|
|
46
76
|
async ({requestInfo}) => {
|
|
47
77
|
const stored = mcpAuthStorage.getStore();
|
|
48
78
|
if (stored) {
|
|
49
|
-
return
|
|
79
|
+
return buildServer(stored.auth);
|
|
50
80
|
}
|
|
51
81
|
const headers: Record<string, string> = {};
|
|
52
82
|
requestInfo?.headers.forEach((value, key) => {
|
|
@@ -54,7 +84,7 @@ export const mountMCPServer = (app: Application, options: MCPServerOptions): voi
|
|
|
54
84
|
});
|
|
55
85
|
const auth = await extractAuthFromHeaders(headers, authContext);
|
|
56
86
|
recordMcpAuth(auth);
|
|
57
|
-
return
|
|
87
|
+
return buildServer(auth);
|
|
58
88
|
},
|
|
59
89
|
{
|
|
60
90
|
legacy: "stateless",
|
|
@@ -99,7 +129,18 @@ const recordMcpAuth = (auth: MCPAuthResult | undefined): void => {
|
|
|
99
129
|
});
|
|
100
130
|
};
|
|
101
131
|
|
|
102
|
-
const
|
|
132
|
+
const errorName = (error: unknown): string => {
|
|
133
|
+
if (error instanceof Error) {
|
|
134
|
+
return error.name;
|
|
135
|
+
}
|
|
136
|
+
return typeof error;
|
|
137
|
+
};
|
|
138
|
+
|
|
139
|
+
const createMcpServerInstance = (
|
|
140
|
+
tools: MCPToolDefinition[],
|
|
141
|
+
user?: User,
|
|
142
|
+
onToolCall?: (record: Omit<McpToolCallRecord, "auth">) => void
|
|
143
|
+
): McpServer => {
|
|
103
144
|
const server = new McpServer(
|
|
104
145
|
{
|
|
105
146
|
name: "terreno-api-mcp",
|
|
@@ -120,7 +161,29 @@ const createMcpServerInstance = (tools: MCPToolDefinition[], user?: User): McpSe
|
|
|
120
161
|
description: tool.description,
|
|
121
162
|
inputSchema: tool.zodSchema,
|
|
122
163
|
},
|
|
123
|
-
async (args: unknown) =>
|
|
164
|
+
async (args: unknown) => {
|
|
165
|
+
if (!onToolCall) {
|
|
166
|
+
return tool.handler(args as Record<string, unknown>, user);
|
|
167
|
+
}
|
|
168
|
+
const startedAt = performance.now();
|
|
169
|
+
try {
|
|
170
|
+
const result = await tool.handler(args as Record<string, unknown>, user);
|
|
171
|
+
onToolCall({
|
|
172
|
+
durationMs: performance.now() - startedAt,
|
|
173
|
+
outcome: result.isError ? "tool_error" : "ok",
|
|
174
|
+
toolName: tool.name,
|
|
175
|
+
});
|
|
176
|
+
return result;
|
|
177
|
+
} catch (error) {
|
|
178
|
+
onToolCall({
|
|
179
|
+
durationMs: performance.now() - startedAt,
|
|
180
|
+
errorName: errorName(error),
|
|
181
|
+
outcome: "exception",
|
|
182
|
+
toolName: tool.name,
|
|
183
|
+
});
|
|
184
|
+
throw error;
|
|
185
|
+
}
|
|
186
|
+
}
|
|
124
187
|
);
|
|
125
188
|
}
|
|
126
189
|
|