-
Notifications
You must be signed in to change notification settings - Fork 125
Expand file tree
/
Copy pathenv.ts
More file actions
1600 lines (1467 loc) · 56.1 KB
/
env.ts
File metadata and controls
1600 lines (1467 loc) · 56.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import { AuthSupervisor } from "@cloudbase/toolbox";
import { z } from "zod";
import {
buildAuthConfigSummary,
buildDeviceAuthChallengePayload,
buildVerificationUriComplete,
ensureLogin,
getAuthConfigValidationError,
getAuthProgressState,
logout,
peekLoginState,
rejectAuthProgressState,
resolveAuthOptions,
resolveAuthProgressState,
setPendingAuthProgressState,
type AuthOptions,
type DeviceFlowAuthInfo,
} from "../auth.js";
import {
envManager,
getCachedEnvId,
getCloudBaseManager,
listAvailableEnvCandidates,
logCloudBaseResult,
resetCloudBaseManagerCache,
type EnvCandidate,
} from "../cloudbase-manager.js";
import { ExtendedMcpServer } from "../server.js";
import { debug } from "../utils/logger.js";
import {
buildAuthNextStep,
buildJsonToolResult,
toolPayloadErrorToResult,
} from "../utils/tool-result.js";
import {
checkAndCreateFreeEnv,
checkAndInitTcbService,
type EnvSetupContext,
} from "./env-setup.js";
/**
* Simplify environment list data by keeping only essential fields for AI assistant
* This reduces token consumption when returning environment lists via MCP tools
* @param envList - Full environment list from API
* @returns Simplified environment list with only essential fields
*/
export function simplifyEnvList(envList: any[]): any[] {
if (!Array.isArray(envList)) {
return envList;
}
return envList.map((env: any) => {
// Only keep essential fields that are useful for AI assistant
const simplified: any = {};
if (env.EnvId !== undefined) simplified.EnvId = env.EnvId;
if (env.Alias !== undefined) simplified.Alias = env.Alias;
if (env.Status !== undefined) simplified.Status = env.Status;
if (env.EnvType !== undefined) simplified.EnvType = env.EnvType;
if (env.Region !== undefined) simplified.Region = env.Region;
if (env.PackageId !== undefined) simplified.PackageId = env.PackageId;
if (env.PackageName !== undefined) simplified.PackageName = env.PackageName;
if (env.IsDefault !== undefined) simplified.IsDefault = env.IsDefault;
return simplified;
});
}
const DEFAULT_ENV_CANDIDATE_LIMIT = 20;
const DEFAULT_ENV_FIELDS = [
"EnvId",
"Alias",
"Status",
"EnvType",
"Region",
"PackageId",
"PackageName",
"IsDefault",
] as const;
type EnvFieldName = (typeof DEFAULT_ENV_FIELDS)[number];
function selectEnvFields(env: Record<string, any>, fields?: EnvFieldName[]) {
const selectedFields = fields && fields.length > 0 ? fields : DEFAULT_ENV_FIELDS;
const simplified: Record<string, any> = {};
for (const field of selectedFields) {
if (env[field] !== undefined) {
simplified[field] = env[field];
}
}
return simplified;
}
function filterEnvList(
envList: Record<string, any>[],
filters: { alias?: string; aliasExact?: boolean; envId?: string },
) {
const alias = filters.alias?.trim().toLowerCase();
const aliasExact = filters.aliasExact === true;
const envId = filters.envId?.trim().toLowerCase();
return envList.filter((env) => {
const normalizedAlias = String(env.Alias ?? "").toLowerCase();
const matchesAlias = alias
? aliasExact
? normalizedAlias === alias
: normalizedAlias.includes(alias)
: true;
const matchesEnvId = envId
? String(env.EnvId ?? "").toLowerCase() === envId
: true;
return matchesAlias && matchesEnvId;
});
}
function paginateEnvList(envList: Record<string, any>[], offset?: number, limit?: number) {
const safeOffset = Math.max(0, Math.floor(offset ?? 0));
const safeLimit = limit === undefined ? undefined : Math.max(1, Math.floor(limit));
const items =
safeLimit === undefined
? envList.slice(safeOffset)
: envList.slice(safeOffset, safeOffset + safeLimit);
return {
total: envList.length,
offset: safeOffset,
limit: safeLimit ?? envList.length,
items,
};
}
function buildEnvCandidatePayload(
envCandidates: EnvCandidate[],
limit = DEFAULT_ENV_CANDIDATE_LIMIT,
) {
const env_candidates = envCandidates.slice(0, limit);
return {
env_candidates,
env_candidates_summary: {
total: envCandidates.length,
returned: env_candidates.length,
truncated: envCandidates.length > env_candidates.length,
},
};
}
function buildLocalDevDomainHint() {
return {
format: "host:port",
useActualOrigin: true,
requiredValue: "当前浏览器实际访问 origin 对应的 host:port",
deriveFrom: ["浏览器地址栏中的当前 origin", "本地 dev server 实际启动输出"],
note:
"如果你的前端运行在自定义域名或本地开发端口上,请把当前浏览器实际访问地址对应的 host:port 加入安全域名。不要依赖一组固定默认端口,也不要假设已有 localhost/127.0.0.1 条目已经覆盖当前运行端口。",
};
}
function summarizeConfiguredLocalDevEntries(
domains: Array<{ Domain?: unknown }>,
) {
const localEntries = domains
.map((domain) => String(domain?.Domain ?? "").trim())
.filter((domain) => domain.startsWith("127.0.0.1:") || domain.startsWith("localhost:"));
return {
hasAnyConfiguredLocalEntry: localEntries.length > 0,
configuredEntries: localEntries,
};
}
function simplifyEnvDomains(domains: unknown) {
if (!Array.isArray(domains)) {
return domains;
}
return domains.map((domain) => {
if (!domain || typeof domain !== "object") {
return domain;
}
const source = domain as Record<string, unknown>;
return {
...(source.Domain !== undefined ? { Domain: source.Domain } : {}),
...(source.Status !== undefined ? { Status: source.Status } : {}),
...(source.Type !== undefined ? { Type: source.Type } : {}),
};
});
}
function buildEnvDomainManagementResult(params: {
action: "create" | "delete";
domains: string[];
result: unknown;
}) {
const { action, domains, result } = params;
const rawResult =
result && typeof result === "object" && !Array.isArray(result)
? (result as Record<string, unknown>)
: { result };
if (action === "create") {
return {
...rawResult,
ok: true,
code: "DOMAIN_UPDATE_PENDING",
operation: action,
targetDomains: domains,
asyncState: "PENDING",
message:
'安全域名已提交添加请求。该变更通常需要约 10 分钟传播,请继续轮询 envQuery(action="domains"),直到目标域名状态为 ENABLE。',
propagation: {
requiresPolling: true,
pollTool: "envQuery",
pollAction: "domains",
pollIntervalSuggestionSeconds: 10,
timeoutSuggestionSeconds: 600,
successCondition:
'目标域名出现在 envQuery(action="domains") 返回中,且 Status 为 ENABLE。',
},
next_step: {
tool: "envQuery",
action: "domains",
suggested_args: {
action: "domains",
},
},
};
}
return {
...rawResult,
ok: true,
code: "DOMAIN_DELETE_PENDING",
operation: action,
targetDomains: domains,
asyncState: "PENDING",
message:
'安全域名已提交删除请求。该变更可能需要数分钟传播,请继续轮询 envQuery(action="domains"),直到目标域名不再出现。',
propagation: {
requiresPolling: true,
pollTool: "envQuery",
pollAction: "domains",
pollIntervalSuggestionSeconds: 10,
timeoutSuggestionSeconds: 600,
successCondition:
'目标域名不再出现在 envQuery(action="domains") 返回中。',
},
next_step: {
tool: "envQuery",
action: "domains",
suggested_args: {
action: "domains",
},
},
};
}
function formatDeviceAuthHint(deviceAuthInfo?: DeviceFlowAuthInfo): string {
if (!deviceAuthInfo) {
return "";
}
const verificationUriComplete = buildVerificationUriComplete(deviceAuthInfo);
const lines = [
"",
"### Device Flow 授权信息",
`- user_code: ${deviceAuthInfo.user_code}`,
];
if (deviceAuthInfo.verification_uri) {
lines.push(`- verification_uri: ${deviceAuthInfo.verification_uri}`);
}
if (verificationUriComplete) {
lines.push(`- verification_uri_complete: ${verificationUriComplete}`);
}
lines.push(`- expires_in: ${deviceAuthInfo.expires_in}s`);
lines.push(
"",
"请优先向用户展示完整的 `verification_uri_complete`,不要截断或改写 URL。",
);
return lines.join("\n");
}
function emitDeviceAuthNotice(server: ExtendedMcpServer, deviceAuthInfo: DeviceFlowAuthInfo): void {
// Temporarily disabled: avoid sending logging notifications for device auth
}
async function fetchAvailableEnvCandidates(
cloudBaseOptions: any,
server: ExtendedMcpServer,
): Promise<EnvCandidate[]> {
try {
return await listAvailableEnvCandidates({
cloudBaseOptions,
});
} catch {
return [];
}
}
type AuthAction =
| "status"
| "start_auth"
| "set_env"
| "logout"
| "get_temp_credentials";
const CODEBUDDY_AUTH_ACTIONS = ["status", "set_env"] as const;
const DEFAULT_AUTH_ACTIONS = [
"status",
"start_auth",
"set_env",
"logout",
"get_temp_credentials",
] as const;
function maskSensitiveValue(value: string): string {
if (value.length <= 4) {
return "*".repeat(value.length);
}
return `${value.slice(0, 2)}******${value.slice(-2)}`;
}
function isTemporaryCredentialLoginState(loginState: Record<string, unknown>): boolean {
const refreshToken = normalizeOptionalToolString(loginState.refreshToken);
const token = normalizeOptionalToolString(loginState.token);
const accessTokenExpired =
typeof loginState.accessTokenExpired === "number" ||
typeof loginState.accessTokenExpired === "string";
return Boolean(token && (refreshToken || accessTokenExpired));
}
function getCurrentIde(server: ExtendedMcpServer): string {
return server.ide || process.env.INTEGRATION_IDE || "";
}
function isCodeBuddyIde(server: ExtendedMcpServer): boolean {
return getCurrentIde(server) === "CodeBuddy";
}
function getSupportedAuthActions(server: ExtendedMcpServer): readonly AuthAction[] {
return isCodeBuddyIde(server) ? CODEBUDDY_AUTH_ACTIONS : DEFAULT_AUTH_ACTIONS;
}
function buildAuthRequiredNextStep(server: ExtendedMcpServer) {
if (isCodeBuddyIde(server)) {
return buildAuthNextStep("status", {
suggestedArgs: { action: "status" },
});
}
return buildAuthNextStep("start_auth", {
suggestedArgs: { action: "start_auth", authMode: "device" },
});
}
function buildSetEnvNextStep(envCandidates: EnvCandidate[]) {
const singleEnvId = envCandidates.length === 1 ? envCandidates[0].envId : undefined;
return buildAuthNextStep("set_env", {
requiredParams: singleEnvId ? undefined : ["envId"],
suggestedArgs: singleEnvId
? { action: "set_env", envId: singleEnvId }
: { action: "set_env" },
});
}
type AuthEnvSetupStatus =
| "NOT_NEEDED"
| "AUTO_BOUND"
| "AUTO_CREATED"
| "SELECTION_REQUIRED"
| "ACTION_REQUIRED";
type AuthEnvSetupFailure = {
reason: string;
error_code: string;
message: string;
help_url?: string;
need_real_name_auth?: boolean;
need_cam_auth?: boolean;
};
type AuthEnvPreparationResult = {
currentEnvId: string | null;
envStatus: "READY" | "MULTIPLE" | "NONE";
envCandidates: EnvCandidate[];
envSetupStatus: AuthEnvSetupStatus;
envSetupActions: string[];
envSetupFailure?: AuthEnvSetupFailure;
message: string;
nextStep: ReturnType<typeof buildAuthNextStep>;
};
function dedupeActions(actions: string[]) {
return actions.filter((action, index) => actions.indexOf(action) === index);
}
function buildAuthEnvSetupFailure(params: {
reason: string;
errorCode: string;
message: string;
helpUrl?: string;
needRealNameAuth?: boolean;
needCamAuth?: boolean;
}): AuthEnvSetupFailure {
return {
reason: params.reason,
error_code: params.errorCode,
message: params.message,
help_url: params.helpUrl,
need_real_name_auth: params.needRealNameAuth,
need_cam_auth: params.needCamAuth,
};
}
function buildAuthEnvSetupPayload(preparation: AuthEnvPreparationResult) {
return {
current_env_id: preparation.currentEnvId,
env_status: preparation.envStatus,
env_setup_status: preparation.envSetupStatus,
env_setup_actions: preparation.envSetupActions,
...(preparation.envSetupFailure
? {
env_setup_failure: preparation.envSetupFailure,
}
: {}),
...buildEnvCandidatePayload(preparation.envCandidates),
};
}
async function prepareAuthEnvironment(params: {
server: ExtendedMcpServer;
cloudBaseOptions: any;
loginState: any;
}): Promise<AuthEnvPreparationResult> {
const { server, cloudBaseOptions, loginState } = params;
const currentEnvId =
getCachedEnvId() ||
process.env.CLOUDBASE_ENV_ID ||
(typeof loginState?.envId === "string" && loginState.envId.length > 0
? loginState.envId
: null);
if (currentEnvId) {
return {
currentEnvId,
envStatus: "READY",
envCandidates: [],
envSetupStatus: "NOT_NEEDED",
envSetupActions: [],
message: `当前已登录,环境: ${currentEnvId}`,
nextStep: buildAuthNextStep("status", {
suggestedArgs: { action: "status" },
}),
};
}
const envSetupActions = ["list_envs"];
const envCandidates = await fetchAvailableEnvCandidates(cloudBaseOptions, server);
if (envCandidates.length === 1) {
const singleEnvId = envCandidates[0].envId;
await envManager.setEnvId(singleEnvId);
return {
currentEnvId: singleEnvId,
envStatus: "READY",
envCandidates,
envSetupStatus: "AUTO_BOUND",
envSetupActions: dedupeActions(envSetupActions),
message: `当前已登录,已自动绑定唯一环境: ${singleEnvId}`,
nextStep: buildAuthNextStep("status", {
suggestedArgs: { action: "status" },
}),
};
}
if (envCandidates.length > 1) {
return {
currentEnvId: null,
envStatus: "MULTIPLE",
envCandidates,
envSetupStatus: "SELECTION_REQUIRED",
envSetupActions: dedupeActions(envSetupActions),
message: "当前已登录,但存在多个可用环境,请先选择环境。",
nextStep: buildSetEnvNextStep(envCandidates),
};
}
let setupContext: EnvSetupContext = {};
const manager = await getCloudBaseManager({
requireEnvId: false,
cloudBaseOptions: cloudBaseOptions
? {
...cloudBaseOptions,
envId: undefined,
}
: undefined,
mcpServer: server,
});
setupContext = await checkAndInitTcbService(manager, setupContext);
if (setupContext.checkTcbServiceAttempted) {
envSetupActions.push("check_tcb_service");
}
if (setupContext.initTcbAttempted) {
envSetupActions.push("init_tcb");
}
if (setupContext.initTcbError || !setupContext.tcbServiceInitialized) {
const failure = setupContext.initTcbError
? buildAuthEnvSetupFailure({
reason: "tcb_init_failed",
errorCode: setupContext.initTcbError.code || "TCB_INIT_FAILED",
message: setupContext.initTcbError.message,
helpUrl: setupContext.initTcbError.helpUrl,
needRealNameAuth: setupContext.initTcbError.needRealNameAuth,
needCamAuth: setupContext.initTcbError.needCamAuth,
})
: buildAuthEnvSetupFailure({
reason: "tcb_init_failed",
errorCode: "TCB_INIT_FAILED",
message: "CloudBase 服务初始化失败,请稍后重试。",
helpUrl: "https://buy.cloud.tencent.com/lowcode?buyType=tcb&channel=mcp",
});
return {
currentEnvId: null,
envStatus: "NONE",
envCandidates: [],
envSetupStatus: "ACTION_REQUIRED",
envSetupActions: dedupeActions(envSetupActions),
envSetupFailure: failure,
message: failure.message,
nextStep: buildAuthNextStep("status", {
suggestedArgs: { action: "status" },
}),
};
}
const createResult = await checkAndCreateFreeEnv(manager, setupContext);
setupContext = createResult.context;
if (setupContext.promotionalActivitiesChecked) {
envSetupActions.push("check_promotional_activity");
}
if (setupContext.createFreeEnvAttempted) {
envSetupActions.push("create_free_env");
}
if (createResult.success && createResult.envId) {
await envManager.setEnvId(createResult.envId);
return {
currentEnvId: createResult.envId,
envStatus: "READY",
envCandidates: [],
envSetupStatus: "AUTO_CREATED",
envSetupActions: dedupeActions(envSetupActions),
message: `当前已登录,已自动创建并绑定环境: ${createResult.envId}`,
nextStep: buildAuthNextStep("status", {
suggestedArgs: { action: "status" },
}),
};
}
const createFailure = setupContext.createEnvError
? buildAuthEnvSetupFailure({
reason: "env_creation_failed",
errorCode: setupContext.createEnvError.code || "ENV_CREATION_FAILED",
message: setupContext.createEnvError.message,
helpUrl: setupContext.createEnvError.helpUrl,
})
: buildAuthEnvSetupFailure({
reason: "env_creation_failed",
errorCode: "ENV_CREATION_FAILED",
message: "环境创建失败,请稍后重试或手动创建环境。",
helpUrl: "https://buy.cloud.tencent.com/lowcode?buyType=tcb&channel=mcp",
});
return {
currentEnvId: null,
envStatus: "NONE",
envCandidates: [],
envSetupStatus: "ACTION_REQUIRED",
envSetupActions: dedupeActions(envSetupActions),
envSetupFailure: createFailure,
message: createFailure.message,
nextStep: buildAuthNextStep("status", {
suggestedArgs: { action: "status" },
}),
};
}
function buildEnvQueryListResult(params: {
result: any;
cloudBaseOptions: any;
hasEnvId: boolean;
filters: {
alias?: string;
aliasExact?: boolean;
envId?: string;
limit?: number;
offset?: number;
fields?: EnvFieldName[];
};
}) {
const envList = Array.isArray(params.result?.EnvList) ? params.result.EnvList : [];
const shouldRestrictToCurrentEnv =
params.hasEnvId && !params.filters.alias && !params.filters.envId;
const baseList = shouldRestrictToCurrentEnv
? envList.filter((env: any) => env.EnvId === params.cloudBaseOptions?.envId)
: envList;
const filteredList = filterEnvList(baseList, {
alias: params.filters.alias,
aliasExact: params.filters.aliasExact,
envId: params.filters.envId,
});
const paginated = paginateEnvList(filteredList, params.filters.offset, params.filters.limit);
const exactEnvIdSummaryHint = params.filters.envId
? {
tool: "envQuery",
action: "info",
reason:
"action=list with envId only returns a concise summary. Use action=info to fetch detailed environment information such as full resource metadata and additional environment details.",
}
: undefined;
return {
EnvList: paginated.items.map((env) => selectEnvFields(env, params.filters.fields)),
TotalCount: paginated.total,
Offset: paginated.offset,
Limit: paginated.limit,
HasMore: paginated.offset + paginated.items.length < paginated.total,
AppliedFilters: {
alias: params.filters.alias ?? null,
aliasExact: params.filters.aliasExact ?? null,
envId: params.filters.envId ?? null,
fields: params.filters.fields ?? [...DEFAULT_ENV_FIELDS],
currentEnvOnly: shouldRestrictToCurrentEnv,
},
...(exactEnvIdSummaryHint
? {
RecommendedNextAction: exactEnvIdSummaryHint,
}
: {}),
};
}
async function enrichEnvInfoWithBilling(params: {
manager: any;
result: any;
envId?: string;
logger?: any;
}) {
const targetEnvId =
params.envId ||
params.result?.EnvInfo?.EnvId;
if (!targetEnvId || !params.result?.EnvInfo) {
return params.result;
}
try {
const billingResult = await params.manager.commonService("tcb", "2018-06-08").call({
Action: "DescribeBillingInfo",
Param: {
EnvId: targetEnvId,
},
});
logCloudBaseResult(params.logger, billingResult);
const billingList =
billingResult?.EnvBillingInfoList ||
billingResult?.Response?.EnvBillingInfoList ||
billingResult?.Data?.EnvBillingInfoList ||
[];
const matchedBillingInfo = Array.isArray(billingList)
? billingList.find((item: any) => item?.EnvId === targetEnvId) ?? billingList[0]
: undefined;
if (!matchedBillingInfo) {
return params.result;
}
return {
...params.result,
EnvInfo: {
...params.result.EnvInfo,
BillingInfo: matchedBillingInfo,
},
};
} catch (billingError) {
debug("DescribeBillingInfo enrichment failed, continuing without billing info", {
error: billingError,
envId: targetEnvId,
});
return params.result;
}
}
function normalizeOptionalToolString(value: unknown) {
return typeof value === "string" && value.trim().length > 0
? value.trim()
: undefined;
}
/**
* Build enhanced error message for envQuery tool errors
* Provides actionable guidance based on error patterns
*/
function buildEnvQueryErrorMessage(error: unknown, action: string): string {
const baseMessage = error instanceof Error ? error.message : String(error);
// Check for common error patterns and provide specific guidance
const hasInvalidParameterError = /400|invalid parameter|invalid argument|parameter value/i.test(baseMessage);
const hasAuthError = /未登录|auth required|unauthorized|authentication|credential|token|secret/i.test(baseMessage);
const hasNetworkError = /ECONNRESET|socket hang up|ETIMEDOUT|ENOTFOUND|timeout/i.test(baseMessage);
const hasPermissionError = /permission|denied|forbidden|无权|拒绝/i.test(baseMessage);
const hasEnvNotFoundError = /env|environment|环境.*不存在|not found/i.test(baseMessage);
const suggestions: string[] = [];
if (hasInvalidParameterError) {
suggestions.push("参数错误:可能是认证信息无效或已过期,请尝试以下步骤:");
suggestions.push("1. 先调用 auth(action=\"status\") 检查当前登录状态");
suggestions.push("2. 如果未登录,调用 auth(action=\"start_auth\", authMode=\"device\") 完成登录");
suggestions.push("3. 登录完成后再次调用 envQuery(action=\"list\")");
}
if (hasAuthError) {
suggestions.push("认证错误:当前未登录或认证已过期。");
suggestions.push("建议先执行 auth(action=\"status\") 查看状态,然后按提示完成登录。");
}
if (hasPermissionError) {
suggestions.push("权限错误:当前账号可能没有访问该资源的权限。");
suggestions.push("请确认:1) 已选择正确的环境 2) 账号有对应权限");
}
if (hasEnvNotFoundError) {
suggestions.push("环境错误:指定的环境不存在或无法访问。");
suggestions.push("请使用 envQuery(action=\"list\") 查看可用的环境列表。");
}
if (hasNetworkError) {
suggestions.push("网络错误:请检查网络连接,稍后重试。");
}
// If no specific pattern matched, provide general guidance
if (suggestions.length === 0) {
suggestions.push("查询环境信息时出错,建议:");
suggestions.push("1. 先调用 auth(action=\"status\") 确认登录状态");
suggestions.push("2. 如未登录,执行 auth(action=\"start_auth\") 完成认证");
suggestions.push("3. 确认环境 ID 正确且可访问");
}
return `[envQuery/${action}] 调用失败: ${baseMessage}\n\n解决建议:\n${suggestions.join("\n")}`;
}
function normalizeOptionalToolBoolean(value: unknown) {
return typeof value === "boolean" ? value : undefined;
}
function resolveToolAuthOptions(
server: ExtendedMcpServer,
overrides?: AuthOptions,
) {
return resolveAuthOptions({
...overrides,
serverAuthOptions: server.authOptions,
});
}
export function registerEnvTools(server: ExtendedMcpServer) {
// 获取 cloudBaseOptions,如果没有则为 undefined
const cloudBaseOptions = server.cloudBaseOptions;
const getManager = () => getCloudBaseManager({ cloudBaseOptions, mcpServer: server });
const getManagerForEnvQuery = (targetEnvId?: string, requireEnvId = true) =>
getCloudBaseManager({
cloudBaseOptions:
targetEnvId && targetEnvId !== cloudBaseOptions?.envId
? {
...cloudBaseOptions,
envId: targetEnvId,
}
: cloudBaseOptions,
requireEnvId,
mcpServer: server,
});
const hasEnvId = typeof cloudBaseOptions?.envId === 'string' && cloudBaseOptions?.envId.length > 0;
const supportedAuthActions = getSupportedAuthActions(server);
const authActionEnum = [...supportedAuthActions] as [AuthAction, ...AuthAction[]];
// auth - CloudBase (云开发) 开发阶段登录与环境绑定
server.registerTool?.(
"auth",
{
title: "CloudBase 开发阶段登录与环境",
description:
"CloudBase(腾讯云开发)开发阶段登录与环境绑定。登录后即可访问云资源;环境(env)是云函数、数据库、静态托管等资源的隔离单元,绑定环境后其他 MCP 工具才能操作该环境。支持:查询状态、发起登录、绑定环境(set_env)、退出登录。",
inputSchema: {
action: z
.enum(authActionEnum)
.optional()
.describe(
"动作:status=查询状态,start_auth=发起登录,set_env=绑定环境(传envId),logout=退出登录",
),
...(supportedAuthActions.includes("start_auth")
? {
authMode: z
.enum(["device", "web"])
.optional()
.describe("认证模式:device=设备码授权,web=浏览器回调授权"),
oauthEndpoint: z
.string()
.optional()
.describe("高级可选:自定义 device-code 登录 endpoint。配置后 oauthCustom 默认按 true 处理"),
clientId: z
.string()
.optional()
.describe("高级可选:自定义 device-code 登录 client_id,不传则使用默认值"),
oauthCustom: z
.boolean()
.optional()
.describe("高级可选:自定义 endpoint 返回格式开关。未配置 endpoint 时默认 false;配置 endpoint 后默认 true,且不能设为 false"),
}
: {}),
envId: z
.string()
.optional()
.describe("环境ID(CloudBase 环境唯一标识),绑定后工具将操作该环境。action=set_env 时必填"),
...(supportedAuthActions.includes("logout")
? {
confirm: z
.literal("yes")
.optional()
.describe("action=logout 时确认操作,传 yes"),
}
: {}),
...(supportedAuthActions.includes("get_temp_credentials")
? {
reveal: z
.boolean()
.optional()
.describe("action=get_temp_credentials 时可选。true=返回明文临时密钥;默认 false 仅返回脱敏结果"),
}
: {}),
},
annotations: {
readOnlyHint: false,
destructiveHint: false,
idempotentHint: false,
openWorldHint: true,
category: "env",
},
},
async (rawArgs: {
action?: AuthAction;
authMode?: unknown;
oauthEndpoint?: unknown;
clientId?: unknown;
oauthCustom?: unknown;
envId?: string;
confirm?: unknown;
reveal?: unknown;
}) => {
const action = rawArgs.action ?? "status";
const authMode =
rawArgs.authMode === "device" || rawArgs.authMode === "web"
? rawArgs.authMode
: undefined;
const oauthEndpoint = normalizeOptionalToolString(rawArgs.oauthEndpoint);
const clientId = normalizeOptionalToolString(rawArgs.clientId);
const oauthCustom = normalizeOptionalToolBoolean(rawArgs.oauthCustom);
const envId = rawArgs.envId;
const confirm = rawArgs.confirm === "yes" ? "yes" : undefined;
const reveal = normalizeOptionalToolBoolean(rawArgs.reveal) === true;
const resolvedAuthOptions = resolveToolAuthOptions(server, {
authMode,
oauthEndpoint,
clientId,
oauthCustom,
});
const authConfigSummary = buildAuthConfigSummary(resolvedAuthOptions);
let deviceAuthInfo: DeviceFlowAuthInfo | undefined;
const onDeviceCode = (info: DeviceFlowAuthInfo) => {
deviceAuthInfo = info;
setPendingAuthProgressState(info, "device");
// emitDeviceAuthNotice(server, info);
};
const authChallenge = () => buildDeviceAuthChallengePayload(deviceAuthInfo);
try {
if (!supportedAuthActions.includes(action)) {
return buildJsonToolResult({
ok: false,
code: "NOT_SUPPORTED",
message: `当前 IDE 不支持 auth(action="${action}")。`,
next_step: buildAuthNextStep("status", {
suggestedArgs: { action: "status" },
}),
});
}
if (action === "status") {
const loginState = await peekLoginState();
const authFlowState = await getAuthProgressState();
const authStatus = loginState
? "READY"
: authFlowState.status === "PENDING"
? "PENDING"
: "REQUIRED";
let envPreparation:
| AuthEnvPreparationResult
| undefined;
const message =
authStatus === "READY"
? undefined
: authStatus === "PENDING"
? "设备码授权进行中,请完成浏览器授权后再次调用 auth(action=\"status\")"
: isCodeBuddyIde(server)
? "当前未登录。CodeBuddy 暂不支持在 tool 内发起认证,请在外部完成认证后再次调用 auth(action=\"status\")。"
: "当前未登录,请先执行 auth(action=\"start_auth\")";
if (authStatus === "READY" && loginState) {
envPreparation = await prepareAuthEnvironment({
server,
cloudBaseOptions,
loginState,
});
}
return buildJsonToolResult({
ok: true,
code: "STATUS",
auth_status: authStatus,
auth_config: authConfigSummary,
...(envPreparation
? buildAuthEnvSetupPayload(envPreparation)
: {
env_status: "NONE",
current_env_id: null,
...buildEnvCandidatePayload([]),
}),
auth_challenge:
authFlowState.status === "PENDING"
? buildDeviceAuthChallengePayload(authFlowState.authChallenge)
: undefined,
message,
next_step:
authStatus === "REQUIRED"
? buildAuthRequiredNextStep(server)
: authStatus === "PENDING"
? buildAuthNextStep("status", {
suggestedArgs: { action: "status" },
})
: envPreparation?.nextStep,
});
}
if (action === "start_auth") {
const region = server.cloudBaseOptions?.region || process.env.TCB_REGION;
const auth = AuthSupervisor.getInstance({});
const authFlowState = await getAuthProgressState();
if (authFlowState.status === "PENDING" && authFlowState.authChallenge) {
return buildJsonToolResult({
ok: true,
code: "AUTH_PENDING",
message:
"设备码授权进行中,请在浏览器中打开 verification_uri 并输入 user_code 完成授权。",
auth_challenge: buildDeviceAuthChallengePayload(
authFlowState.authChallenge,
),
next_step: buildAuthNextStep("status", {
suggestedArgs: { action: "status" },
}),
});
}
// 1. 如果已经有登录态,直接返回 AUTH_READY
try {
const existingLoginState = await peekLoginState();
if (existingLoginState) {
const envPreparation = await prepareAuthEnvironment({
server,
cloudBaseOptions,
loginState: existingLoginState,
});
return buildJsonToolResult({
ok: true,
code: "AUTH_READY",