Class MCPClientManager

MCPClientManager is a singleton that manages connections to external MCP servers.

Features:

Support for all MCP transport types (StreamableHTTP, SSE, Stdio, WebSocket)
Multiple authentication methods (None, Bearer, APIKey, OAuth2, Basic, Custom)
Integration with MJ CredentialEngine for secure credential storage
Rate limiting with request queuing
Comprehensive execution logging
Permission-based access control

Example

const manager = MCPClientManager.Instance;

// Connect to an MCP server
await manager.connect('connection-id', { contextUser });

// Call a tool
const result = await manager.callTool('connection-id', 'tool-name', {
    arguments: { param1: 'value1' }
}, { contextUser });

// Disconnect
await manager.disconnect('connection-id', { contextUser });

Hierarchy (View Summary)

BaseSingleton<MCPClientManager>
- MCPClientManager

Constructors

constructor

new MCPClientManager(): MCPClientManager
Returns MCPClientManager
Overrides BaseSingleton.constructor
- Defined in packages/AI/MCPClient/src/MCPClientManager.ts:135

Accessors

ExecutionLogger

get ExecutionLogger(): ExecutionLogger
Gets the execution logger for accessing log data

Returns ExecutionLogger
- Defined in packages/AI/MCPClient/src/MCPClientManager.ts:1508

GlobalKey

get GlobalKey(): string
Returns string
Inherited from BaseSingleton.GlobalKey
- Defined in packages/MJGlobal/dist/BaseSingleton.d.ts:9

`Static`Instance

get Instance(): MCPClientManager
Gets the singleton instance of MCPClientManager

Returns MCPClientManager
- Defined in packages/AI/MCPClient/src/MCPClientManager.ts:150

Methods

addEventListener

addEventListener(
eventType: MCPClientEventType,
listener: MCPClientEventListener,
): void
Adds an event listener
Parameters
- eventType: MCPClientEventType
  Event type to listen for
- listener: MCPClientEventListener
  Listener function
Returns void
- Defined in packages/AI/MCPClient/src/MCPClientManager.ts:1485

callTool

callTool(
    connectionId: string,
    toolName: string,
    toolOptions: MCPCallToolOptions,
    options: MCPClientOptions,
): Promise<MCPToolCallResult>
Calls a tool on an MCP server
Parameters
- connectionId: string
  The connection ID to use
- toolName: string
  Name of the tool to call
- toolOptions: MCPCallToolOptions
  Tool call options including arguments
- options: MCPClientOptions
  Client options
Returns Promise<MCPToolCallResult>
Tool call result
- Defined in packages/AI/MCPClient/src/MCPClientManager.ts:452

connect

connect(
connectionId: string,
options: MCPConnectOptions,
): Promise<MCPActiveConnection>
Connects to an MCP server using a configured connection
Parameters
- connectionId: string
  The connection ID to use
- options: MCPConnectOptions
  Connection options
Returns Promise<MCPActiveConnection>
Connection info on success
- Defined in packages/AI/MCPClient/src/MCPClientManager.ts:224

disconnect

disconnect(connectionId: string, options: MCPDisconnectOptions): Promise<void>
Disconnects from an MCP server
Parameters
- connectionId: string
  The connection ID to disconnect
- options: MCPDisconnectOptions
  Disconnect options
Returns Promise<void>
- Defined in packages/AI/MCPClient/src/MCPClientManager.ts:397

getActiveConnections

getActiveConnections(): string[]
Gets the list of active connection IDs

Returns string[]
Array of active connection IDs
- Defined in packages/AI/MCPClient/src/MCPClientManager.ts:209

getConnectionInfo

getConnectionInfo(
connectionId: string,
): { connectedAt: Date; connectionName: string; serverName: string }
Gets information about an active connection
Parameters
- connectionId: string
  Connection ID
Returns { connectedAt: Date; connectionName: string; serverName: string }
Connection info or null if not connected
- Defined in packages/AI/MCPClient/src/MCPClientManager.ts:1518

GetGlobalObjectStore

GetGlobalObjectStore(): GlobalObjectStore
The Global Object Store is a place to store global objects that need to be shared across the application. Depending on the execution environment, this could be the window object in a browser, or the global object in a node environment, or something else in other contexts. The key here is that in some cases static variables are not truly shared because it is possible that a given class might have copies of its code in multiple paths in a deployed application. This approach ensures that no matter how many code copies might exist, there is only one instance of the object in question by using the Global Object Store.

