MCPToolboxTool interface

Paket:

@azure/ai-projects

Ein MCP-Werkzeug, das in einem Werkzeugkasten aufbewahrt wird.

Extends

ToolboxTool

Eigenschaften

allowed_callers
allowed_tools
authorization	Ein OAuth-Zugriffstoken, das mit einem entfernten MCP-Server verwendet werden kann, entweder mit einer benutzerdefinierten MCP-Server-URL oder einem Service-Connector. Ihre Anwendung muss den OAuth-Autorisierungsfluss abdecken und hier das Token bereitstellen.
connector_id	Bezeichner für Dienstconnectors, z. B. die in ChatGPT verfügbaren. Einer von server_url, connector_id, oder tunnel_id muss angegeben werden. Erfahren Sie hier mehr über Service Connectors. Derzeit unterstützte connector_id Werte sind: Dropbox: connector_dropbox Gmail: connector_gmail Google Kalender: connector_googlecalendar Google Drive: connector_googledrive Microsoft Teams:connector_microsoftteams Outlook Kalender: connector_outlookcalendar Outlook E-Mail: connector_outlookemail Sharepoint: connector_sharepoint
defer_loading	Ob dieses MCP-Tool aufgeschoben und durch die Tool-Suche entdeckt wird.
headers
project_connection_id	Die Verbindungs-ID im project für den MCP-Server. In der Verbindung werden die Authentifizierung und andere Verbindungsdetails gespeichert, die für die Verbindung mit dem MCP-Server erforderlich sind.
require_approval
server_description	Optionale Beschreibung des MCP-Servers, die verwendet wird, um mehr Kontext bereitzustellen.
server_label	Eine Bezeichnung für diesen MCP-Server, die verwendet wird, um sie in Toolaufrufen zu identifizieren.
server_url	Die URL für den MCP-Server. Einer von server_url, connector_id, oder tunnel_id muss angegeben werden.
tunnel_id	Die Secure MCP Tunnel-ID soll anstelle einer direkten Server-URL verwendet werden. Einer von server_url, connector_id, oder tunnel_id muss angegeben werden.
type	Die möglichen Diskriminatorwerte: code_interpreter, file_search, web_search, mcp, azure_ai_search, openapi, a2a_preview, browser_automation_preview, reminder_preview, work_iq_preview, fabric_iq_preview, toolbox_search_preview, toolbox_search

Geerbte Eigenschaften

description	Optionale, benutzerdefinierte Beschreibung für dieses Werkzeug oder diese Konfiguration.
name	Optionaler benutzerdefinierter Name für dieses Werkzeug oder diese Konfiguration.
tool_configs	Konfigurationskarte pro Werkzeug. Schlüssel sind Werkzeugnamen oder * (Standard-Sammelbegriff). Auflösungsreihenfolge: Der exakte Werkzeugname-Treffer hat Vorrang vor *. Unbekannte Werkzeugnamen werden zur Laufzeit stillschweigend ignoriert.

Details zur Eigenschaft

allowed_callers

allowed_callers?: CallableToolAllowedCaller[]

Eigenschaftswert

CallableToolAllowedCaller[]

allowed_tools

allowed_tools?: string[] | MCPToolFilter

Eigenschaftswert

string[] | MCPToolFilter

authorization

Ein OAuth-Zugriffstoken, das mit einem entfernten MCP-Server verwendet werden kann, entweder mit einer benutzerdefinierten MCP-Server-URL oder einem Service-Connector. Ihre Anwendung muss den OAuth-Autorisierungsfluss abdecken und hier das Token bereitstellen.

authorization?: string

Eigenschaftswert

string

connector_id

Bezeichner für Dienstconnectors, z. B. die in ChatGPT verfügbaren. Einer von server_url, connector_id, oder tunnel_id muss angegeben werden. Erfahren Sie hier mehr über Service Connectors. Derzeit unterstützte connector_id Werte sind:

• Dropbox: connector_dropbox
• Gmail: connector_gmail
• Google Kalender: connector_googlecalendar
• Google Drive: connector_googledrive
• Microsoft Teams:connector_microsoftteams
• Outlook Kalender: connector_outlookcalendar
• Outlook E-Mail: connector_outlookemail
• Sharepoint: connector_sharepoint

connector_id?: "connector_dropbox" | "connector_gmail" | "connector_googlecalendar" | "connector_googledrive" | "connector_microsoftteams" | "connector_outlookcalendar" | "connector_outlookemail" | "connector_sharepoint"

Eigenschaftswert

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

defer_loading

Ob dieses MCP-Tool aufgeschoben und durch die Tool-Suche entdeckt wird.

defer_loading?: boolean

Eigenschaftswert

boolean

headers

headers?: Record<string, string>

Eigenschaftswert

Record<string, string>

project_connection_id

Die Verbindungs-ID im project für den MCP-Server. In der Verbindung werden die Authentifizierung und andere Verbindungsdetails gespeichert, die für die Verbindung mit dem MCP-Server erforderlich sind.

project_connection_id?: string

Eigenschaftswert

string

require_approval

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

Eigenschaftswert

MCPToolRequireApproval | "always" | "never"

server_description

Optionale Beschreibung des MCP-Servers, die verwendet wird, um mehr Kontext bereitzustellen.

server_description?: string

Eigenschaftswert

string

server_label

Eine Bezeichnung für diesen MCP-Server, die verwendet wird, um sie in Toolaufrufen zu identifizieren.

server_label: string

Eigenschaftswert

string

server_url

Die URL für den MCP-Server. Einer von server_url, connector_id, oder tunnel_id muss angegeben werden.

server_url?: string

Eigenschaftswert

string

tunnel_id

Die Secure MCP Tunnel-ID soll anstelle einer direkten Server-URL verwendet werden. Einer von server_url, connector_id, oder tunnel_id muss angegeben werden.

tunnel_id?: string

Eigenschaftswert

string

type

Die möglichen Diskriminatorwerte: code_interpreter, file_search, web_search, mcp, azure_ai_search, openapi, a2a_preview, browser_automation_preview, reminder_preview, work_iq_preview, fabric_iq_preview, toolbox_search_preview, toolbox_search

type: "mcp"

Eigenschaftswert

"mcp"

Geerbte Eigenschaftsdetails

description

Optionale, benutzerdefinierte Beschreibung für dieses Werkzeug oder diese Konfiguration.

description?: string

Eigenschaftswert

string

Geerbt vonToolboxTool.description

name

Optionaler benutzerdefinierter Name für dieses Werkzeug oder diese Konfiguration.

name?: string

Eigenschaftswert

string

Geerbt vonToolboxTool.name

tool_configs

Konfigurationskarte pro Werkzeug. Schlüssel sind Werkzeugnamen oder * (Standard-Sammelbegriff). Auflösungsreihenfolge: Der exakte Werkzeugname-Treffer hat Vorrang vor *. Unbekannte Werkzeugnamen werden zur Laufzeit stillschweigend ignoriert.

tool_configs?: Record<string, ToolConfig>

Eigenschaftswert

Record<string, ToolConfig>

Geerbt vonToolboxTool.tool_configs