Skip to main content
Glama
Softeria

Microsoft 365 MCP Server

by Softeria

list-mail-folder-messages-delta

list-mail-folder-messages-delta
Read-only

Get a set of messages added, deleted, or updated in a specified folder. A delta function call for messages in a folder is similar to a GET request, except that by appropriately applying state tokens in one or more of these calls, you can…

Instructions

Get a set of messages added, deleted, or updated in a specified folder. A delta function call for messages in a folder is similar to a GET request, except that by appropriately applying state tokens in one or more of these calls, you can query for incremental changes in the messages in that folder. It allows you to maintain and synchronize a local store of a user's messages without having to fetch the entire set of messages from the server every time.

💡 TIP: Incremental sync of messages within a mail folder. Graph only supports delta scoped to a folder — use mailFolder-id = 'inbox' for the well-known inbox, or another folder id from list-mail-folders. First call returns all messages plus @odata.deltaLink; subsequent calls with that link return only changes (created/updated/deleted). @odata.nextLink paginates within a single delta window. Deltas expire after ~30 days of inactivity — start over if the server returns 410. Prefer this over full re-list for polling.

Input Schema

NameRequiredDescriptionDefault
topNoPage size (Graph $top). Start small (e.g. 5–15) so responses fit the model context; raise only if needed. Use $select to return fewer fields per item. For more rows, use @odata.nextLink from the response instead of a very large $top.
skipNoItems to skip for pagination. Not supported with $search.
countNoSet true to enable advanced query mode (ConsistencyLevel: eventual). Required for complex $filter on flag/flagStatus or contains(). The response then includes @odata.count, the total for the filtered collection, which can exceed the items returned when fetchAllPages hits its page/item cap.
expandNoNavigation properties to inline, e.g. attachments on a message or event. Only navigation properties can be expanded: expanding a non-navigation property such as a message body fails with "Parsing OData Select and Expand failed". Request ordinary fields with $select instead. Some APIs accept only one relationship per request, so prefer a single value. Some relationships support nested selection, e.g. children($select=id,name).
filterNoOData filter expression. Add $count=true for advanced filters (flag/flagStatus, contains()). Cannot combine with $search.
searchNoKQL search query in one pair of double quotes; directory (users/groups) instead quotes each clause with no outer pair. Cannot combine with $filter.
selectNoComma-separated fields to return, e.g. id,subject,from,receivedDateTime
orderbyNoSort expression, e.g. receivedDateTime desc
skiptokenNoNext page: the @odata.nextLink from the previous response. Keep the other arguments the same.
changeTypeNoA custom query option to filter the delta response based on the type of change. Supported values are created, updated or deleted.
mailFolderIdYesValue for the 'mailFolderId' path segment. Pass it under the name 'mailFolderId', not as 'id'. Use the 'id' field of the mail folder object as returned by Microsoft Graph.
fetchAllPagesNoFollow @odata.nextLink and merge up to 100 pages into one response. Can return enormous payloads—only when the user explicitly needs a full export. Prefer a small $top first, then paginate or narrow with $filter/$search.
includeHeadersNoInclude response headers (including ETag) in the response metadata
excludeResponseNoExclude the full response body and only return success or failure indication

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.166.0
    • changedInput schema / properties / count / description
      Previous value: -"Set true to enable advanced query mode (ConsistencyLevel: eventual). Required for complex $filter on flag/flagStatus or contains()."New value: +"Set true to enable advanced query mode (ConsistencyLevel: eventual). Required for complex $filter on flag/flagStatus or contains(). The response then includes @odata.count, the total for the filtered collection, which can exceed the items returned when fetchAllPages hits its page/item cap."
    • changedInput schema / properties / expand / description
      Previous value: -"Navigation properties to inline, e.g. attachments on a message or event. Only navigation properties can be expanded: expanding a non-navigation property such as a message body fails with \"Parsing OData Select and Expand failed\", and an unsupported value may be ignored rather than reported. Request ordinary fields with $select instead."New value: +"Navigation properties to inline, e.g. attachments on a message or event. Only navigation properties can be expanded: expanding a non-navigation property such as a message body fails with \"Parsing OData Select and Expand failed\". Request ordinary fields with $select instead. Some APIs accept only one relationship per request, so prefer a single value. Some relationships support nested selection, e.g. children($select=id,name)."
  2. Changed11 schema fields changedv0.154.2
    • addedInput schema / properties / expand / anyOf
      Added value: +[
      +  {
      +    "type": "string"
      +  },
      +  {
      +    "items": {
      +      "type": "string"
      +    },
      +    "type": "array"
      +  }
      +]
    • removedInput schema / properties / expand / items
      Removed value: -{
      -  "type": "string"
      -}
    • removedInput schema / properties / expand / type
      Removed value: -"array"
    • addedInput schema / properties / orderby / anyOf
      Added value: +[
      +  {
      +    "type": "string"
      +  },
      +  {
      +    "items": {
      +      "type": "string"
      +    },
      +    "type": "array"
      +  }
      +]
    • removedInput schema / properties / orderby / type
      Removed value: -"string"
    • addedInput schema / properties / select / anyOf
      Added value: +[
      +  {
      +    "type": "string"
      +  },
      +  {
      +    "items": {
      +      "type": "string"
      +    },
      +    "type": "array"
      +  }
      +]
    • removedInput schema / properties / select / type
      Removed value: -"string"
    • addedInput schema / properties / skip / minimum
      Added value: +0
    • changedInput schema / properties / skip / type
      Previous value: -"number"New value: +"integer"
    • addedInput schema / properties / top / minimum
      Added value: +0
    • changedInput schema / properties / top / type
      Previous value: -"number"New value: +"integer"
  3. Changed1 schema field changedv0.154.0
    • changedInput schema / properties / skiptoken / description
      Previous value: -"Opaque cursor for the next page, taken from the previous response. Copy the $skiptoken value out of @odata.nextLink (or paste the whole nextLink URL — the token is extracted from it) and resend it with the SAME $filter/$select/$expand/$top as the first call. Use this to walk pages one at a time instead of fetchAllPages. Omit it for the first page."New value: +"Next page: the @odata.nextLink from the previous response. Keep the other arguments the same."
  4. Changed2 schema fields changedv0.153.0
    • changedInput schema / properties / search / description
      Previous value: -"KQL search query — wrap value in double quotes. Cannot combine with $filter."New value: +"KQL search query in one pair of double quotes; directory (users/groups) instead quotes each clause with no outer pair. Cannot combine with $filter."
    • addedInput schema / properties / skiptoken
      Added value: +{
      +  "description": "Opaque cursor for the next page, taken from the previous response. Copy the $skiptoken value out of @odata.nextLink (or paste the whole nextLink URL — the token is extracted from it) and resend it with the SAME $filter/$select/$expand/$top as the first call. Use this to walk pages one at a time instead of fetchAllPages. Omit it for the first page.",
      +  "type": "string"
      +}
  5. Addedv0.134.4
  6. Removedv0.131.2
  7. Addedv0.114.0
  8. Removedv0.112.2
  9. Addedv0.110.0
  10. Removedv0.108.0
  11. Addedv0.96.0