Returns GlobalObjectStore
Inherited from BaseSingleton.GetGlobalObjectStore
- Defined in packages/MJGlobal/dist/BaseSingleton.d.ts:26

getOAuthConnectionStatus

getOAuthConnectionStatus(
    connectionId: string,
    contextUser: UserInfo,
): Promise<
    {
        hasValidTokens: boolean;
        isOAuthEnabled: boolean;
        reauthorizationReason?: string;
        requiresReauthorization: boolean;
        tokenExpiresAt?: Date;
    },
>
Gets the OAuth connection status for a connection.
Parameters
- connectionId: string
  MCP Server Connection ID
- contextUser: UserInfo
  User context
Returns Promise<
    {
        hasValidTokens: boolean;
        isOAuthEnabled: boolean;
        reauthorizationReason?: string;
        requiresReauthorization: boolean;
        tokenExpiresAt?: Date;
    },
>
OAuth connection status or null if not an OAuth2 connection
- Defined in packages/AI/MCPClient/src/MCPClientManager.ts:1770

initialize

initialize(
contextUser: UserInfo,
options?: { publicUrl?: string },
): Promise<void>
Initializes the manager. Should be called once at application startup.
Parameters
- contextUser: UserInfo
  User context for initialization
- Optionaloptions: { publicUrl?: string }
  Optional initialization options
Returns Promise<void>
- Defined in packages/AI/MCPClient/src/MCPClientManager.ts:160

isConnected

isConnected(connectionId: string): boolean
Checks if a connection is currently active
Parameters
- connectionId: string
  Connection ID to check
Returns boolean
true if connected
- Defined in packages/AI/MCPClient/src/MCPClientManager.ts:200

listTools

listTools(
connectionId: string,
options: MCPClientOptions,
): Promise<MCPListToolsResult>
Lists available tools from an MCP server
Parameters
- connectionId: string
  The connection ID to use
- options: MCPClientOptions
  Client options
Returns Promise<MCPListToolsResult>
List of available tools
- Defined in packages/AI/MCPClient/src/MCPClientManager.ts:613

notifyOAuthAuthorizationCompleted

notifyOAuthAuthorizationCompleted(
connectionId: string,
data?: Record<string, unknown>,
): void
Notifies listeners that OAuth authorization has completed successfully. Called by OAuth callback handler after code exchange succeeds.
Parameters
- connectionId: string
  The connection ID that was authorized
- Optionaldata: Record<string, unknown>
  Optional additional data (token info, etc.)
Returns void
- Defined in packages/AI/MCPClient/src/MCPClientManager.ts:1541

notifyOAuthTokenRefreshed

notifyOAuthTokenRefreshed(
connectionId: string,
data?: Record<string, unknown>,
): void
Notifies listeners that an OAuth token was successfully refreshed. Called by TokenManager after successful token refresh.
Parameters
- connectionId: string
  The connection ID whose token was refreshed
- Optionaldata: Record<string, unknown>
  Optional additional data (new expiration, etc.)
Returns void
- Defined in packages/AI/MCPClient/src/MCPClientManager.ts:1557

notifyOAuthTokenRefreshFailed

notifyOAuthTokenRefreshFailed(
    connectionId: string,
    data: {
        authorizationUrl?: string;
        error: string;
        requiresReauthorization: boolean;
        stateParameter?: string;
    },
): void
Notifies listeners that OAuth token refresh failed. Called by TokenManager when refresh fails.
Parameters
- connectionId: string
  The connection ID whose token refresh failed
- data: {
      authorizationUrl?: string;
      error: string;
      requiresReauthorization: boolean;
      stateParameter?: string;
  }
  Error details and whether re-authorization is required
Returns void
- Defined in packages/AI/MCPClient/src/MCPClientManager.ts:1573

removeEventListener

removeEventListener(
eventType: MCPClientEventType,
listener: MCPClientEventListener,
): void
Removes an event listener
Parameters
- eventType: MCPClientEventType
  Event type
- listener: MCPClientEventListener
  Listener function to remove
Returns void
- Defined in packages/AI/MCPClient/src/MCPClientManager.ts:1498

setPublicUrl

