MCPTool interface

套件:
@azure/ai-projects

透過遠端模型情境協定（MCP）伺服器，讓模型能夠存取更多工具。 了解更多關於MCP。

Extends
Tool

屬性

allowed_callers

可能會啟動此工具的來電者。
allowed_tools

MCP 伺服器允許的工具名稱清單。
authorization

一種可與遠端 MCP 伺服器共用的 OAuth 存取權杖，可透過自訂 MCP 伺服器 URL 或服務連接器。 你的應用程式必須處理 OAuth 授權流程，並在此提供令牌。
connector_id

服務連接器的識別碼，例如 ChatGPT 中的連接器。 必須提供其中一項 server_url、 connector_id或 tunnel_id 。 在此了解更多關於服務 連接器的資訊。 目前支援 connector_id 的數值有：

  • Dropbox 功能： connector_dropbox
  • Gmail： connector_gmail
  • Google 行事曆： connector_googlecalendar
  • Google 雲端硬碟： connector_googledrive
  • Microsoft Teams：connector_microsoftteams
  • Outlook 日曆：connector_outlookcalendar
  • Outlook 電子郵件：connector_outlookemail
  • SharePoint：connector_sharepoint
defer_loading

是否會將此 MCP 工具延遲或透過工具搜尋發現。
headers

自訂標頭可在向 MCP 伺服器的請求中加入。
project_connection_id

project 中 MCP 伺服器的連線 ID。 連線會儲存連線至 MCP 伺服器所需的驗證和其他連線詳細資料。
require_approval

MCP 工具的核准要求。
server_description

MCP 伺服器的可選描述，用以提供更多背景說明。
server_label

此 MCP 伺服器的標籤，用來在工具呼叫中識別它。
server_url

MCP 伺服器的 URL。 必須提供其中一項 server_url、 connector_id或 tunnel_id 。
tool_configs

Deprecated. 此屬性已廢止，未來版本將被移除。
tunnel_id

用 Secure MCP 隧道 ID 代替直接伺服器 URL。 必須提供其中一項 server_url、 connector_id或 tunnel_id 。
type

MCP 工具的類型。 一律為 mcp。

屬性詳細資料

allowed_callers

可能會啟動此工具的來電者。

allowed_callers?: CallableToolAllowedCaller[]

屬性值

CallableToolAllowedCaller[]

allowed_tools

MCP 伺服器允許的工具名稱清單。

allowed_tools?: string[] | MCPToolFilter

屬性值

string[] | MCPToolFilter

authorization

一種可與遠端 MCP 伺服器共用的 OAuth 存取權杖，可透過自訂 MCP 伺服器 URL 或服務連接器。 你的應用程式必須處理 OAuth 授權流程，並在此提供令牌。

authorization?: string

屬性值

string

connector_id

服務連接器的識別碼，例如 ChatGPT 中的連接器。 必須提供其中一項 server_url、 connector_id或 tunnel_id 。 在此了解更多關於服務 連接器的資訊。 目前支援 connector_id 的數值有：

  • Dropbox 功能： connector_dropbox
  • Gmail： connector_gmail
  • Google 行事曆： connector_googlecalendar
  • Google 雲端硬碟： connector_googledrive
  • Microsoft Teams：connector_microsoftteams
  • Outlook 日曆：connector_outlookcalendar
  • Outlook 電子郵件：connector_outlookemail
  • SharePoint：connector_sharepoint
connector_id?: "connector_dropbox" | "connector_gmail" | "connector_googlecalendar" | "connector_googledrive" | "connector_microsoftteams" | "connector_outlookcalendar" | "connector_outlookemail" | "connector_sharepoint"

屬性值

"connector_dropbox" | "connector_gmail" | "connector_googlecalendar" | "connector_googledrive" | "connector_microsoftteams" | "connector_outlookcalendar" | "connector_outlookemail" | "connector_sharepoint"

defer_loading

是否會將此 MCP 工具延遲或透過工具搜尋發現。

defer_loading?: boolean

屬性值

boolean

headers

自訂標頭可在向 MCP 伺服器的請求中加入。

headers?: Record<string, string>

屬性值

Record<string, string>

project_connection_id

project 中 MCP 伺服器的連線 ID。 連線會儲存連線至 MCP 伺服器所需的驗證和其他連線詳細資料。

project_connection_id?: string

屬性值

string

require_approval

MCP 工具的核准要求。

require_approval?: MCPToolRequireApproval | "always" | "never"

屬性值

MCPToolRequireApproval | "always" | "never"

server_description

MCP 伺服器的可選描述，用以提供更多背景說明。

server_description?: string

屬性值

string

server_label

此 MCP 伺服器的標籤，用來在工具呼叫中識別它。

server_label: string

屬性值

string

server_url

MCP 伺服器的 URL。 必須提供其中一項 server_url、 connector_id或 tunnel_id 。

server_url?: string

屬性值

string

tool_configs

Deprecated. 此屬性已廢止，未來版本將被移除。

tool_configs?: Record<string, ToolConfig>

屬性值

Record<string, ToolConfig>

tunnel_id

用 Secure MCP 隧道 ID 代替直接伺服器 URL。 必須提供其中一項 server_url、 connector_id或 tunnel_id 。

tunnel_id?: string

屬性值

string

type

MCP 工具的類型。 一律為 mcp。

type: "mcp"

屬性值

"mcp"