Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
Der Work IQ MCP-Server stellt Tools über das Model Context Protocol (MCP) zur Verfügung. Dieser Artikel enthält eine Referenz zu jedem Tool, einschließlich Zweck, Parametern und Verwendungsbeispielen.
Work IQ MCP verwendet die Microsoft Entra-Authentifizierung und die Microsoft 365-Berechtigungen des angemeldeten Benutzers, wenn seine Tools auf Microsoft Graph-Ressourcenpfade zugreifen. Eine separate Mandantenrichtlinienebene wertet jede Toolanforderung aus und blockiert standardmäßig Mutationsvorgänge. Administratoren können unterstützte Erstellungs-, Aktualisierungs-, Lösch- und Aktionsanforderungen über die Mandantenrichtlinie aktivieren. Weitere Informationen finden Sie unter Richtliniengovernance für Work IQ MCP.
Objekttools
Entitätstools stellen CRUD-Vorgänge und -Aktionen für Microsoft 365-Ressourcen bereit. Diese Tools arbeiten mit relativen Ressourcenpfaden, die Microsoft Graph-Endpunkten zugeordnet sind.
fetch
Liest eine oder mehrere Entitäten nach Ressourcenpfad. Unterstützt das Abrufen mehrerer Pfade parallel.
Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
entityUrls |
Zeichenfolgenarray | Ja | Die relativen Ressourcenpfade, die abgerufen werden sollen (z. B. /me/messages"") /me/events/{event-id} |
agentId |
string | Nein | Reserviert für zukünftige Verwendung. |
Antwort
Eine erfolgreiche Antwort enthält eine results Eigenschaft, bei der es sich um ein Array von Objekten mit den folgenden Eigenschaften handelt. Es gibt ein Objekt für jeden Ressourcenpfad im entityUrls Parameter der Anforderung.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
data |
Objekt | Das von Microsoft Graph zurückgegebene JSON-Objekt. |
statusCode |
ganze Zahl | Der HTTP-Statuscode für die Antwort. |
Hinweis
- Für Sammlungsergebnisse gelten Richtlinienlimits pro Mandant. Wenn Sie keinen Wert angeben, fügt das System einen Standardwert
$topvon 25 mit einer maximalen Obergrenze von 100 ein. - Chat-Nachrichten sind auf 10 pro Anforderung begrenzt.
- Das System blockiert die
$skipParameter und$skiptokenAbfragen.
Beispiel
Anforderung
▶ Öffnen Sie dieses Beispiel in der interaktiven Demo
{
"method": "tools/call",
"params": {
"name": "fetch",
"arguments": {
"entityUrls": [
"/me/messages"
]
}
}
}
Antwort
{
"results": [
{
"data": {
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('0c6bc4a2-337b-4672-9bcd-6aa53af1b02a')/messages(id,subject,from,receivedDateTime,isRead,importance)",
"value": [
{
"@odata.etag": "W/\"CQAAABYAAADltuSvpI1YRKDFG38ihSmWAABepTg8\"",
"id": "AAMkADk0...",
"receivedDateTime": "2026-05-31T15:40:44Z",
"subject": "Your weekly PIM digest for Contoso",
"importance": "normal",
"isRead": false,
"from": {
"emailAddress": {
"name": "Microsoft Security",
"address": "MSSecurity-noreply@microsoft.com"
}
}
},
{
"@odata.etag": "W/\"CQAAABYAAADltuSvpI1YRKDFG38ihSmWAAA/eZg0\"",
"id": "AAMkADk0...",
"receivedDateTime": "2026-05-26T07:39:09Z",
"subject": "Microsoft Entra ID Protection Weekly Digest",
"importance": "normal",
"isRead": false,
"from": {
"emailAddress": {
"name": "Microsoft Security",
"address": "MSSecurity-noreply@microsoft.com"
}
}
}
],
"@odata.nextLink": "https://graph.microsoft.com/v1.0/me/messages?%24select=id%2csubject%2cfrom%2creceivedDateTime%2cisRead%2cimportance&%24top=10&%24skip=10"
},
"statusCode": 200
}
]
}
fetch_blob
Ruft binäre Inhalte wie Dokumente, Bilder und Office-Dateien aus einem relativen Arbeits-IQ-Pfad ab. Der Inhalt wird als Base64-codierte Zeichenfolge mit Metadaten zurückgegeben.
Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
path |
string | Ja | Der relative Pfad zum binären Inhalt (z. B. /drives/{drive-id}/items/{item-id}/content) |
format |
string | Nein | Dateiformat (z. B pdf. ). Nur von Laufwerkinhaltsendpunkten unterstützt, die den Microsoft Graph-Parameter $format akzeptieren. |
agentId |
string | Nein | Reserviert für zukünftige Verwendung. |
Antwort
Eine erfolgreiche Antwort macht die folgenden Eigenschaften über das MCP-Feld structuredContent verfügbar.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
statusCode |
ganze Zahl | Der HTTP-Statuscode für die Antwort. |
contentType |
string | Der MIME-Typ des zurückgegebenen Inhalts. |
blobName |
string | Der Dateiname, sofern verfügbar. |
sizeBytes |
ganze Zahl | Die Größe des Rohinhalts in Bytes. |
base64Content |
string | Der binäre Inhalt, der als Base64 codiert ist. |
Hinweis
- Der Standardgrenzwert für unformatierte Dateien beträgt 4 MB und kann pro Pfad konfiguriert werden.
- Clients müssen Base64-decodieren
base64Content, um die ursprünglichen Bytes wiederherzustellen. - Die Blob-Nutzlast wird im MCP-Textinhaltsfeld nicht dupliziert. Clients müssen es aus
structuredContentlesen. - Eine Datei, die das konfigurierte Limit überschreitet, gibt einen MCP-Tool-Fehler zurück, der das konfigurierte Limit enthält. Es werden keine Blobinhalte zurückgegeben.
Beispiel
Anforderung
▶ Öffnen Sie dieses Beispiel in der interaktiven Demo
{
"method": "tools/call",
"params": {
"name": "fetch_blob",
"arguments": {
"path": "/me/drive/items/01ABCDEF/content"
}
}
}
Antwort
{
"structuredContent": {
"statusCode": 200,
"contentType": "text/plain",
"blobName": "notes.txt",
"sizeBytes": 14,
"base64Content": "SGVsbG8sIFdvcmtJUSE="
}
}
create_entity
Erstellt eine neue Entität in einer Sammlung.
Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
parentUrl |
string | Ja | Der relative Ressourcenpfad für die Sammlung (z. B /me/events. , /me/messages). |
jsonBody |
string | Ja | Die zu erstellenden Entitätsdaten, die dem Ressourcenschema entsprechen. Diese Eigenschaft muss eine JSON-codierte Zeichenfolge sein, kein JSON-Objekt. |
agentId |
string | Nein | Reserviert für zukünftige Verwendung. |
Antwort
Eine erfolgreiche Antwort enthält ein Objekt in der structuredContent Eigenschaft mit den folgenden Eigenschaften.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
data |
Objekt | Das von Microsoft Graph zurückgegebene JSON-Objekt. |
statusCode |
ganze Zahl | Der HTTP-Statuscode für die Antwort. |
Beispiel
Anforderung
▶ Öffnen Sie dieses Beispiel in der interaktiven Demo
{
"method": "tools/call",
"params": {
"name": "create_entity",
"arguments": {
"parentUrl": "/me/messages",
"jsonBody": "{ \"subject\": \"Hello world!\" }"
}
}
}
Antwort
{
"statusCode": 201,
"data": {
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('0c6bc4a2-337b-4672-9bcd-6aa53af1b02a')/messages/$entity",
"@odata.etag": "W/\"CQAAABYAAADltuSvpI1YRKDFG38ihSmWAABlFT7g\"",
"id": "AAMkADk0...",
"createdDateTime": "2026-06-01T17:32:39Z",
"lastModifiedDateTime": "2026-06-01T17:32:39Z",
"changeKey": "CQAAABYAAADltuSvpI1YRKDFG38ihSmWAABlFT7g",
"categories": [],
"receivedDateTime": "2026-06-01T17:32:39Z",
"sentDateTime": "2026-06-01T17:32:39Z",
"hasAttachments": false,
"internetMessageId": "<CH7PR03MB79063B75F29F929523CCC68FAE152@CH7PR03MB7906.namprd03.prod.outlook.com>",
"subject": "Hello world!",
"bodyPreview": "",
"importance": "normal",
"parentFolderId": "AQMkADk0...",
"conversationId": "AAQkADk0...",
"conversationIndex": "AQHc8eykdVXKjf4ytUio+dQPqWG95A==",
"isDeliveryReceiptRequested": false,
"isReadReceiptRequested": false,
"isRead": true,
"isDraft": true,
"inferenceClassification": "focused",
"body": {
"contentType": "text",
"content": ""
},
"toRecipients": [],
"ccRecipients": [],
"bccRecipients": [],
"replyTo": [],
"flag": {
"flagStatus": "notFlagged"
}
}
}
update_entity
Updates vorhandenes Objekt.
Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
entityUrl |
string | Ja | Der relative Pfad zur Entität (z. B /me/messages/{message-id}. ). |
jsonBody |
string | Ja | Die zu erstellenden Entitätsdaten, die dem Ressourcenschema entsprechen. Diese Eigenschaft muss eine JSON-codierte Zeichenfolge sein, kein JSON-Objekt. |
agentId |
string | Nein | Reserviert für zukünftige Verwendung. |
Antwort
Eine erfolgreiche Antwort enthält ein Objekt in der structuredContent Eigenschaft mit den folgenden Eigenschaften.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
data |
Objekt | Das von Microsoft Graph zurückgegebene JSON-Objekt. |
statusCode |
ganze Zahl | Der HTTP-Statuscode für die Antwort. |
Beispiel
Anforderung
▶ Öffnen Sie dieses Beispiel in der interaktiven Demo
{
"method": "tools/call",
"params": {
"name": "update_entity",
"arguments": {
"entityUrl": "/me/messages/AAMkADk0...",
"jsonBody": "{ \"subject\": \"Updated: Hello world!\" }"
}
}
}
Antwort
{
"statusCode": 200,
"data": {
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('0c6bc4a2-337b-4672-9bcd-6aa53af1b02a')/messages/$entity",
"@odata.etag": "W/\"CQAAABYAAADltuSvpI1YRKDFG38ihSmWAABlFT7g\"",
"id": "AAMkADk0...",
"createdDateTime": "2026-06-01T17:32:39Z",
"lastModifiedDateTime": "2026-06-01T17:32:39Z",
"changeKey": "CQAAABYAAADltuSvpI1YRKDFG38ihSmWAABlFT7g",
"categories": [],
"receivedDateTime": "2026-06-01T17:32:39Z",
"sentDateTime": "2026-06-01T17:32:39Z",
"hasAttachments": false,
"internetMessageId": "<CH7PR03MB79063B75F29F929523CCC68FAE152@CH7PR03MB7906.namprd03.prod.outlook.com>",
"subject": "Updated: Hello world!",
"bodyPreview": "",
"importance": "normal",
"parentFolderId": "AQMkADk0...",
"conversationId": "AAQkADk0...",
"conversationIndex": "AQHc8eykdVXKjf4ytUio+dQPqWG95A==",
"isDeliveryReceiptRequested": false,
"isReadReceiptRequested": false,
"isRead": true,
"isDraft": true,
"inferenceClassification": "focused",
"body": {
"contentType": "text",
"content": ""
},
"toRecipients": [],
"ccRecipients": [],
"bccRecipients": [],
"replyTo": [],
"flag": {
"flagStatus": "notFlagged"
}
}
}
delete_entity
Löscht ein Objekt.
Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
entityUrl |
string | Ja | Der relative Ressourcenpfad zur zu löschenden Entität (z. B. /me/messages/{id}) |
agentId |
string | Nein | Die ID eines bestimmten Agents, an den die Frage weitergeleitet werden soll. Wenn nicht angegeben, wird standardmäßig der integrierte Microsoft 365 Copilot-Agent verwendet. |
Antwort
Eine erfolgreiche Antwort enthält eine statusCode Eigenschaft, die structuredContent im Feld auf 204 festgelegt ist.
Beispiel
Anforderung
▶ Öffnen Sie dieses Beispiel in der interaktiven Demo
{
"method": "tools/call",
"params": {
"name": "delete_entity",
"arguments": {
"entityUrl": "/me/messages/AAMkADk0MDkyMzM3LTlmNzAtNDhmM...."
}
}
}
Antwort
{
"statusCode": 204
}
do_action
Führt eine Nebeneffektaktion aus, z. B. das Senden von E-Mails, das Kopieren oder Verschieben von Elementen.
Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
actionUrl |
string | Ja | Der relative Pfad für die Aktion (z. B /me/messages/{message-id}/send. ). |
jsonBody |
string | Nein | Der JSON-Text für die Aktion, falls erforderlich. Diese Eigenschaft muss eine JSON-codierte Zeichenfolge sein, kein JSON-Objekt. |
agentId |
string | Nein | Reserviert für zukünftige Verwendung. |
Antwort
Eine erfolgreiche Antwort enthält ein Objekt in der structuredContent Eigenschaft mit den folgenden Eigenschaften.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
data |
Objekt | Das von Microsoft Graph zurückgegebene JSON-Objekt, falls vorhanden. |
statusCode |
ganze Zahl | Der HTTP-Statuscode für die Antwort. |
Beispiel
Anforderung
▶ Öffnen Sie dieses Beispiel in der interaktiven Demo
{
"method": "tools/call",
"params": {
"name": "do_action",
"arguments": {
"actionUrl": "/me/messages/AAMkADk0.../send"
}
}
}
Antwort
{
"statusCode": 202
}
call_function
Ruft eine Microsoft Graph-Funktion auf, um abgeleitete Daten wie Zeitpläne, Deltas oder Suchergebnisse zu berechnen.
Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
functionUrl |
string | Ja | Der relative Pfad für die Funktion (z. B /me/calendarview. ). |
agentId |
string | Nein | Reserviert für zukünftige Verwendung. |
Antwort
Eine erfolgreiche Antwort enthält ein Objekt in der structuredContent Eigenschaft mit den folgenden Eigenschaften.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
data |
Objekt | Das von Microsoft Graph zurückgegebene JSON-Objekt. |
statusCode |
ganze Zahl | Der HTTP-Statuscode für die Antwort. |
Beispiel
Anforderung
▶ Öffnen Sie dieses Beispiel in der interaktiven Demo
{
"method": "tools/call",
"params": {
"name": "call_function",
"arguments": {
"parentUrl": "/me/calendarView?startdatetime=2026-06-01T17:51:49.607Z&enddatetime=2026-06-08T17:51:49.607Z"
}
}
}
Antwort
{
"data": {
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('0c6bc4a2-337b-4672-9bcd-6aa53af1b02a')/calendarView(id,subject,start,end,location,organizer,isAllDay)",
"value": [
{
"@odata.etag": "W/\"5bbkr6SNWESgxRt/IoUplgAAKcCTsQ==\"",
"id": "AAMkADk0...",
"subject": "Sales and Marketing Sync",
"isAllDay": false,
"start": {
"dateTime": "2026-06-08T12:30:00.0000000",
"timeZone": "UTC"
},
"end": {
"dateTime": "2026-06-08T13:00:00.0000000",
"timeZone": "UTC"
},
"location": {
"displayName": "Sales and Marketing / General",
"locationType": "default",
"uniqueId": "Sales and Marketing / General",
"uniqueIdType": "private"
},
"organizer": {
"emailAddress": {
"name": "Sales and Marketing",
"address": "SalesandMarketing@contoso.com"
}
}
}
],
"@odata.nextLink": "https://graph.microsoft.com/v1.0/me/calendarView?startdatetime=2026-06-01T17%3a51%3a49.607Z&enddatetime=2026-06-08T17%3a51%3a49.607Z&%24select=id%2csubject%2cstart%2cend%2clocation%2corganizer%2cisAllDay&%24top=10&%24skip=10"
},
"statusCode": 200
}
Copilot-Tools
Copilot-Tools bieten Informationen in natürlicher Sprache, indem sie Microsoft 365 Copilot aufrufen und verfügbare Agents ermitteln.
fragen
Stellt Microsoft 365 Copilot (oder einem bestimmten Agent) eine Frage in natürlicher Sprache zu Ihren Daten. Wenn Sie eine agentIdangeben, geht die Anforderung an diesen spezifischen Agent. Wenn Sie es weglassen, wird die Anforderung an den integrierten Microsoft 365 Copilot-Agent gesendet.
Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
question |
string | Ja | Die zu stellende Frage in natürlicher Sprache |
agentId |
string | Nein | Die ID eines bestimmten Agents, an den die Frage weitergeleitet werden soll. Wenn nicht angegeben, wird standardmäßig der integrierte Microsoft 365 Copilot-Agent verwendet. |
fileUrls |
Zeichenfolgenarray | Nein | Ein Array von OneDrive- oder SharePoint-Datei-URLs, die als Kontext verwendet werden sollen. |
conversationId |
string | Nein | Eine Unterhaltungs-ID aus einer vorhandenen Konversation. Wenn diese Anforderung bereitgestellt wird, wird die bestehende Unterhaltung fortgesetzt. |
timeZone |
string | Nein | Ein IANA-Zeitzonenbezeichner, der dem aktuellen UTC-Offset des Benutzers entspricht. Wenn er ausgelassen wird, wird die Uhrzeit in UTC zurückgegeben. |
Antwort
Eine erfolgreiche Antwort enthält eine JSON-Zeichenfolge in der text Eigenschaft eines TextContent-Objekts . Die Zeichenfolge enthält die folgenden Eigenschaften.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
response |
string | Die Antwort von Microsoft 365 Copilot oder einem angegebenen Agent. |
conversationId |
string | Die Unterhaltungs-ID. Geben Sie diese ID in den conversationId nachfolgenden Anforderungen an, um die Unterhaltung fortzusetzen. |
Beispiel
Anforderung
▶ Öffnen Sie dieses Beispiel in der interaktiven Demo
{
"method": "tools/call",
"params": {
"name": "ask",
"arguments": {
"question": "Do I have any meetings today?"
}
}
}
Antwort
{
"response": "You have **4 meetings scheduled today**. Here\\u2019s a clear view of your day:...",
"conversationId": "cc7d6f5202cb4c5b814b120440e48ede"
}
abrufen
Durchsucht Microsoft 365-Daten und verbundene Unternehmensquellen, auf die der angemeldete Benutzer zugreifen kann. Das Tool gibt modellfreundliche Grounding-Markdowns mit Inline-Zitaten und strukturierten Metadaten für jede zitierte Quelle zurück. Die grounding Strategie ist die Standardeinstellung.
Wichtig
Das retrieve Tool ist in der öffentlichen Vorschau verfügbar.
Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
query |
string | Ja | Die Abfrage in natürlicher Sprache, die beschreibt, wonach gesucht werden soll. |
agentId |
string | Nein | Die ID eines Agents, der für den Abruf verwendet werden soll. Wenn Sie diesen Parameter weglassen, verwendet der Abruf den integrierten Microsoft 365 Copilot-Agent. Kombinieren Sie keine nicht standardmäßige Agent-ID mit einem nicht leeren capabilities Array. |
strategy |
string | Nein | Die Abrufstrategie. Gültige Werte sind grounding und copilot. Der Standardwert lautet grounding. Verwenden Sie diese Option copilot , wenn sich Daten möglicherweise außerhalb des Microsoft 365-Index befinden oder wenn Sie die GraphConnectors Funktion verwenden. |
capabilities |
Objektarray | Nein | Eine Quell-Zulassungsliste für die Anforderung. Zurzeit unterstützte Funktionsnamen sind People, Meetings, OneDriveAndSharePoint, TeamsMessagesEmail, und GraphConnectors. Lassen Sie es weg oder übergeben Sie ein leeres Array, um alle Quellen zu durchsuchen, die dem Agenten und der Strategie zur Verfügung stehen. |
Dataverse und Power BI sind Roadmapquellen, derzeit nicht unterstützte Abrufquellen. Obwohl das Schema einen Dataverse Funktionsnamen enthält, muss Dataverse weiter ausgewertet werden, bevor es als unterstützt bezeichnet werden kann, und es handelt sich nicht um eine kurzfristige Priorität. Es ist keine Zeitleiste für die Lieferung festgelegt.
Antwort
Die autorisierende Antwortnutzlast liegt in der application/vnd.ms-workiq.retrieval Eigenschaft von structuredContent.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
markdown |
string | Modellfreundliche Fundierung von Inhalten mit Inline-Zitaten, die IDs in retrievalHits. |
retrievalHits |
Objektarray | Strukturierte Quellmetadaten, einschließlich Quell-URLs, Bezeichner und quellenspezifische Metadaten, sofern verfügbar. |
resultCount |
ganze Zahl | Die Anzahl der Abruftreffer. |
stoppedReason |
string | Der Status des Terminals abruf, z. Bcompleted. , cancelled, oder error. |
conversationId |
string | Der Konversationsbezeichner, wenn zurückgegeben. |
Anforderungsbeispiele, funktionsspezifische Bereiche, SharePoint Embedded-Unterstützung, Anleitung zur Antwortverarbeitung und Fehlerbehandlung finden Sie unter Verwenden des retrieve Tools in Work IQ MCP.
list_agents
Listet verfügbare Agents auf, die Sie mit dem ask Tool verwenden können. Gibt ein JSON-Array verfügbarer Agents zurück, und der integrierte Microsoft 365 Copilot-Agent ist immer enthalten.
Parameter
Dieses Tool akzeptiert keine Parameter.
Antwort
Eine erfolgreiche Antwort enthält eine JSON-Zeichenfolge in der text Eigenschaft eines TextContent-Objekts . Die Zeichenfolge enthält die folgenden Eigenschaften.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
agentId |
string | Der eindeutige Bezeichner für den Agent. |
name |
string | Der Anzeigename des Agents. |
provider |
string | Der Herausgeber des Agents. |
Beispiel
Anforderung
▶ Öffnen Sie dieses Beispiel in der interaktiven Demo
{
"method": "tools/call",
"params": {
"name": "list_agent",
"arguments": {}
}
}
Antwort
[
{
"agentId": "bizchat-as-gpt-scenario",
"name": "Microsoft Copilot",
"provider": "Microsoft"
}
]
Schematools
Schematools ermöglichen die Laufzeitermittlung verfügbarer API-Pfade und ihrer OpenAPI-Schemas. Durch die Verwendung dieser Tools können Agenten ermitteln, welche Vorgänge verfügbar sind, ohne große Schemadefinitionen im Voraus in den Kontext laden zu müssen.
get_schema
Ruft das OpenAPI-Schema für einen bestimmten Vorgang ab, identifiziert durch Pfad und Vorgangstyp.
Hinweis
Derzeit sind nur Microsoft Graph v1.0-Schemas verfügbar.
Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
operationIds |
string | Nein | Die Vorgangs-ID der API zum Abrufen des Schemas für (z. B me.CreateMessages. ). Verwenden Sie operationIds ODER path, aber nicht beides. |
path |
string | Nein | Der API-Pfad zum Abrufen des Schemas für (z. B /me/messages. ). Verwenden Sie operationIds ODER path, aber nicht beides. |
operationType |
string | Ja | Der Vorgangstyp. Gültige Werte sind fetch, create und update. |
format |
string | Nein | Das gewünschte Ausgabeformat. Gültige Werte sind jsonschema (JSON-Schemaformat ) und typescript (TypeScript-Definitionen). Wenn er weggelassen wird, wird das JSON-Schema zurückgegeben. |
backend |
string | Nein | Reserviert für zukünftige Verwendung. |
agentId |
string | Nein | Reserviert für zukünftige Verwendung. |
Antwort
Eine erfolgreiche Antwort enthält das JSON-Schema oder die TypeScript-Definitionen in der text Eigenschaft eines TextContent-Objekts .
Beispiel
Anforderung
▶ Öffnen Sie dieses Beispiel in der interaktiven Demo
{
"method": "tools/call",
"params": {
"name": "get_schema",
"arguments": {
"path": "/me/messages",
"operationType": "fetch"
}
}
}
Antwort
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "microsoft.graph.messageCollectionResponse",
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/$defs/microsoft.graph.message"
}
}
},
"$defs": {
...
}
}
search_paths
Durchsucht verfügbare API-Pfade nach Präfix oder RegEx-Filter. Verwenden Sie dieses Tool, um zu ermitteln, welche Ressourcenpfade verfügbar sind, bevor Sie andere Tools aufrufen.
Hinweis
Derzeit sind nur Microsoft Graph v1.0-Pfade verfügbar.
Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
filter |
string | Ja | Ein Präfix oder RegEx-Muster zur Suche nach übereinstimmenden API-Pfaden (z. B messages . oder .*calendar.*) |
backend |
string | Nein | Reserviert für zukünftige Verwendung. |
agentId |
string | Nein | Reserviert für zukünftige Verwendung. |
Antwort
Eine erfolgreiche Antwort enthält eine paths Eigenschaft im structuredContent Feld. Bei dieser Eigenschaft handelt es sich um ein Array von Objekten mit den folgenden Eigenschaften.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
path |
string | Der relative API-Pfad. |
operations |
Zeichenfolgenarray | Die unterstützten Vorgänge für den Pfad. Gültige Werte sind fetch, create und update. |
Beispiel
Anforderung
▶ Öffnen Sie dieses Beispiel in der interaktiven Demo
{
"method": "tools/call",
"params": {
"name": "search_paths",
"arguments": {
"filter": "messages"
}
}
}
Antwort
{
"paths": [
{
"path": "/admin/serviceAnnouncement/messages",
"operations": [
"fetch",
"create"
]
},
{
"path": "/admin/serviceAnnouncement/messages/{serviceUpdateMessage-id}",
"operations": [
"fetch",
"create",
"update"
]
},
...
]
}
Zulässige Ressourcenpfade
Entitätstools arbeiten mit relativen Ressourcenpfaden. Standardmäßig sind die folgenden Pfadpräfixe zulässig:
/me//users//sites/
Die folgenden Pfadsegmente sind blockiert:
/authentication//servicePrincipals/
Hinweis
Die vollständige Liste der zulässigen und blockierten Pfade hängt von der Richtlinienkonfiguration pro Mandant ab und kann variieren.
Fehlerbehandlung
Wenn ein Toolaufruf fehlschlägt, gibt der Work IQ MCP-Server Fehler mit den folgenden Informationen zurück:
- HTTP-Statuscode vom Downstreamdienst
-
Retry-AfterHeader für Drosselungsantworten (von Microsoft Graph weitergeleitet) - Anfordern von Korrelations-IDs zur Problembehandlung
Der Server führt keine automatischen Wiederholungsversuche durch. Der MCP-Client empfängt Fehler und trifft clientseitige Wiederholungsentscheidungen.