Skip to main content
Glama
Softeria

Microsoft 365 MCP Server

by Softeria

list-excel-worksheets

list-excel-worksheets
Read-only

Represents a collection of worksheets associated with the workbook. Read-only.

Instructions

Represents a collection of worksheets associated with the workbook. Read-only.

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
driveIdYesValue for the 'driveId' path segment. Pass it under the name 'driveId', not as 'id'. Use the 'id' field of the drive object as returned by Microsoft Graph.
orderbyNoSort expression, e.g. receivedDateTime desc
skiptokenNoNext page: the @odata.nextLink from the previous response. Keep the other arguments the same.
driveItemIdYesValue for the 'driveItemId' path segment. Pass it under the name 'driveItemId', not as 'id'. Use the 'id' field of the drive item 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. Changed3 schema fields changedv0.134.4
    • changedInput schema / properties / driveId / description
      Previous value: -"Path parameter: driveId"New value: +"Value for the 'driveId' path segment. Pass it under the name 'driveId', not as 'id'. Use the 'id' field of the drive object as returned by Microsoft Graph."
    • changedInput schema / properties / driveItemId / description
      Previous value: -"Path parameter: driveItemId"New value: +"Value for the 'driveItemId' path segment. Pass it under the name 'driveItemId', not as 'id'. Use the 'id' field of the drive item object as returned by Microsoft Graph."
    • changedInput schema / properties / expand / description
      Previous value: -"Expand related entities"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\", and an unsupported value may be ignored rather than reported. Request ordinary fields with $select instead."
  6. Addedv0.131.2
  7. Removedv0.131.2
  8. Addedv0.114.0
  9. Removedv0.112.2
  10. Addedv0.110.0
  11. Removedv0.108.0
  12. Changed16 schema fields changedv0.96.0
    • changedInput schema / properties / count / description
      Previous value: -"Include count of items"New value: +"Set true to enable advanced query mode (ConsistencyLevel: eventual). Required for complex $filter on flag/flagStatus or contains()."
    • changedInput schema / properties / fetchAllPages / description
      Previous value: -"Automatically fetch all pages of results"New value: +"Follow @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."
    • changedInput schema / properties / filter / description
      Previous value: -"Filter items by property values"New value: +"OData filter expression. Add $count=true for advanced filters (flag/flagStatus, contains()). Cannot combine with $search."
    • changedInput schema / properties / orderby / description
      Previous value: -"Order items by property values"New value: +"Sort expression, e.g. receivedDateTime desc"
    • removedInput schema / properties / orderby / items
      Removed value: -{
      -  "type": "string"
      -}
    • changedInput schema / properties / orderby / type
      Previous value: -"array"New value: +"string"
    • changedInput schema / properties / search / description
      Previous value: -"Search items by search phrases"New value: +"KQL search query — wrap value in double quotes. Cannot combine with $filter."
    • changedInput schema / properties / select / description
      Previous value: -"Select properties to be returned"New value: +"Comma-separated fields to return, e.g. id,subject,from,receivedDateTime"
    • removedInput schema / properties / select / items
      Removed value: -{
      -  "type": "string"
      -}
    • changedInput schema / properties / select / type
      Previous value: -"array"New value: +"string"
    • changedInput schema / properties / skip / description
      Previous value: -"Skip the first n items"New value: +"Items to skip for pagination. Not supported with $search."
    • removedInput schema / properties / skip / minimum
      Removed value: -0
    • changedInput schema / properties / skip / type
      Previous value: -"integer"New value: +"number"
    • changedInput schema / properties / top / description
      Previous value: -"Show only the first n items"New value: +"Page 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."
    • removedInput schema / properties / top / minimum
      Removed value: -0
    • changedInput schema / properties / top / type
      Previous value: -"integer"New value: +"number"
  13. First observedv0.31.0

TDQS

C2.5/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the description's 'Read-only' adds nothing beyond structured data. It says nothing about the workbook/worksheet relationship, response shape, or pagination behavior that the schema parameters ($top, $skiptoken, fetchAllPages) hint at but don't frame for this specific resource.

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?

Two short sentences with no filler, but neither sentence earns much: the first merely restates the tool name and the second repeats the readOnly annotation. Brevity here reflects under-specification rather than disciplined concision.

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

Completeness2/5

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

With no output schema, the description should at least indicate what a returned worksheet contains (id, name, position) for an agent to consume the result; it does not. For a 14-parameter list tool, the description omits return semantics, the workbook scope, and pagination expectations.

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

Parameters3/5

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

Schema description coverage is 100% across all 14 parameters, so the schema already carries the full parameter burden with detailed OData guidance. The description adds no parameter meaning whatsoever, leaving this at the baseline for a fully documented schema.

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

Purpose3/5

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

The description identifies the resource ('collection of worksheets associated with the workbook') and no verb is needed to convey listing, but it is a noun-phrase restatement of the tool name rather than a specific verb+resource statement. It also fails to distinguish itself from close siblings like list-excel-tables, which an agent must select between.

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

Usage Guidelines2/5

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

There is no guidance on when to use this tool versus alternatives such as list-excel-tables or get-excel-table, nor any mention of prerequisites beyond what the required path params imply. The single context signal ('associated with the workbook') is implicit rather than stated as a usage rule.

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