Mcp API

The mcp module of the @codebolt/plugin-sdk.

import plugin from '@codebolt/plugin-sdk';

Quick Reference

Method	Description
configureMCPServer	Configures a specific toolbox with provided configuration.
configureMcpTool	Configures a specific MCP tool with provided configuration.
executeTool	Executes a specific tool with provided parameters.
getAllMcpTools	Gets all tools from all enabled MCP servers.
getEnabledMcps	Gets the list of enabled MCP servers.
getEnabledMCPServers	Gets the list of currently enabled toolboxes.
getLocalMCPServers	Gets the list of locally available toolboxes.
getMcpList	Gets the list of available MCP servers.
getMcpTools	Gets MCP tools from the specified servers.
getMentionedMCPServers	Gets toolboxes mentioned in a user message.
getTools	Gets detailed information about specific tools.
listMcpFromServers	Lists all tools from the specified toolboxes.
searchAvailableMCPServers	Searches for available toolboxes matching a query.

Methods

---

configureMCPServer

plugin.mcp.configureMCPServer(name: string, config: MCPConfiguration): Promise<ConfigureToolBoxResponse>

Configures a specific toolbox with provided configuration.

Parameter	Type	Required	Description
name	string	Yes
config	MCPConfiguration	Yes

Returns: Promise<ConfigureToolBoxResponse>

Full reference →

---

configureMcpTool

plugin.mcp.configureMcpTool(mcpName: string, toolName: string, config: Record<string, unknown>): Promise<ConfigureMCPToolResponse>

Configures a specific MCP tool with provided configuration.

Parameter	Type	Required	Description
mcpName	string	Yes
toolName	string	Yes
config	Record<string, unknown>	Yes

Returns: Promise<ConfigureMCPToolResponse>

Full reference →

---

executeTool

plugin.mcp.executeTool(toolbox: string, toolName: string, params: ToolParameters): Promise<ExecuteToolResponse>

Executes a specific tool with provided parameters.

Parameter	Type	Required	Description
toolbox	string	Yes
toolName	string	Yes
params	ToolParameters	Yes

Returns: Promise<ExecuteToolResponse>

Full reference →

---

getAllMcpTools

plugin.mcp.getAllMcpTools(): Promise<GetAllMCPToolsResponse>

Gets all tools from all enabled MCP servers.

No parameters.

Returns: Promise<GetAllMCPToolsResponse>

Full reference →

---

getEnabledMcps

plugin.mcp.getEnabledMcps(): Promise<GetEnabledMCPSResponse>

Gets the list of enabled MCP servers.

No parameters.

Returns: Promise<GetEnabledMCPSResponse>

Full reference →

---

getEnabledMCPServers

plugin.mcp.getEnabledMCPServers(): Promise<GetEnabledToolBoxesResponse>

Gets the list of currently enabled toolboxes.

No parameters.

Returns: Promise<GetEnabledToolBoxesResponse>

Full reference →

---

getLocalMCPServers

plugin.mcp.getLocalMCPServers(): Promise<GetLocalToolBoxesResponse>

Gets the list of locally available toolboxes.

No parameters.

Returns: Promise<GetLocalToolBoxesResponse>

Full reference →

---

getMcpList

plugin.mcp.getMcpList(): Promise<GetMcpListResponse>

Gets the list of available MCP servers.

No parameters.

Returns: Promise<GetMcpListResponse>

Full reference →

---

getMcpTools

plugin.mcp.getMcpTools(mcpNames?: string[]): Promise<GetMcpToolsResponse>

Gets MCP tools from the specified servers.

Parameter	Type	Required	Description
mcpNames	string[]	No

Returns: Promise<GetMcpToolsResponse>

Full reference →

---

getMentionedMCPServers

plugin.mcp.getMentionedMCPServers(userMessage: MCPUserMessage): Promise<GetAvailableToolBoxesResponse>

Gets toolboxes mentioned in a user message.

Parameter	Type	Required	Description
userMessage	MCPUserMessage	Yes

Returns: Promise<GetAvailableToolBoxesResponse>

Full reference →

---

getTools

plugin.mcp.getTools(toolRequests: object[]): Promise<GetToolsResponse>

Gets detailed information about specific tools.

Parameter	Type	Required	Description
toolRequests	object[]	Yes

Returns: Promise<GetToolsResponse>

Full reference →

---

listMcpFromServers

plugin.mcp.listMcpFromServers(toolBoxes: string[]): Promise<ListToolsFromToolBoxesResponse>

Lists all tools from the specified toolboxes.

Parameter	Type	Required	Description
toolBoxes	string[]	Yes

Returns: Promise<ListToolsFromToolBoxesResponse>

Full reference →

---

searchAvailableMCPServers

plugin.mcp.searchAvailableMCPServers(query: string): Promise<SearchAvailableToolBoxesResponse>

Searches for available toolboxes matching a query.

Parameter	Type	Required	Description
query	string	Yes

Returns: Promise<SearchAvailableToolBoxesResponse>

Full reference →