@coraxai/api-client 2.313.0

package/dist/apis/MCPServersApi.d.ts

@@ -0,0 +1,223 @@
+/**
+ * Corax API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v2.313.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { ConnectedCapabilityResponse, MCPConfigSchemaResponse, MCPResourceReadRequest, MCPResourceReadResponse, MCPServerBase, MCPServerResponse, MCPToolCallRequest, MCPToolCallResponse, PagedResponseModelMCPServerResponse } from '../models/index';
+export interface CallMcpServerToolV1McpServersServerIdToolsCallPostRequest {
+    serverId: string;
+    mCPToolCallRequest: MCPToolCallRequest;
+}
+export interface CheckMcpServerHealthV1McpServersServerIdHealthGetRequest {
+    serverId: string;
+}
+export interface CreateMcpServerV1McpServersPostRequest {
+    mCPServerBase: MCPServerBase;
+}
+export interface DeleteMcpServerV1McpServersServerIdDeleteRequest {
+    serverId: string;
+}
+export interface GetMcpServerConnectedCapabilitiesV1McpServersServerIdConnectedCapabilitiesGetRequest {
+    serverId: string;
+}
+export interface GetMcpServerEntitiesV1McpServersServerIdEntitiesGetRequest {
+    serverId: string;
+}
+export interface GetMcpServerPromptsV1McpServersServerIdPromptsGetRequest {
+    serverId: string;
+}
+export interface GetMcpServerResourcesV1McpServersServerIdResourcesGetRequest {
+    serverId: string;
+}
+export interface GetMcpServerToolsV1McpServersServerIdToolsGetRequest {
+    serverId: string;
+}
+export interface GetMcpServerV1McpServersServerIdGetRequest {
+    serverId: string;
+}
+export interface ListMcpServersV1McpServersGetRequest {
+    page?: number;
+    size?: number;
+    sort?: string;
+    filter?: string | null;
+}
+export interface ReadMcpServerResourceV1McpServersServerIdResourcesReadPostRequest {
+    serverId: string;
+    mCPResourceReadRequest: MCPResourceReadRequest;
+}
+export interface UpdateMcpServerV1McpServersServerIdPutRequest {
+    serverId: string;
+    mCPServerBase: MCPServerBase;
+}
+/**
+ *
+ */
+export declare class MCPServersApi extends runtime.BaseAPI {
+    /**
+     * Execute a tool directly on an MCP server. This is used by MCP App iframes to proxy tool calls through the backend.
+     * Call a tool directly on an MCP server
+     */
+    callMcpServerToolV1McpServersServerIdToolsCallPostRaw(requestParameters: CallMcpServerToolV1McpServersServerIdToolsCallPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MCPToolCallResponse>>;
+    /**
+     * Execute a tool directly on an MCP server. This is used by MCP App iframes to proxy tool calls through the backend.
+     * Call a tool directly on an MCP server
+     */
+    callMcpServerToolV1McpServersServerIdToolsCallPost(requestParameters: CallMcpServerToolV1McpServersServerIdToolsCallPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MCPToolCallResponse>;
+    /**
+     * Perform a health check on the specified MCP server by attempting to connect and retrieve available entities. Returns detailed status information and entity counts.
+     * Check MCP server health status
+     */
+    checkMcpServerHealthV1McpServersServerIdHealthGetRaw(requestParameters: CheckMcpServerHealthV1McpServersServerIdHealthGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Perform a health check on the specified MCP server by attempting to connect and retrieve available entities. Returns detailed status information and entity counts.
+     * Check MCP server health status
+     */
+    checkMcpServerHealthV1McpServersServerIdHealthGet(requestParameters: CheckMcpServerHealthV1McpServersServerIdHealthGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Create a new MCP (Model Context Protocol) server configuration. The server will be owned by the authenticated user.
+     * Create a new MCP server
+     */
+    createMcpServerV1McpServersPostRaw(requestParameters: CreateMcpServerV1McpServersPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MCPServerResponse>>;
+    /**
+     * Create a new MCP (Model Context Protocol) server configuration. The server will be owned by the authenticated user.
+     * Create a new MCP server
+     */
+    createMcpServerV1McpServersPost(requestParameters: CreateMcpServerV1McpServersPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MCPServerResponse>;
+    /**
+     * Permanently delete an MCP server configuration. Only the server owner can delete the server. The server cannot be deleted if it is currently being used by any capabilities.
+     * Delete an MCP server
+     */
+    deleteMcpServerV1McpServersServerIdDeleteRaw(requestParameters: DeleteMcpServerV1McpServersServerIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Permanently delete an MCP server configuration. Only the server owner can delete the server. The server cannot be deleted if it is currently being used by any capabilities.
+     * Delete an MCP server
+     */
+    deleteMcpServerV1McpServersServerIdDelete(requestParameters: DeleteMcpServerV1McpServersServerIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Return the renderable form schema for the MCP server editor: base server fields and the supported authentication modes with their fields, defaults and validation hints. The frontend builds the auth section from this instead of hardcoding the modes.
+     * Get the MCP server config schema
+     */
+    getMcpConfigSchemaV1McpServersConfigSchemaGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MCPConfigSchemaResponse>>;
+    /**
+     * Return the renderable form schema for the MCP server editor: base server fields and the supported authentication modes with their fields, defaults and validation hints. The frontend builds the auth section from this instead of hardcoding the modes.
+     * Get the MCP server config schema
+     */
+    getMcpConfigSchemaV1McpServersConfigSchemaGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MCPConfigSchemaResponse>;
+    /**
+     * Retrieve all capabilities that reference this MCP server. Only the server owner can view this information. Useful for impact analysis before changing server visibility.
+     * Get capabilities connected to this MCP server
+     */
+    getMcpServerConnectedCapabilitiesV1McpServersServerIdConnectedCapabilitiesGetRaw(requestParameters: GetMcpServerConnectedCapabilitiesV1McpServersServerIdConnectedCapabilitiesGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ConnectedCapabilityResponse>>>;
+    /**
+     * Retrieve all capabilities that reference this MCP server. Only the server owner can view this information. Useful for impact analysis before changing server visibility.
+     * Get capabilities connected to this MCP server
+     */
+    getMcpServerConnectedCapabilitiesV1McpServersServerIdConnectedCapabilitiesGet(requestParameters: GetMcpServerConnectedCapabilitiesV1McpServersServerIdConnectedCapabilitiesGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ConnectedCapabilityResponse>>;
+    /**
+     * Retrieve all available entities (tools, resources, and prompts) from the specified MCP server. This includes function definitions, resource templates, and prompt templates.
+     * Get all entities from an MCP server
+     */
+    getMcpServerEntitiesV1McpServersServerIdEntitiesGetRaw(requestParameters: GetMcpServerEntitiesV1McpServersServerIdEntitiesGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<{
+        [key: string]: any;
+    }>>>;
+    /**
+     * Retrieve all available entities (tools, resources, and prompts) from the specified MCP server. This includes function definitions, resource templates, and prompt templates.
+     * Get all entities from an MCP server
+     */
+    getMcpServerEntitiesV1McpServersServerIdEntitiesGet(requestParameters: GetMcpServerEntitiesV1McpServersServerIdEntitiesGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Retrieve all available prompts and prompt templates from the specified MCP server. Prompts are reusable templates that can be used to generate consistent AI interactions.
+     * Get all prompts from an MCP server
+     */
+    getMcpServerPromptsV1McpServersServerIdPromptsGetRaw(requestParameters: GetMcpServerPromptsV1McpServersServerIdPromptsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<{
+        [key: string]: any;
+    }>>>;
+    /**
+     * Retrieve all available prompts and prompt templates from the specified MCP server. Prompts are reusable templates that can be used to generate consistent AI interactions.
+     * Get all prompts from an MCP server
+     */
+    getMcpServerPromptsV1McpServersServerIdPromptsGet(requestParameters: GetMcpServerPromptsV1McpServersServerIdPromptsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Retrieve all available resources and resource templates from the specified MCP server. Resources provide access to external data sources, files, or APIs that capabilities can read from.
+     * Get all resources from an MCP server
+     */
+    getMcpServerResourcesV1McpServersServerIdResourcesGetRaw(requestParameters: GetMcpServerResourcesV1McpServersServerIdResourcesGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<{
+        [key: string]: any;
+    }>>>;
+    /**
+     * Retrieve all available resources and resource templates from the specified MCP server. Resources provide access to external data sources, files, or APIs that capabilities can read from.
+     * Get all resources from an MCP server
+     */
+    getMcpServerResourcesV1McpServersServerIdResourcesGet(requestParameters: GetMcpServerResourcesV1McpServersServerIdResourcesGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Retrieve all available tools (functions) from the specified MCP server. Tools are executable functions that can be called by capabilities to perform specific tasks.
+     * Get all tools from an MCP server
+     */
+    getMcpServerToolsV1McpServersServerIdToolsGetRaw(requestParameters: GetMcpServerToolsV1McpServersServerIdToolsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<{
+        [key: string]: any;
+    }>>>;
+    /**
+     * Retrieve all available tools (functions) from the specified MCP server. Tools are executable functions that can be called by capabilities to perform specific tasks.
+     * Get all tools from an MCP server
+     */
+    getMcpServerToolsV1McpServersServerIdToolsGet(requestParameters: GetMcpServerToolsV1McpServersServerIdToolsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Retrieve detailed information about a specific MCP server by its unique identifier. Only returns servers owned by the authenticated user.
+     * Get MCP server by ID
+     */
+    getMcpServerV1McpServersServerIdGetRaw(requestParameters: GetMcpServerV1McpServersServerIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MCPServerResponse>>;
+    /**
+     * Retrieve detailed information about a specific MCP server by its unique identifier. Only returns servers owned by the authenticated user.
+     * Get MCP server by ID
+     */
+    getMcpServerV1McpServersServerIdGet(requestParameters: GetMcpServerV1McpServersServerIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MCPServerResponse>;
+    /**
+     * Retrieve a paginated list of all MCP (Model Context Protocol) servers owned by the current user. Supports sorting and filtering through pagination parameters.
+     * List MCP servers
+     */
+    listMcpServersV1McpServersGetRaw(requestParameters: ListMcpServersV1McpServersGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedResponseModelMCPServerResponse>>;
+    /**
+     * Retrieve a paginated list of all MCP (Model Context Protocol) servers owned by the current user. Supports sorting and filtering through pagination parameters.
+     * List MCP servers
+     */
+    listMcpServersV1McpServersGet(requestParameters?: ListMcpServersV1McpServersGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedResponseModelMCPServerResponse>;
+    /**
+     * Read a specific resource from an MCP server by its URI. This is used by MCP App iframes to fetch HTML content for rendering.
+     * Read a resource from an MCP server
+     */
+    readMcpServerResourceV1McpServersServerIdResourcesReadPostRaw(requestParameters: ReadMcpServerResourceV1McpServersServerIdResourcesReadPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MCPResourceReadResponse>>;
+    /**
+     * Read a specific resource from an MCP server by its URI. This is used by MCP App iframes to fetch HTML content for rendering.
+     * Read a resource from an MCP server
+     */
+    readMcpServerResourceV1McpServersServerIdResourcesReadPost(requestParameters: ReadMcpServerResourceV1McpServersServerIdResourcesReadPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MCPResourceReadResponse>;
+    /**
+     * Update the configuration of an existing MCP server. Only the server owner can update the configuration.
+     * Update an existing MCP server
+     */
+    updateMcpServerV1McpServersServerIdPutRaw(requestParameters: UpdateMcpServerV1McpServersServerIdPutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MCPServerResponse>>;
+    /**
+     * Update the configuration of an existing MCP server. Only the server owner can update the configuration.
+     * Update an existing MCP server
+     */
+    updateMcpServerV1McpServersServerIdPut(requestParameters: UpdateMcpServerV1McpServersServerIdPutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MCPServerResponse>;
+}