Codeunit 8350 MCP Config, source in 28

Source272829metadata in 28

src/System Application/App/MCP/src/Configuration/Codeunits/MCPConfig.Codeunit.al302 lines, Copyright (c) Microsoft Corporation. MIT

// ------------------------------------------------------------------------------------------------
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.
// ------------------------------------------------------------------------------------------------

namespace System.MCP;

/// <summary>
/// Provides public API for managing MCP configurations and tools, including creation, activation, deletion, and permissions.
/// </summary>
codeunit 8350 "MCP Config"
{
    Access = Public;
    InherentEntitlements = X;
    InherentPermissions = X;

    var
        MCPConfigImplementation: Codeunit "MCP Config Implementation";

    /// <summary>
    /// Retrieves the SystemId (GUID) of a configuration by its name.
    /// </summary>
    /// <param name="Name">The name of the configuration.</param>
    /// <returns>The SystemId (GUID) of the configuration if found; otherwise, an empty GUID.</returns>
    procedure GetConfigurationIdByName(Name: Text[100]): Guid
    begin
        exit(MCPConfigImplementation.GetConfigurationIdByName(Name));
    end;

    /// <summary>
    /// Creates a new MCP configuration with the specified name and description.
    /// </summary>
    /// <param name="Name">The name of the configuration.</param>
    /// <param name="Description">The description of the configuration.</param>
    /// <returns>The SystemId (GUID) of the created configuration.</returns>
    procedure CreateConfiguration(Name: Text[100]; Description: Text[250]): Guid
    begin
        exit(MCPConfigImplementation.CreateConfiguration(Name, Description));
    end;

    /// <summary>
    /// Activates the specified MCP configuration.
    /// </summary>
    /// <param name="ConfigId">The SystemId (GUID) of the configuration to activate.</param>
    /// <param name="Active">True to activate, false to deactivate.</param>
    procedure ActivateConfiguration(ConfigId: Guid; Active: Boolean)
    begin
        MCPConfigImplementation.ActivateConfiguration(ConfigId, Active);
    end;

    /// <summary>
    /// Allows create, update and delete tools for the specified MCP configuration. Disallowing this will make the tools read-only.
    /// </summary>
    /// <param name="ConfigId">The SystemId (GUID) of the configuration.</param>
    /// <param name="Allow">True to allow create, update and delete tools, false to disallow.</param>
    procedure AllowCreateUpdateDeleteTools(ConfigId: Guid; Allow: Boolean)
    begin
        MCPConfigImplementation.AllowCreateUpdateDeleteTools(ConfigId, Allow);
    end;

    /// <summary>
    /// Deletes the specified MCP configuration.
    /// </summary>
    /// <param name="ConfigId">The SystemId (GUID) of the configuration to delete.</param>
    procedure DeleteConfiguration(ConfigId: Guid)
    begin
        MCPConfigImplementation.DeleteConfiguration(ConfigId);
    end;

    /// <summary>
    /// Copies an existing configuration to a new configuration, including its tools and permissions.
    /// </summary>
    /// <param name="SourceConfigId">The SystemId (GUID) of the configuration to copy.</param>
    /// <param name="NewName">The name of the new configuration.</param>
    /// <returns>The SystemId (GUID) of the newly created configuration.</returns>
    procedure CopyConfiguration(SourceConfigId: Guid; NewName: Text[100]; NewDescription: Text[250]): Guid
    begin
        exit(MCPConfigImplementation.CopyConfiguration(SourceConfigId, NewName, NewDescription));
    end;

    /// <summary>
    /// Sets the specified MCP configuration as the default configuration.
    /// When no configuration is specified by a connection, the default configuration will be used.
    /// Only active configurations can be set as default.
    /// </summary>
    /// <param name="ConfigId">The SystemId (GUID) of the configuration to set as default.</param>
    procedure SetAsDefaultConfiguration(ConfigId: Guid)
    begin
        MCPConfigImplementation.SetAsDefaultConfiguration(ConfigId);
    end;

    /// <summary>
    /// Clears the current default configuration designation and restores the system default.
    /// </summary>
    procedure ClearDefaultConfiguration()
    begin
        MCPConfigImplementation.ClearDefaultConfiguration();
    end;

    /// <summary>
    /// Enables dynamic tool mode for the specified configuration.
    /// </summary>
    /// <param name="ConfigId">The SystemId (GUID) of the configuration.</param>
    /// <param name="Enable">True to enable, false to disable.</param>
    procedure EnableDynamicToolMode(ConfigId: Guid; Enable: Boolean)
    begin
        MCPConfigImplementation.EnableDynamicToolMode(ConfigId, Enable);
    end;

    /// <summary>
    /// Enables discovery of accessible read-only objects for the specified configuration.
    /// </summary>
    /// <param name="ConfigId">The SystemId (GUID) of the configuration.</param>
    /// <param name="Enable">True to enable, false to disable.</param>
    procedure EnableDiscoverReadOnlyObjects(ConfigId: Guid; Enable: Boolean)
    begin
        MCPConfigImplementation.EnableDiscoverReadOnlyObjects(ConfigId, Enable);
    end;

    /// <summary>
    /// Finds warnings for the specified MCP configuration, such as missing objects or missing parent objects.
    /// </summary>
    /// <param name="ConfigId">The SystemId (GUID) of the configuration to find warnings for.</param>
    /// <param name="MCPConfigWarning">A temporary record variable to hold the found warnings.</param>
    /// <returns>True if any warnings were found; otherwise, false.</returns>
    procedure FindWarningsForConfiguration(ConfigId: Guid; var MCPConfigWarning: Record "MCP Config Warning"): Boolean
    begin
        exit(MCPConfigImplementation.FindWarningsForConfiguration(ConfigId, MCPConfigWarning));
    end;

    /// <summary>
    /// Applies the recommended action for the specified warning.
    /// </summary>
    /// <param name="MCPConfigWarning">The warning record to apply the recommended action for.</param>
    procedure ApplyRecommendedAction(var MCPConfigWarning: Record "MCP Config Warning")
    begin
        MCPConfigImplementation.ApplyRecommendedAction(MCPConfigWarning);
    end;

    /// <summary>
    /// Creates a new API tool for the specified configuration and API page.
    /// </summary>
    /// <param name="ConfigId">The SystemId (GUID) of the configuration.</param>
    /// <param name="APIPageId">The ID of the API page.</param>
    /// <returns>The SystemId (GUID) of the created tool.</returns>
    procedure CreateAPITool(ConfigId: Guid; APIPageId: Integer): Guid
    begin
        exit(MCPConfigImplementation.CreateAPIPageTool(ConfigId, APIPageId, true));
    end;

    /// <summary>
    /// Creates a new API tool for the specified configuration and API page.
    /// </summary>
    /// <param name="ConfigId">The SystemId (GUID) of the configuration.</param>
    /// <param name="APIPageId">The ID of the API page.</param>
    /// <param name="ValidateAPIPublisher">True to validate the API publisher, false to skip validation.</param>
    /// <returns>The SystemId (GUID) of the created tool.</returns>
    procedure CreateAPITool(ConfigId: Guid; APIPageId: Integer; ValidateAPIPublisher: Boolean): Guid
    begin
        exit(MCPConfigImplementation.CreateAPIPageTool(ConfigId, APIPageId, ValidateAPIPublisher));
    end;

    /// <summary>
    /// Creates a new API tool for the specified configuration and query.
    /// </summary>
    /// <param name="ConfigId">The SystemId (GUID) of the configuration.</param>
    /// <param name="QueryId">The ID of the query.</param>
    /// <returns>The SystemId (GUID) of the created tool.</returns>
    procedure CreateQueryAPITool(ConfigId: Guid; QueryId: Integer): Guid
    begin
        exit(MCPConfigImplementation.CreateAPIQueryTool(ConfigId, QueryId));
    end;

    /// <summary>
    /// Retrieves the SystemId (GUID) of a tool by its configuration ID, object ID and object type.
    /// </summary>
    /// <param name="ConfigId">The SystemId (GUID) of the configuration.</param>
    /// <param name="ObjectId">The ID of the API page or query.</param>
    /// <param name="ObjectType">The object type (Page or Query).</param>
    /// <returns>The SystemId (GUID) of the tool if found; otherwise, an empty GUID.</returns>
    procedure GetAPIToolId(ConfigId: Guid; ObjectId: Integer; ObjectType: Option Page,Query): Guid
    begin
        exit(MCPConfigImplementation.GetAPIToolId(ConfigId, ObjectId, ObjectType));
    end;

#if not CLEAN29
    /// <summary>
    /// Retrieves the SystemId (GUID) of a tool by its configuration ID and API page.
    /// </summary>
    /// <param name="ConfigId">The SystemId (GUID) of the configuration.</param>
    /// <param name="APIPageId">The ID of the API page.</param>
    /// <returns>The SystemId (GUID) of the tool if found; otherwise, an empty GUID.</returns>
    [Obsolete('Use GetAPIToolId with ObjectType parameter instead.', '29.0')]
    procedure GetAPIToolId(ConfigId: Guid; APIPageId: Integer): Guid
    var
        MCPConfigurationTool: Record "MCP Configuration Tool";
    begin
        exit(MCPConfigImplementation.GetAPIToolId(ConfigId, APIPageId, MCPConfigurationTool."Object Type"::Page));
    end;
#endif

    /// <summary>
    /// Deletes the specified tool from the configuration.
    /// </summary>
    /// <param name="ToolSystemId">The SystemId (GUID) of the tool to delete.</param>
    procedure DeleteTool(ToolSystemId: Guid)
    begin
        MCPConfigImplementation.DeleteTool(ToolSystemId);
    end;

    /// <summary>
    /// Sets the read permission for the specified tool.
    /// </summary>
    /// <param name="ToolSystemId">The SystemId (GUID) of the tool.</param>
    /// <param name="Allow">True to allow read, false to disallow.</param>
    procedure AllowRead(ToolSystemId: Guid; Allow: Boolean)
    begin
        MCPConfigImplementation.AllowRead(ToolSystemId, Allow);
    end;

    /// <summary>
    /// Sets the create permission for the specified tool.
    /// </summary>
    /// <param name="ToolSystemId">The SystemId (GUID) of the tool.</param>
    /// <param name="Allow">True to allow create, false to disallow.</param>
    procedure AllowCreate(ToolSystemId: Guid; Allow: Boolean)
    begin
        MCPConfigImplementation.AllowCreate(ToolSystemId, Allow);
    end;

    /// <summary>
    /// Sets the modify permission for the specified tool.
    /// </summary>
    /// <param name="ToolSystemId">The SystemId (GUID) of the tool.</param>
    /// <param name="Allow">True to allow modify, false to disallow.</param>
    procedure AllowModify(ToolSystemId: Guid; Allow: Boolean)
    begin
        MCPConfigImplementation.AllowModify(ToolSystemId, Allow);
    end;

    /// <summary>
    /// Sets the delete permission for the specified tool.
    /// </summary>
    /// <param name="ToolSystemId">The SystemId (GUID) of the tool.</param>
    /// <param name="Allow">True to allow delete, false to disallow.</param>
    procedure AllowDelete(ToolSystemId: Guid; Allow: Boolean)
    begin
        MCPConfigImplementation.AllowDelete(ToolSystemId, Allow);
    end;

    /// <summary>
    /// Sets the bound actions permission for the specified tool.
    /// </summary>
    /// <param name="ToolSystemId">The SystemId (GUID) of the tool.</param>
    /// <param name="Allow">True to allow bound actions, false to disallow.</param>
    procedure AllowBoundActions(ToolSystemId: Guid; Allow: Boolean)
    begin
        MCPConfigImplementation.AllowBoundActions(ToolSystemId, Allow);
    end;

    /// <summary>
    /// Creates a new MCP Entra Application with the specified name, description, and client ID.
    /// </summary>
    /// <param name="Name">The name for the Entra application registration.</param>
    /// <param name="Description">The description for the Entra application registration.</param>
    /// <param name="ClientId">The Entra application (client) ID.</param>
    procedure CreateEntraApplication(Name: Text[100]; Description: Text[250]; ClientId: Guid)
    begin
        MCPConfigImplementation.CreateEntraApplication(Name, Description, ClientId);
    end;

    /// <summary>
    /// Deletes the specified MCP Entra Application.
    /// </summary>
    /// <param name="Name">The name of the Entra application to delete.</param>
    procedure DeleteEntraApplication(Name: Text[100])
    begin
        MCPConfigImplementation.DeleteEntraApplication(Name);
    end;

    /// <summary>
    /// Exports the specified MCP configuration and its tools to a JSON stream.
    /// </summary>
    /// <param name="ConfigId">The SystemId (GUID) of the configuration to export.</param>
    /// <param name="OutStream">The output stream to write the JSON to.</param>
    procedure ExportConfiguration(ConfigId: Guid; var OutStream: OutStream)
    begin
        MCPConfigImplementation.ExportConfiguration(ConfigId, OutStream);
    end;

    /// <summary>
    /// Imports an MCP configuration and its tools from a JSON stream.
    /// </summary>
    /// <param name="InStream">The input stream containing the JSON configuration.</param>
    /// <param name="NewName">The name for the imported configuration.</param>
    /// <param name="NewDescription">The description for the imported configuration.</param>
    /// <returns>The SystemId (GUID) of the imported configuration.</returns>
    procedure ImportConfiguration(var InStream: InStream; NewName: Text[100]; NewDescription: Text[250]): Guid
    begin
        exit(MCPConfigImplementation.ImportConfiguration(InStream, NewName, NewDescription));
    end;
}