メインコンテンツへ移動

Mastra.getMCPServerById()

.getMCPServerById() メソッドは、固有の id プロパティで MCP Server インスタンスを取得します。レジストリキー(設定で使用したキー)で取得するには、代わりに .getMCPServer() を使用します。

使用例
使用例への直接リンク

// Register an MCP server with a registry key
const myServer = new MCPServer({
id: 'my-mcp-server',
name: 'My Server',
version: '1.0.0',
tools: {/* ... */},
})

export const mastra = new Mastra({
mcpServers: {
customKey: myServer, // 'customKey' is the registry key
},
})

// Retrieve by intrinsic ID
const server = mastra.getMCPServerById('my-mcp-server')

// Alternatively, retrieve by registry key
const serverByKey = mastra.getMCPServer('customKey')

パラメータ
パラメータへの直接リンク

serverId:

string
MCP Server 自体の id プロパティ(Server のインスタンス化時に設定)。

version?:

string
任意。指定した場合は、バージョンが一致する Server だけを返します。

戻り値
戻り値への直接リンク

server:

MCPServerBase | undefined
指定した id(指定されている場合は version も)が一致する MCP Server インスタンス。見つからない場合は undefined。

注意事項
注意事項への直接リンク

  • Server の id は構築時にスラッグ化されるため、'myMcpServer''my-mcp-server' になります
  • 複数の Server が同じ id で異なるバージョンを持つ場合、識別するには version パラメータを指定する必要があります
  • version を指定せず、複数のバージョンが存在する場合、このメソッドは最初に一致したものを返します

関連情報
関連情報への直接リンク