@cloudbase/cloudbase-mcp 2.21.1 → 2.22.0-beta.0

package/dist/index.d.ts

@@ -13,7 +13,24 @@ export declare interface AuthOptions {
     oauthCustom?: boolean;
 }
 
-export declare type CloudBaseOptions = NonNullable<ConstructorParameters<typeof CloudBase>[0]>;
+/**
+ * 自定义 API 请求函数，由外部注入，替代 TC3 签名发请求。
+ * 入参对齐 CAPI 模式：service + action + version + region + payload。
+ * 返回腾讯云 API 响应中 Response 字段的内容（已解包）。
+ */
+export declare type CloudApiRequestFn = (params: {
+    service: string;
+    action: string;
+    version: string;
+    region: string;
+    payload: Record<string, any>;
+}) => Promise<any>;
+
+declare type CloudBaseConfigBase = NonNullable<ConstructorParameters<typeof CloudBase>[0]>;
+
+export declare type CloudBaseOptions = CloudBaseConfigBase & {
+    requestFn?: CloudApiRequestFn;
+};
 
 /**
  * Create a manager with the provided CloudBase options, without using cache
@@ -53,6 +70,7 @@ export declare function createCloudBaseMcpServer(options?: {
     logger?: Logger;
     pluginsEnabled?: string[];
     pluginsDisabled?: string[];
+    pluginOptions?: PluginOptions;
 }): Promise<ExtendedMcpServer>;
 
 export declare interface DataModel {
@@ -141,11 +159,50 @@ export declare interface ExtendedMcpServer extends McpServer {
     authOptions?: AuthOptions;
     ide?: string;
     logger?: Logger;
+    pgRuntimeContext?: PgRuntimeContext;
+    enabledPlugins?: string[];
+    pluginOptions?: PluginOptions;
+    /** 已注册工具的列表，供外部（如微信 IDE）提取并注册到自己的 MCP server */
+    toolDefs: Array<{
+        name: string;
+        description: string;
+        inputSchema: any;
+        handler: (input: any) => Promise<any>;
+    }>;
     setLogger(logger: Logger): void;
 }
 
 export declare function formatRuntimeList(): string;
 
+/**
+ * manageFunctions 工具中部分 action 的 override 钩子
+ * 参数使用 CloudBase 领域语言，与 MCP 内部 DTO 解耦
+ * 实现方（如微信 IDE）负责在内部做参数适配
+ *
+ * - createFunction / updateFunctionCode：有默认实现，override 后可走外部专有接口
+ * - incrementalDeployFunction：无默认实现，必须通过 pluginOptions 注入
+ */
+export declare interface FunctionDeployOverrides {
+    createFunction?: (params: {
+        functionName: string;
+        functionRootPath: string;
+        runtime?: string;
+        force?: boolean;
+        installDependency?: boolean;
+    }) => Promise<any>;
+    updateFunctionCode?: (params: {
+        functionName: string;
+        functionRootPath: string;
+        force?: boolean;
+        installDependency?: boolean;
+    }) => Promise<any>;
+    incrementalDeployFunction?: (params: {
+        functionName: string;
+        functionRootPath: string;
+        incrementalFile: string;
+    }) => Promise<any>;
+}
+
 /**
  * 每次都实时获取最新的 token/secretId/secretKey
  */
@@ -276,6 +333,23 @@ export declare function logout(): Promise<void>;
 
 export { McpServer }
 
+declare interface PgRuntimeContext {
+    envId: string;
+    instanceId: string;
+    defaultSchema: string;
+    runtimeMode: "cloudbase-manager";
+    bootstrapMode: "cloud";
+    role?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+
+/** 各插件的可选配置 */
+export declare interface PluginOptions {
+    functions?: FunctionDeployOverrides;
+    storage?: StorageOverrides;
+}
+
 export declare const RAW_IDE_FILE_MAPPINGS: Record<string, IdeFileDescriptor[]>;
 
 export declare const RECOMMENDED_RUNTIMES: {
@@ -325,6 +399,64 @@ export declare function simplifyEnvList(envList: any[]): any[];
 
 export { StdioServerTransport }
 
+/**
+ * 存储工具中需要 COS SDK 操作的 override 钩子
+ * 实现方（如微信 IDE）负责在内部通过 /route/getcosauth 获取临时签名并操作 COS
+ *
+ * - listFiles / getFileInfo / downloadFile：queryStorage 只读操作
+ * - uploadFile / deleteFiles / deleteDirectory：manageStorage 写操作
+ * - getFileUrl：获取文件临时下载链接（可选，未提供时使用 CAPI 默认实现）
+ */
+declare interface StorageOverrides {
+    /** 列出目录下的文件，替代 storageService.listDirectoryFiles() */
+    listFiles?: (params: {
+        cloudPath: string;
+    }) => Promise<Array<Record<string, any>>>;
+    /** 获取文件元信息，替代 storageService.getFileInfo() */
+    getFileInfo?: (params: {
+        cloudPath: string;
+    }) => Promise<Record<string, any>>;
+    /** 下载文件到本地，替代 storageService.downloadFile() */
+    downloadFile?: (params: {
+        cloudPath: string;
+        localPath: string;
+    }) => Promise<void>;
+    /** 下载目录到本地，替代 storageService.downloadDirectory() */
+    downloadDirectory?: (params: {
+        cloudPath: string;
+        localPath: string;
+    }) => Promise<void>;
+    /** 上传单个文件，替代 storageService.uploadFile() */
+    uploadFile?: (params: {
+        localPath: string;
+        cloudPath: string;
+    }) => Promise<void>;
+    /** 上传目录，替代 storageService.uploadDirectory() */
+    uploadDirectory?: (params: {
+        localPath: string;
+        cloudPath: string;
+    }) => Promise<void>;
+    /**
+     * 获取文件临时下载链接，替代 storageService.getTemporaryUrl()
+     * 可通过 COS getObjectUrl 实现；未提供时走 manager-node 默认路径
+     */
+    getFileUrl?: (params: {
+        cloudPath: string;
+        maxAge?: number;
+    }) => Promise<{
+        url: string;
+        fileId?: string;
+    }>;
+    /** 删除文件（支持批量），替代 storageService.deleteFile() */
+    deleteFiles?: (params: {
+        cloudPaths: string[];
+    }) => Promise<void>;
+    /** 删除目录，替代 storageService.deleteDirectory() */
+    deleteDirectory?: (params: {
+        cloudPath: string;
+    }) => Promise<void>;
+}
+
 export declare const SUPPORTED_NODEJS_RUNTIMES: readonly ["Nodejs20.19", "Nodejs18.15", "Nodejs16.13", "Nodejs14.18", "Nodejs12.16", "Nodejs10.15", "Nodejs8.9"];
 
 export declare const SUPPORTED_RUNTIMES: {