Skip to main content
Glama
Softeria

Microsoft 365 MCP Server

by Softeria

get-planner-bucket

get-planner-bucket
Read-only

Retrieve the properties and relationships of a plannerBucket object.

Instructions

Retrieve the properties and relationships of a plannerBucket object.

💡 TIP: Response includes @odata.etag — required as If-Match for update-planner-bucket and delete-planner-bucket. Use includeHeaders=true.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
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).
selectNoComma-separated fields to return, e.g. id,subject,from,receivedDateTime
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
plannerBucketIdYesValue for the 'plannerBucketId' path segment. Pass it under the name 'plannerBucketId', not as 'id'. Use the 'id' field of the planner bucket object as returned by Microsoft Graph.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.166.0
    • 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. Changed5 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 / select / anyOf
      Added value: +[
      +  {
      +    "type": "string"
      +  },
      +  {
      +    "items": {
      +      "type": "string"
      +    },
      +    "type": "array"
      +  }
      +]
    • removedInput schema / properties / select / type
      Removed value: -"string"
  3. Changed2 schema fields changedv0.134.4
    • 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."
    • changedInput schema / properties / plannerBucketId / description
      Previous value: -"Path parameter: plannerBucketId"New value: +"Value for the 'plannerBucketId' path segment. Pass it under the name 'plannerBucketId', not as 'id'. Use the 'id' field of the planner bucket object as returned by Microsoft Graph."
  4. Changed1 schema field changedv0.131.2
    • changedInput schema / additionalProperties
      Previous value: -falseNew value: +true
  5. Addedv0.114.0
  6. Removedv0.112.2
  7. Addedv0.110.0
  8. Removedv0.108.0
  9. Addedv0.96.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds genuine value by disclosing that @odata.etag is returned and is required as If-Match for the update/delete siblings, which is beyond what annotations convey.

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

Conciseness5/5

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

Two compact sentences front-loaded with the core purpose; the TIP is directly actionable and includes the specific parameter name. Every sentence earns its place.

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

Completeness4/5

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

Given a single-resource read with rich 100%-covered schema and readOnly annotations, the description plus TIP cover the main behavioral need (ETag for subsequent writes). A note on response shape or pagination is not strictly necessary since no output schema exists but fetchAllPages is already documented in the schema.

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 coverage is 100%, so all six parameters including plannerBucketId, expand, select, fetchAllPages, includeHeaders, and excludeResponse are already documented. The description only touches one parameter (includeHeaders) for the ETag path, so it adds marginal meaning over the schema and the 100% coverage baseline of 3 applies.

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

Purpose4/5

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

States a specific verb and resource ('Retrieve the properties and relationships of a plannerBucket object'), which clearly identifies it as a single-resource read. It doesn't explicitly differentiate from get-planner-plan or get-planner-task by noting it targets a bucket by ID, but the resource noun is unambiguous.

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

Usage Guidelines3/5

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

The TIP implicitly routes the agent to this tool when it needs an ETag before updating or deleting a bucket, but there is no explicit 'use this when / use X instead' guidance and no mention of siblings like list-plan-buckets for enumeration.

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