setPublicUrl(publicUrl: string): void
Sets the public URL for OAuth callbacks.
Parameters
- publicUrl: string
  The public URL (e.g., https://api.example.com)
Returns void
- Defined in packages/AI/MCPClient/src/MCPClientManager.ts:190

syncActionsForServer

syncActionsForServer(
    serverId: string,
    contextUser: UserInfo,
    provider?: IMetadataProvider,
): Promise<MCPSyncActionsResult>
Syncs MCP Server Tools to MJ Actions. Creates the category hierarchy System/MCP/{ServerName} and an Action for each tool.
Parameters
- serverId: string
  The MCP Server ID to sync actions for
- contextUser: UserInfo
  The user context for database operations
- Optionalprovider: IMetadataProvider
Returns Promise<MCPSyncActionsResult>
Sync result with counts of created/updated actions and params
- Defined in packages/AI/MCPClient/src/MCPClientManager.ts:815

syncTools

syncTools(
connectionId: string,
options: MCPClientOptions,
): Promise<MCPSyncToolsResult>
Syncs tool definitions from the MCP server to the database
Parameters
- connectionId: string
  The connection ID to use
- options: MCPClientOptions
  Client options
Returns Promise<MCPSyncToolsResult>
Sync result
- Defined in packages/AI/MCPClient/src/MCPClientManager.ts:672

testConnection

testConnection(
connectionId: string,
options: MCPClientOptions,
): Promise<MCPTestConnectionResult>
Tests a connection to an MCP server
Parameters
- connectionId: string
  The connection ID to test
- options: MCPClientOptions
  Client options
Returns Promise<MCPTestConnectionResult>
Test result
- Defined in packages/AI/MCPClient/src/MCPClientManager.ts:1430

`Protected` `Static`getInstance

getInstance<T extends BaseSingleton<unknown>>(
this: new () => T,
className?: string,
): T
Returns the singleton instance of the class. If the instance does not exist, it is created and stored in the Global Object Store. If className is provided it will be used as part of the key in the Global Object Store, otherwise the actual class name will be used. NOTE: the class name used by default is the lowest level of the object hierarchy, so if you have a class that extends another class, the lowest level class name will be used.
Type Parameters
- T extends BaseSingleton<unknown>
Parameters
- this: new () => T
- OptionalclassName: string
Returns T
Inherited from BaseSingleton.getInstance
- Defined in packages/MJGlobal/dist/BaseSingleton.d.ts:20

Class MCPClientManager

Example

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns MCPClientManager

Accessors

ExecutionLogger

Returns ExecutionLogger

GlobalKey

Returns string

StaticInstance

Returns MCPClientManager

Methods

addEventListener

Parameters

Returns void

callTool

Parameters

Returns Promise<MCPToolCallResult>

connect

Parameters

Returns Promise<MCPActiveConnection>

disconnect

Parameters

Returns Promise<void>

getActiveConnections

Returns string[]

getConnectionInfo

Parameters

Returns { connectedAt: Date; connectionName: string; serverName: string }

GetGlobalObjectStore

Returns GlobalObjectStore

getOAuthConnectionStatus

Parameters

Returns Promise< { hasValidTokens: boolean; isOAuthEnabled: boolean; reauthorizationReason?: string; requiresReauthorization: boolean; tokenExpiresAt?: Date; },>

initialize

Parameters

Returns Promise<void>

isConnected

Parameters

Returns boolean

listTools

Parameters

Returns Promise<MCPListToolsResult>

notifyOAuthAuthorizationCompleted

Parameters

Returns void

notifyOAuthTokenRefreshed

Parameters

Returns void

notifyOAuthTokenRefreshFailed

Parameters

Returns void

removeEventListener

Parameters

Returns void

setPublicUrl

Parameters

Returns void

syncActionsForServer

Parameters

Returns Promise<MCPSyncActionsResult>

syncTools

Parameters

Returns Promise<MCPSyncToolsResult>

testConnection

Parameters

Returns Promise<MCPTestConnectionResult>

Protected StaticgetInstance

Type Parameters

Parameters

Returns T

Settings

On This Page

`Static`Instance

Returns Promise<
{
hasValidTokens: boolean;
isOAuthEnabled: boolean;
reauthorizationReason?: string;
requiresReauthorization: boolean;
tokenExpiresAt?: Date;
},
>

`Protected` `Static`getInstance