Skip to main content
Glama
Softeria

Microsoft 365 MCP Server

by Softeria

get-planner-bucket

get-planner-bucket
Read-only

Retrieve Microsoft Planner bucket details and relationships, including the ETag required to update or delete the bucket later.

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", and an unsupported value may be ignored rather than reported. Request ordinary fields with $select instead.
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. 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"
  2. 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."
  3. Changed1 schema field changedv0.131.2
    • changedInput schema / additionalProperties
      Previous value: -falseNew value: +true
  4. Addedv0.114.0
  5. Removedv0.112.2
  6. Addedv0.110.0
  7. Removedv0.108.0
  8. Addedv0.96.0

TDQS

A3.9/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 description does not need to restate safety. It adds valuable behavioral context by calling out the @odata.etag in the response and its role in If-Match for update and delete operations, which goes 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?

The description is compact: one clear purpose sentence followed by a focused tip. Every sentence earns its place, and the most important operational note is immediately available to the agent.

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?

For a simple read-only getter with a fully described required parameter and no output schema, the description covers the essential operational detail: the ETag and includeHeaders flag. It could be slightly more complete by mentioning that list-plan-buckets should be used to enumerate buckets, but nothing critical 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 description coverage is 100%, so this dimension starts at baseline 3. The description adds practical semantic value by explaining why includeHeaders=true matters and tying the ETag to downstream mutation operations, which is not fully captured by the parameter descriptions alone.

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?

The description clearly states the action: 'Retrieve the properties and relationships of a plannerBucket object.' The resource is specific enough to distinguish it from sibling tools that operate on plans or tasks, though it does not explicitly contrast itself with list-plan-buckets.

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 description provides helpful context about using includeHeaders=true to obtain the @odata.etag for subsequent update/delete operations. However, it does not explicitly state when to use this single-bucket getter versus list-plan-buckets for enumeration, so the guidance is useful but incomplete.

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