MCPTool interface

Paket:
@azure/ai-projects

Gewähren Sie dem Modell Zugriff auf zusätzliche Tools über MCP-Server (Remote Model Context Protocol). Learn Sie mehr über MCP.

Extends
Tool

Eigenschaften

allowed_tools

Die Liste der erlaubten Werkzeugnamen für den MCP-Server.
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

Identifikator für Service Connectors, wie sie in ChatGPT verfügbar sind. 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

Benutzerdefinierte Header, die in Anfragen an den MCP-Server aufgenommen werden.
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

Die Zulassungsvoraussetzungen für das MCP-Tool.
server_description

Optionale Beschreibung des MCP-Servers, die verwendet wird, um mehr Kontext zu liefern.
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.
tool_configs

Deprecated. Diese Eigenschaft ist veraltet und wird in einer zukünftigen Version entfernt.
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

Der Typ des MCP-Tools. Immer mcp.

Details zur Eigenschaft

allowed_tools

Die Liste der erlaubten Werkzeugnamen für den MCP-Server.

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

Identifikator für Service Connectors, wie sie in ChatGPT verfügbar sind. 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

Benutzerdefinierte Header, die in Anfragen an den MCP-Server aufgenommen werden.

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

Die Zulassungsvoraussetzungen für das MCP-Tool.

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

Eigenschaftswert

MCPToolRequireApproval | "always" | "never"

server_description

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

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

tool_configs

Deprecated. Diese Eigenschaft ist veraltet und wird in einer zukünftigen Version entfernt.

tool_configs?: Record<string, ToolConfig>

Eigenschaftswert

Record<string, ToolConfig>

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

Der Typ des MCP-Tools. Immer mcp.

type: "mcp"

Eigenschaftswert

"mcp"