The Microsoft Planner connector lets your AI agent act in each user's Microsoft Planner account. Each user signs in to Microsoft Planner once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 22 tools.
- Tools
- 22
- What they doRead · write · destructive
- 11 · 8 · 311 read8 write3 destructive
- Users sign in with
- OAuth
- OAuth app
- Scalekit's or your own
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Microsoft Planner connection
In AgentKit > Connections, create a Microsoft Planner connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Scalekit credentials are available for Microsoft Planner, so you don't need to register an OAuth app.
Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'microsoftplanner'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Microsoft Planner:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'microsoftplanner_my_tasks_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "microsoftplanner"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Microsoft Planner:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="microsoftplanner_my_tasks_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user signs in once. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolmicrosoftplanner_bucket_getGet one Planner bucket by ID.Read-onlyGet Bucket
Get one Planner bucket by ID. Returns the bucket's id, name, planId, orderHint and @odata.etag (needed to update or delete it). Use this when you know the bucket_id. Use microsoftplanner_buckets_list to browse.
Inputs
bucket_idstringrequired- ID of the bucket. Get it from microsoftplanner_buckets_list. Example: hsOf2dhOJkqyYYZEtdzDe2QAIUCR
microsoftplanner_bucket_tasks_listList the tasks in one Planner bucket.Read-onlyList Bucket Tasks
List the tasks in one Planner bucket. Returns each task's id, title, percentComplete, priority, dueDateTime, assignments and @odata.etag. Use this for one column. Use microsoftplanner_tasks_list for the whole plan.
Inputs
bucket_idstringrequired- ID of the bucket. Get it from microsoftplanner_buckets_list. Example: hsOf2dhOJkqyYYZEtdzDe2QAIUCR
microsoftplanner_buckets_listList the buckets (columns) of a Planner plan.Read-onlyList Buckets
List the buckets (columns) of a Planner plan. Returns each bucket's id, name, planId, orderHint and @odata.etag. Use this to find a bucket_id before creating or moving tasks.
Inputs
plan_idstringrequired- ID of the Planner plan. Get it from microsoftplanner_plans_list or microsoftplanner_group_plans_list. Example: xqQg5FS2LkCp935s-FIFm2QAFkHM
microsoftplanner_group_plans_listList the Planner plans owned by a Microsoft 365 group.Read-onlyList Group Plans
List the Planner plans owned by a Microsoft 365 group. Returns each plan's id, title, container, createdBy and @odata.etag. Use this when you know the group. Use microsoftplanner_plans_list for every plan shared with the user.
Inputs
group_idstringrequired- ID of the Microsoft 365 group. A plan's container.containerId holds it. Example: ebf3b108-5234-4e22-b93d-656d7dae5874
microsoftplanner_my_tasks_listList the Planner tasks assigned to the signed-in user, across all plans.Read-onlyList My Tasks
List the Planner tasks assigned to the signed-in user, across all plans. Returns each task's id, title, planId, bucketId, percentComplete, priority, dueDateTime and @odata.etag. Use this for the user's own to-dos. Use microsoftplanner_tasks_list for every task in a plan.
Inputs
This tool takes no inputs.
microsoftplanner_plan_details_getGet the details of a Planner plan.Read-onlyGet Plan Details
Get the details of a Planner plan. Returns categoryDescriptions (the names of labels category1 to category25), sharedWith and @odata.etag. Use this to see what each label means before applying labels to tasks.
Inputs
plan_idstringrequired- ID of the Planner plan. Get it from microsoftplanner_plans_list or microsoftplanner_group_plans_list. Example: xqQg5FS2LkCp935s-FIFm2QAFkHM
microsoftplanner_plan_getGet one Planner plan by ID.Read-onlyGet Plan
Get one Planner plan by ID. Returns the plan's id, title, container, createdBy, createdDateTime and @odata.etag (needed to update or delete it). Use this when you know the plan_id. Use microsoftplanner_plan_details_get for its label names.
Inputs
plan_idstringrequired- ID of the Planner plan. Get it from microsoftplanner_plans_list or microsoftplanner_group_plans_list. Example: xqQg5FS2LkCp935s-FIFm2QAFkHM
microsoftplanner_plans_listList the Planner plans shared with the signed-in user.Read-onlyList My Plans
List the Planner plans shared with the signed-in user. Returns each plan's id, title, container (the group or roster that owns it), createdBy and @odata.etag. Use this to find a plan_id. Use microsoftplanner_group_plans_list for the plans of one Microsoft 365 group.
Inputs
This tool takes no inputs.
microsoftplanner_task_details_getGet the details of a Planner task.Read-onlyGet Task Details
Get the details of a Planner task. Returns the task's description, checklist items, references (links), previewType and @odata.etag. Use this to read a task's notes and checklist. Use microsoftplanner_task_get for its title, dates and assignees.
Inputs
task_idstringrequired- ID of the Planner task. Get it from microsoftplanner_tasks_list or microsoftplanner_my_tasks_list. Example: 01gzSlKkIUSUl6DF_EilrmQAKDhh
microsoftplanner_task_getGet one Planner task by ID.Read-onlyGet Task
Get one Planner task by ID. Returns the task's title, planId, bucketId, dates, percentComplete, priority, assignments, appliedCategories and @odata.etag (needed to update or delete it). Use this when you know the task_id. Use microsoftplanner_task_details_get for its description and checklist.
Inputs
task_idstringrequired- ID of the Planner task. Get it from microsoftplanner_tasks_list or microsoftplanner_my_tasks_list. Example: 01gzSlKkIUSUl6DF_EilrmQAKDhh
microsoftplanner_tasks_listList the tasks in a Planner plan.Read-onlyList Plan Tasks
List the tasks in a Planner plan. Returns each task's id, title, bucketId, percentComplete, priority, dueDateTime, assignments, appliedCategories and @odata.etag. Use this to browse a plan. Use microsoftplanner_bucket_tasks_list for one bucket, or microsoftplanner_my_tasks_list for the user's own tasks.
Inputs
plan_idstringrequired- ID of the Planner plan. Get it from microsoftplanner_plans_list or microsoftplanner_group_plans_list. Example: xqQg5FS2LkCp935s-FIFm2QAFkHM
microsoftplanner_bucket_createCreate a bucket (column) in a Planner plan.WriteCreate Bucket
Create a bucket (column) in a Planner plan. Returns the new bucket with its id and @odata.etag. Use this to add a column to a plan. Use microsoftplanner_task_create to add tasks to it.
Inputs
namestringrequired- Name of the bucket. Example: In review
plan_idstringrequired- ID of the Planner plan. Get it from microsoftplanner_plans_list or microsoftplanner_group_plans_list. Example: xqQg5FS2LkCp935s-FIFm2QAFkHM
order_hintstring- Planner order hint that sets the position in the list. Use " !" to put the item first. Example: !
microsoftplanner_bucket_updateRename or reorder a Planner bucket.WriteUpdate Bucket
Rename or reorder a Planner bucket. Returns the updated bucket, including its new @odata.etag. Use this to change a bucket's name or position. Only the fields you pass are changed. Requires the bucket's current etag from microsoftplanner_bucket_get.
- Idempotent
Inputs
bucket_idstringrequired- ID of the bucket. Get it from microsoftplanner_buckets_list. Example: hsOf2dhOJkqyYYZEtdzDe2QAIUCR
etagstringrequired- Current ETag of the bucket, sent as the If-Match header. Planner rejects the change with 412 if the bucket changed since you read it. Copy the @odata.etag value from microsoftplanner_bucket_get. Example: W/"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc="
namestring- New name of the bucket. Example: Done
order_hintstring- Planner order hint that sets the position in the list. Use " !" to put the item first. Example: !
microsoftplanner_plan_createCreate a Planner plan in a Microsoft 365 group.WriteCreate Plan
Create a Planner plan in a Microsoft 365 group. Returns the new plan with its id and @odata.etag. Use this to start a new plan. Use microsoftplanner_bucket_create and microsoftplanner_task_create to fill it. The signed-in user must be a member of the group.
Inputs
group_idstringrequired- ID of the Microsoft 365 group that will own the plan. Example: ebf3b108-5234-4e22-b93d-656d7dae5874
titlestringrequired- Title of the plan. Example: Q1 launch
microsoftplanner_plan_details_updateRename the labels of a Planner plan.WriteUpdate Plan Labels
Rename the labels of a Planner plan. Returns the updated plan details, including the new @odata.etag. Use this to name labels. Use microsoftplanner_task_update with applied_categories to put labels on a task. Requires the plan details' etag from microsoftplanner_plan_details_get.
- Idempotent
Inputs
category_descriptionsobjectrequired- Label names to set. Keys are category1 to category25 and values are the label names; null clears a name. Example: {"category1": "Blocked", "category2": "Marketing"}
etagstringrequired- Current ETag of the plan details, sent as the If-Match header. Planner rejects the change with 412 if the plan details changed since you read it. Copy the @odata.etag value from microsoftplanner_plan_details_get. Example: W/"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc="
plan_idstringrequired- ID of the Planner plan. Get it from microsoftplanner_plans_list or microsoftplanner_group_plans_list. Example: xqQg5FS2LkCp935s-FIFm2QAFkHM
microsoftplanner_plan_updateRename a Planner plan.WriteRename Plan
Rename a Planner plan. Returns the updated plan, including its new @odata.etag. Use this to change a plan's title. Use microsoftplanner_plan_details_update to rename its labels. Requires the plan's current etag from microsoftplanner_plan_get.
- Idempotent
Inputs
etagstringrequired- Current ETag of the plan, sent as the If-Match header. Planner rejects the change with 412 if the plan changed since you read it. Copy the @odata.etag value from microsoftplanner_plan_get. Example: W/"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc="
plan_idstringrequired- ID of the Planner plan. Get it from microsoftplanner_plans_list or microsoftplanner_group_plans_list. Example: xqQg5FS2LkCp935s-FIFm2QAFkHM
titlestringrequired- New title of the plan. Example: Q1 launch (final)
microsoftplanner_task_createCreate a task in a Planner plan, optionally in a bucket and assigned to users.WriteCreate Task
Create a task in a Planner plan, optionally in a bucket and assigned to users. Returns the new task with its id and @odata.etag. Use this to add a task. Use microsoftplanner_task_details_update to add a description or checklist afterwards.
Inputs
plan_idstringrequired- ID of the Planner plan. Get it from microsoftplanner_plans_list or microsoftplanner_group_plans_list. Example: xqQg5FS2LkCp935s-FIFm2QAFkHM
titlestringrequired- Title of the task. Example: Draft launch email
applied_categoriesobject- Labels to turn on or off. Keys are category1 to category25 and values are true or false; the label names are set on the plan details. Example: {"category1": true, "category4": false}
assignee_user_idsarray- Microsoft Entra user IDs to assign the task to. Example: ["fbab97d0-4932-4511-b675-204639209557"]
bucket_idstring- ID of the bucket to put the task in. The bucket must be in the same plan. Example: hsOf2dhOJkqyYYZEtdzDe2QAIUCR
due_date_timestring- When the task is due, as an ISO 8601 UTC timestamp. Example: 2026-12-01T17:00:00Z
percent_completeinteger- Progress of the task. Planner shows 0 as not started, 1 to 99 as in progress and 100 as completed. Example: 50
priorityinteger- Priority from 0 to 10. Planner shows 1 as urgent, 3 as important, 5 as medium and 9 as low. Example: 3
start_date_timestring- When the task starts, as an ISO 8601 UTC timestamp. Example: 2026-11-20T09:00:00Z
microsoftplanner_task_details_updateUpdate the description, checklist or links of a Planner task.WriteUpdate Task Details
Update the description, checklist or links of a Planner task. Returns the updated task details, including the new @odata.etag. Use this for a task's notes and checklist. Use microsoftplanner_task_update for its title, dates and assignees. Requires the task details' etag from microsoftplanner_task_details_get.
- Idempotent
Inputs
etagstringrequired- Current ETag of the task details, sent as the If-Match header. Planner rejects the change with 412 if the task details changed since you read it. Copy the @odata.etag value from microsoftplanner_task_details_get. Example: W/"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc="
task_idstringrequired- ID of the Planner task. Get it from microsoftplanner_tasks_list or microsoftplanner_my_tasks_list. Example: 01gzSlKkIUSUl6DF_EilrmQAKDhh
checklistobject- Checklist items to add, change or remove. Each key is an item ID: a new GUID you make up for a new item, or an existing ID to change it. Each value has a title and isChecked flag and must include "@odata.type": "microsoft.graph.plannerChecklistItem"; set a value to null to remove that item. Example: {"95e27074-6c4a-447a-aa24-9d718a0b86fa": {"@odata.type": "microsoft.graph.plannerChecklistItem", "title": "Get sign-off", "isChecked": false}}
descriptionstring- Description (notes) of the task, in plain text. Example: Use the copy from the brand team.
preview_typestring- What the task card shows: automatic, noPreview, checklist, description or reference. Example: checklistone of
automaticnoPreviewchecklistdescriptionreference referencesobject- Links to add, change or remove. Each key is the link URL, encoded so that %, ., :, @ and # become %25, %2E, %3A, %40 and %23. Each value must include "@odata.type": "microsoft.graph.plannerExternalReference" and can carry an alias and a type such as Word or Other; set a value to null to remove that link. Example: {"https%3A//contoso%2Ecom/brief": {"@odata.type": "microsoft.graph.plannerExternalReference", "alias": "Brief", "type": "Other"}}
microsoftplanner_task_updateUpdate a Planner task: rename it, move it to another bucket, change its dates, progress, priority or labels, or assign and unassign users.WriteUpdate Task
Update a Planner task: rename it, move it to another bucket, change its dates, progress, priority or labels, or assign and unassign users. Returns the updated task, including its new @odata.etag. Use this to change an existing task; set percent_complete to 100 to complete it. Only the fields you pass are changed. Requires the task's current etag from microsoftplanner_task_get.
- Idempotent
Inputs
etagstringrequired- Current ETag of the task, sent as the If-Match header. Planner rejects the change with 412 if the task changed since you read it. Copy the @odata.etag value from microsoftplanner_task_get. Example: W/"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc="
task_idstringrequired- ID of the Planner task. Get it from microsoftplanner_tasks_list or microsoftplanner_my_tasks_list. Example: 01gzSlKkIUSUl6DF_EilrmQAKDhh
applied_categoriesobject- Labels to turn on or off. Keys are category1 to category25 and values are true or false; the label names are set on the plan details. Example: {"category1": true, "category4": false}
assign_user_idsarray- Microsoft Entra user IDs to add as assignees. Example: ["fbab97d0-4932-4511-b675-204639209557"]
bucket_idstring- ID of the bucket to put the task in. The bucket must be in the same plan. Example: hsOf2dhOJkqyYYZEtdzDe2QAIUCR
due_date_timestring- When the task is due, as an ISO 8601 UTC timestamp. Example: 2026-12-01T17:00:00Z
percent_completeinteger- Progress of the task. Planner shows 0 as not started, 1 to 99 as in progress and 100 as completed. Example: 50
priorityinteger- Priority from 0 to 10. Planner shows 1 as urgent, 3 as important, 5 as medium and 9 as low. Example: 3
start_date_timestring- When the task starts, as an ISO 8601 UTC timestamp. Example: 2026-11-20T09:00:00Z
titlestring- Title of the task. Example: Draft launch email
unassign_user_idsarray- Microsoft Entra user IDs to remove from the assignees. Example: ["6463a5ce-2119-4198-9f2a-628761df4a62"]
microsoftplanner_bucket_deletePermanently delete a Planner bucket and the tasks in it.DestructiveDelete Bucket
Permanently delete a Planner bucket and the tasks in it. Returns no content on success. Use this to remove a column. Move tasks out first with microsoftplanner_task_update if you want to keep them. Requires the bucket's current etag from microsoftplanner_bucket_get.
- Idempotent
Inputs
bucket_idstringrequired- ID of the bucket. Get it from microsoftplanner_buckets_list. Example: hsOf2dhOJkqyYYZEtdzDe2QAIUCR
etagstringrequired- Current ETag of the bucket, sent as the If-Match header. Planner rejects the change with 412 if the bucket changed since you read it. Copy the @odata.etag value from microsoftplanner_bucket_get. Example: W/"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc="
microsoftplanner_plan_deletePermanently delete a Planner plan with all its buckets and tasks.DestructiveDelete Plan
Permanently delete a Planner plan with all its buckets and tasks. Returns no content on success. Use this only when the whole plan should go. Use microsoftplanner_task_delete to remove one task. Requires the plan's current etag from microsoftplanner_plan_get.
- Idempotent
Inputs
etagstringrequired- Current ETag of the plan, sent as the If-Match header. Planner rejects the change with 412 if the plan changed since you read it. Copy the @odata.etag value from microsoftplanner_plan_get. Example: W/"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc="
plan_idstringrequired- ID of the Planner plan. Get it from microsoftplanner_plans_list or microsoftplanner_group_plans_list. Example: xqQg5FS2LkCp935s-FIFm2QAFkHM
microsoftplanner_task_deletePermanently delete a Planner task.DestructiveDelete Task
Permanently delete a Planner task. Returns no content on success. Use this to remove a task. Use microsoftplanner_task_update with percent_complete 100 to complete it instead. Requires the task's current etag from microsoftplanner_task_get.
- Idempotent
Inputs
etagstringrequired- Current ETag of the task, sent as the If-Match header. Planner rejects the change with 412 if the task changed since you read it. Copy the @odata.etag value from microsoftplanner_task_get. Example: W/"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc="
task_idstringrequired- ID of the Planner task. Get it from microsoftplanner_tasks_list or microsoftplanner_my_tasks_list. Example: 01gzSlKkIUSUl6DF_EilrmQAKDhh
No tools match.