@kortex-app/api 0.0.1-next.202511272106-5d30d1b8e → 0.0.1-next.202511280950-b58418c7c

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kortex-app/api",
-  "version": "0.0.1-next.202511272106-5d30d1b8e",
+  "version": "0.0.1-next.202511280950-b58418c7c",
   "description": "API for Kortex extensions",
   "repository": "https://github.com/kortex-hub/kortex",
   "publishConfig": {

package/src/extension-api.d.ts

@@ -41,6 +41,7 @@
 
 declare module '@kortex-app/api' {
   import type { ProviderV2 as AISDKInferenceProvider } from '@ai-sdk/provider';
+  import type { components } from '@kortex-hub/mcp-registry-types';
 
   /**
    * The version of Kortex.
@@ -650,16 +651,78 @@ declare module '@kortex-app/api' {
     models: Array<InferenceModel>;
   };
 
+  export interface InputResponse {
+    value: string;
+  }
+
+  export interface InputWithVariableResponse extends InputResponse {
+    variables: Record<string, InputResponse>;
+  }
+
+  export interface MCPRemoteServerConfig {
+    type: 'remote';
+    index: number;
+    headers: Record<string, InputWithVariableResponse>;
+  }
+
+  export interface MCPPackageServerConfig {
+    type: 'package';
+    index: number;
+    runtimeArguments: Record<number, InputWithVariableResponse>;
+    packageArguments: Record<number, InputWithVariableResponse>;
+    environmentVariables: Record<string, InputWithVariableResponse>;
+  }
+
+  export type MCPServerConfig = MCPRemoteServerConfig | MCPPackageServerConfig;
+
+  export type MCPServerDetail = components['schemas']['ServerDetail'];
+
+  export type MCPServer = {
+    serverId: string;
+    config: MCPServerConfig;
+  };
+
+  export type RegisterServerResult = Disposable & { serverId: string };
+
+  export type RagProviderConnection = {
+    name: string;
+    mcpServer: MCPServer;
+    index(doc: Uri, chunks: Uri[]): Promise<void>;
+    deindex(doc: Uri): Promise<void>;
+    lifecycle?: ProviderConnectionLifecycle;
+    status(): ProviderConnectionStatus;
+  };
+
+  export type Chunk = {
+    text: Uri;
+  };
+
+  export type ChunkProvider = {
+    name: string;
+    chunk(doc: Uri): Promise<Chunk[]>;
+  };
+
   export interface ProviderInferenceConnection {
     providerId: string;
     connection: InferenceProviderConnection;
   }
 
+  export interface ProviderRagConnection {
+    providerId: string;
+    connection: RagProviderConnection;
+  }
+
+  export interface ProviderChunkerConnection {
+    providerId: string;
+    connection: ChunkProvider;
+  }
+
   export type ProviderConnection =
     | ContainerProviderConnection
     | KubernetesProviderConnection
     | VmProviderConnection
     | InferenceProviderConnection
+    | RagProviderConnection
     | FlowProviderConnection;
 
   // common set of options for creating a provider
@@ -686,6 +749,12 @@ declare module '@kortex-app/api' {
     create(params: { [key: string]: any }, logger?: Logger, token?: CancellationToken): Promise<void>;
   }
 
+  // create programmatically a RagProviderConnection
+  export interface RagProviderConnectionFactory extends ProviderConnectionFactory {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    create(params: { [key: string]: any }, logger?: Logger, token?: CancellationToken): Promise<void>;
+  }
+
   // create a kubernetes provider
   export interface KubernetesProviderConnectionFactory extends ProviderConnectionFactory {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -883,10 +952,16 @@ declare module '@kortex-app/api' {
       connectionAuditor?: Auditor,
     ): Disposable;
 
+    setRagProviderConnectionFactory(
+      ragProviderConnectionFactory: RagProviderConnectionFactory,
+      connectionAuditor?: Auditor,
+    ): Disposable;
+
     registerContainerProviderConnection(connection: ContainerProviderConnection): Disposable;
     registerKubernetesProviderConnection(connection: KubernetesProviderConnection): Disposable;
     registerVmProviderConnection(connection: VmProviderConnection): Disposable;
     registerInferenceProviderConnection(connection: InferenceProviderConnection): Disposable;
+    registerRagProviderConnection(connection: RagProviderConnection): Disposable;
 
     registerFlowProviderConnection(connection: FlowProviderConnection): Disposable;
 
@@ -1038,6 +1113,18 @@ declare module '@kortex-app/api' {
   export interface UnregisterInferenceConnectionEvent {
     providerId: string;
   }
+  export interface RegisterRagConnectionEvent {
+    providerId: string;
+  }
+  export interface UnregisterRagConnectionEvent {
+    providerId: string;
+  }
+  export interface RegisterChunkerConnectionEvent {
+    providerId: string;
+  }
+  export interface UnregisterChunkerConnectionEvent {
+    providerId: string;
+  }
 
   export interface RegisterFlowConnectionEvent {
     providerId: string;
@@ -1243,6 +1330,7 @@ declare module '@kortex-app/api' {
     export const onDidRegisterContainerConnection: Event<RegisterContainerConnectionEvent>;
     export function getContainerConnections(): ProviderContainerConnection[];
     export function getInferenceConnections(): ProviderInferenceConnection[];
+    export function getRagConnections(): ProviderRagConnection[];
     /**
      * It returns the lifecycle context for the provider connection.
      * If no context is found it throws an error
@@ -1444,6 +1532,9 @@ declare module '@kortex-app/api' {
     export const onDidRegisterRegistry: Event<MCPRegistry>;
     export const onDidUpdateRegistry: Event<MCPRegistry>;
     export const onDidUnregisterRegistry: Event<MCPRegistry>;
+
+    export function registerServer(server: MCPServerDetail): RegisterServerResult;
+    export function unregisterServer(serverId: string): void;
   }
 
   export namespace tray {
@@ -5247,4 +5338,8 @@ declare module '@kortex-app/api' {
      */
     constructor(url: string);
   }
+
+  export namespace rag {
+    export function registerChunkProvider(provider: ChunkProvider): Disposable;
+  }
 }