mirror of
https://github.com/microsoft/autogen.git
synced 2026-04-20 03:02:16 -04:00
doc: Update API doc for MCP tool to include installation instructions (#5482)
This commit is contained in:
@@ -12,6 +12,14 @@ async def mcp_server_tools(
|
||||
This factory function connects to an MCP server and returns adapters for all available tools.
|
||||
The adapters can be directly assigned to an AutoGen agent's tools list.
|
||||
|
||||
.. note::
|
||||
|
||||
To use this function, you need to install `mcp` extra for the `autogen-ext` package.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pip install -U "autogen-ext[mcp]"
|
||||
|
||||
Args:
|
||||
server_params (McpServerParams): Connection parameters for the MCP server.
|
||||
Can be either StdioServerParams for command-line tools or
|
||||
|
||||
@@ -25,6 +25,14 @@ class SseMcpToolAdapter(
|
||||
with AutoGen agents. Common use cases include integrating with remote MCP services,
|
||||
cloud-based tools, and web APIs that implement the Model Context Protocol (MCP).
|
||||
|
||||
.. note::
|
||||
|
||||
To use this class, you need to install `mcp` extra for the `autogen-ext` package.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pip install -U "autogen-ext[mcp]"
|
||||
|
||||
Args:
|
||||
server_params (SseServerParameters): Parameters for the MCP server connection,
|
||||
including URL, headers, and timeouts
|
||||
|
||||
@@ -24,6 +24,15 @@ class StdioMcpToolAdapter(
|
||||
with AutoGen agents. Common use cases include wrapping command-line tools and local services
|
||||
that implement the Model Context Protocol (MCP).
|
||||
|
||||
.. note::
|
||||
|
||||
To use this class, you need to install `mcp` extra for the `autogen-ext` package.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pip install -U "autogen-ext[mcp]"
|
||||
|
||||
|
||||
Args:
|
||||
server_params (StdioServerParams): Parameters for the MCP server connection,
|
||||
including command to run and its arguments
|
||||
|
||||
Reference in New Issue
Block a user