Namespace: Consultingwerk.SmartFrameworkMcpServer
Class 
SmartFrameworkMcpServerHelper Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.SmartFrameworkMcpServer.SmartFrameworkMcpServerHelper

Inherits: Progress.Lang.Object


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
AddRepositoryDesignerUrl (JsonObject, character) Adds the RepositoryDesignerUrl attribute to a response JSON object
LONGCHAR BuildMessageResponse (longchar, character) Builds a JSON response with a message and an optional RepositoryDesignerUrl
Progress.Json.ObjectModel.JsonObject GetLoadedAssemblies (character) Returns the .NET assemblies loaded in the current session
CHARACTER GetRepositoryDesignerUrl (character) Returns the Web Repository Designer URL for a repository object
LogRequestDetail (character, character) Logs details about the begin of a SmartFramework MCP Server request
LogRequestEnd () Logs details about the end of current SmartFramework MCP Server request
RemoveSessionInfoImages (JsonObject) Removes the Image values from all entries of a Session Info JsonObject
RemoveSessionInfoSection (JsonObject, character) Removes the section with the given label from a Session Info JsonObject
SetTelemetryServiceRequest (character, character) Reports the service that does the actual work of the current MCP server request to the telemetry service
SetTelemetryServiceRequest (Object, character) Reports the service that does the actual work of the current MCP server request to the telemetry service
UpdateSessionContextAfterLogin () Completes the session context after a successful MCP server authentication


Method Detail
Top

AddRepositoryDesignerUrl (JsonObject, character)
Purpose: Adds the RepositoryDesignerUrl attribute to a response JSON object
Notes: The attribute is only added when the McpServerRepositoryDesignerUrl
configuration property is set and the object name is not empty.

Parameters:
poResponse Progress.Json.ObjectModel.JsonObject
The response JSON object to enrich with the link
pcObjectName CHARACTER
The name of the affected repository object to link to
Top

LONGCHAR BuildMessageResponse (longchar, character)
Purpose: Builds a JSON response with a message and an optional RepositoryDesignerUrl
Notes: Used by MCP procedures that return a textual confirmation message.
The RepositoryDesignerUrl attribute is only added when the
McpServerRepositoryDesignerUrl configuration property is set and
the object name is not empty.

Parameters:
pcMessage LONGCHAR
The confirmation message to return to the caller
pcObjectName CHARACTER
The name of the affected repository object to link to
Returns LONGCHAR
The JSON text of the response object
Top

Progress.Json.ObjectModel.JsonObject GetLoadedAssemblies (character)
Purpose: Returns the .NET assemblies loaded in the current session
Notes: SCL-5975. Returns a JsonObject with an Assemblies array, each
entry has the FullName and the Location of the assembly. The
Location of dynamic assemblies (created in memory) is empty.
In a session without .NET (e.g. PASOE on Linux) the array is
empty. When pcNameFilter contains an asterisk it is applied to
the full name of the assembly using MATCHES, otherwise using
BEGINS, so "Infragistics" returns all Infragistics assemblies
and "*Telerik*" all assemblies containing Telerik in the name

Parameters:
pcNameFilter CHARACTER
The optional filter for the full name of the assemblies, blank or ? for all assemblies
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject with the Assemblies array
Top

CHARACTER GetRepositoryDesignerUrl (character)
Purpose: Returns the Web Repository Designer URL for a repository object
Notes: Built from the IConfigurationProvider McpServerRepositoryDesignerUrl
configuration property (environment variable tokens resolved,
SCL-5736) with the object name appended. Returns an
empty string when the configuration property is not set or the
object name is empty, so callers can decide whether to add it.

Parameters:
pcObjectName CHARACTER
The name of the repository object to link to
Returns CHARACTER
The Web Repository Designer URL or an empty string
Top

LogRequestDetail (character, character)
Purpose: Logs details about the begin of a SmartFramework MCP Server request
Notes: This method stores the request start time and parameters for later use

Parameters:
pcProcedureName CHARACTER
The procedure name being invoked by the MCP server
pcArguments CHARACTER
The serialized arguments passed to the procedure
Top

LogRequestEnd ()
Purpose: Logs details about the end of current SmartFramework MCP Server request
Notes: The begin request details are taken from the last call to LogRequestDetail

Top

RemoveSessionInfoImages (JsonObject)
Purpose: Removes the Image values from all entries of a Session Info
JsonObject
Notes: SCL-5974. The images are only used by the session info views of
the Angular client and the desktop Session Info form. For an MCP
client they are useless and only take up tokens. The JsonObject
is modified in place, sections or entries not following the
ISessionInfoProvider structure are left untouched

Parameters:
poSessionInfo Progress.Json.ObjectModel.JsonObject
The JsonObject returned by ISessionInfoProvider:GetSessionInfo ()
Top

RemoveSessionInfoSection (JsonObject, character)
Purpose: Removes the section with the given label from a Session Info
JsonObject
Notes: SCL-5975. Used to leave the Assemblies section out of the
get_session_info result of the MCP server, as it dominates the
result in large applications. The assemblies are available
through the get_assemblies tool instead. The JsonObject is
modified in place, sections not following the
ISessionInfoProvider structure are left untouched

Parameters:
poSessionInfo Progress.Json.ObjectModel.JsonObject
The JsonObject returned by ISessionInfoProvider:GetSessionInfo ()
pcLabel CHARACTER
The label of the section to remove
Top

SetTelemetryServiceRequest (character, character)
Purpose: Reports the service that does the actual work of the current MCP
server request to the telemetry service
Notes: SCL-5815. Overload for services that are not available as an object
reference when the request starts (e.g. DatasetModel based procedures)

Parameters:
pcServiceName CHARACTER
The type name of the service performing the request
pcMethodName CHARACTER
The name of the method of the service that is invoked
Top

SetTelemetryServiceRequest (Object, character)
Purpose: Reports the service that does the actual work of the current MCP
server request to the telemetry service
Notes: SCL-5815. Called by the MCP procedures before delegating to the
service (Business Entity, Business Task, MCP service, provider) that
performs the request. The telemetry record reports that service as
serviceName / serviceRequest instead of a helper call such as the
authentication. Has no effect when the telemetry service is not
active

Parameters:
poService Progress.Lang.Object
The service instance performing the request
pcMethodName CHARACTER
The name of the method of the service that is invoked
Top

UpdateSessionContextAfterLogin ()
Purpose: Completes the session context after a successful MCP server authentication
Notes: SCL-5814. The IAuthenticationService only assigns the user properties
and the LoginCompanyKey of the SessionManager. The login company
details are resolved here the same way the RestServerSessionActivator
does for web requests, and the authenticated user is forwarded to the
telemetry service. The ServerSessionActivator does not do this for
requests without a context dataset, so the telemetry records of MCP
server requests carried neither the user name nor the domain name.



©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       10.10.2026 15:33:35