TDQS

A4.5/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations only carry the read-only safety profile; the description adds the behavior that really matters for a delta endpoint — deltaLink semantics, nextLink pagination within a window, ~30 day delta expiry, and restarting on a 410. This is context an agent cannot get from readOnlyHint/destructiveHint.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The TIP block is front-loaded and dense with useful detail, but the opening paragraph is verbose Graph documentation boilerplate ('similar to a GET request, except that by appropriately applying state tokens...') that largely restates what the TIP says more cleanly. Some trimming would improve it.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 14-parameter delta tool with no output schema, the description covers the lifecycle (first call, incremental calls, pagination, expiry, restart), the folder scoping restriction, and the polling use case. Nothing an agent needs to invoke it correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description contributes real added meaning: it explains the mailFolderId value convention ('inbox' well-known name, or an id from list-mail-folders) and how state tokens/paging links drive subsequent calls. It adds more than the schema repeats, though it doesn't clarify the less obvious options like changeType or fetchAllPages.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource (get messages added/deleted/updated in a folder) and frames it precisely as a delta query, which distinguishes it from the plain full-listing siblings like list-mail-folder-messages and list-mail-messages. An agent can tell exactly what it returns without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly says 'Prefer this over full re-list for polling' and explains the first-call-vs-subsequent-call contract, plus the folder-scoping constraint ('Graph only supports delta scoped to a folder'). It stops short of naming the specific alternative tool (list-mail-folder-messages) or stating when a full re-list is actually preferable.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools