Skip to main content

Mastra.listMCPServers()

The .listMCPServers() method is used to retrieve all MCP server instances that have been registered in the Mastra instance. The returned record uses registry keys (the keys from the mcpServers configuration) as keys.

Usage example
Direct link to Usage example

// Register MCP servers
const server1 = new MCPServer({
id: 'server-one',
name: 'Server One',
version: '1.0.0',
tools: { /* ... */ },
});

const server2 = new MCPServer({
id: 'server-two',
name: 'Server Two',
version: '1.0.0',
tools: { /* ... */ },
});

export const mastra = new Mastra({
mcpServers: {
firstServer: server1, // Registry key: 'firstServer'
secondServer: server2, // Registry key: 'secondServer'
},
});

// List all registered servers
const servers = mastra.listMCPServers();
// Returns: { firstServer: MCPServerBase, secondServer: MCPServerBase }

Parameters
Direct link to Parameters

This method does not accept any parameters.

Returns
Direct link to Returns

servers:

Record<string, MCPServerBase> | undefined
A record of all registered MCP server instances, where keys are the registry keys (from mcpServers configuration) and values are MCPServerBase instances, or undefined if no servers are registered.

See Also
Direct link to See Also

On this page